Class: Rejection
An Update protocol message indicating that a Workflow Update has been rejected.
Implements
Constructors
constructor
• new Rejection(properties?): Rejection
Constructs a new Rejection.
Parameters
| Name | Type | Description | 
|---|---|---|
| properties? | IRejection | Properties to set | 
Returns
Properties
failure
• Optional failure: null | IFailure
Rejection failure.
Implementation of
rejectedRequest
• Optional rejectedRequest: null | IRequest
Rejection rejectedRequest.
Implementation of
rejectedRequestMessageId
• rejectedRequestMessageId: string
Rejection rejectedRequestMessageId.
Implementation of
IRejection.rejectedRequestMessageId
rejectedRequestSequencingEventId
• rejectedRequestSequencingEventId: Long
Rejection rejectedRequestSequencingEventId.
Implementation of
IRejection.rejectedRequestSequencingEventId
Methods
toJSON
▸ toJSON(): Object
Converts this Rejection to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Rejection
Creates a new Rejection instance using the specified properties.
Parameters
| Name | Type | Description | 
|---|---|---|
| properties? | IRejection | Properties to set | 
Returns
Rejection instance
decode
▸ decode(reader, length?): Rejection
Decodes a Rejection message from the specified reader or buffer.
Parameters
| Name | Type | Description | 
|---|---|---|
| reader | Uint8Array|Reader | Reader or buffer to decode from | 
| length? | number | Message length if known beforehand | 
Returns
Rejection
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Rejection
Decodes a Rejection message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description | 
|---|---|---|
| reader | Uint8Array|Reader | Reader or buffer to decode from | 
Returns
Rejection
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message, writer?): Writer
Encodes the specified Rejection message. Does not implicitly temporal.api.update.v1.Rejection.verify|verify messages.
Parameters
| Name | Type | Description | 
|---|---|---|
| message | IRejection | Rejection message or plain object to encode | 
| writer? | Writer | Writer to encode to | 
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Rejection message, length delimited. Does not implicitly temporal.api.update.v1.Rejection.verify|verify messages.
Parameters
| Name | Type | Description | 
|---|---|---|
| message | IRejection | Rejection message or plain object to encode | 
| writer? | Writer | Writer to encode to | 
Returns
Writer
Writer
fromObject
▸ fromObject(object): Rejection
Creates a Rejection message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description | 
|---|---|---|
| object | Object | Plain object | 
Returns
Rejection
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for Rejection
Parameters
| Name | Type | Description | 
|---|---|---|
| typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") | 
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from a Rejection message. Also converts values to other types if specified.
Parameters
| Name | Type | Description | 
|---|---|---|
| message | Rejection | Rejection | 
| options? | IConversionOptions | Conversion options | 
Returns
Object
Plain object