Class: Acceptance
An update protocol message indicating that a workflow execution update has been accepted (i.e. passed the worker-side validation phase).
Implements
Constructors
constructor
• new Acceptance(properties?
): Acceptance
Constructs a new Acceptance.
Parameters
Name | Type | Description |
---|---|---|
properties? | IAcceptance | Properties to set |
Returns
Properties
acceptedRequest
• Optional
acceptedRequest: null
| IRequest
Acceptance acceptedRequest.
Implementation of
acceptedRequestMessageId
• acceptedRequestMessageId: string
Acceptance acceptedRequestMessageId.
Implementation of
IAcceptance.acceptedRequestMessageId
acceptedRequestSequencingEventId
• acceptedRequestSequencingEventId: Long
Acceptance acceptedRequestSequencingEventId.
Implementation of
IAcceptance.acceptedRequestSequencingEventId
Methods
toJSON
▸ toJSON(): Object
Converts this Acceptance to JSON.
Returns
Object
JSON object
create
▸ create(properties?
): Acceptance
Creates a new Acceptance instance using the specified properties.
Parameters
Name | Type | Description |
---|---|---|
properties? | IAcceptance | Properties to set |
Returns
Acceptance instance
decode
▸ decode(reader
, length?
): Acceptance
Decodes an Acceptance 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
Acceptance
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader
): Acceptance
Decodes an Acceptance message from the specified reader or buffer, length delimited.
Parameters
Name | Type | Description |
---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Acceptance
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 Acceptance message. Does not implicitly temporal.api.update.v1.Acceptance.verify|verify messages.
Parameters
Name | Type | Description |
---|---|---|
message | IAcceptance | Acceptance message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message
, writer?
): Writer
Encodes the specified Acceptance message, length delimited. Does not implicitly temporal.api.update.v1.Acceptance.verify|verify messages.
Parameters
Name | Type | Description |
---|---|---|
message | IAcceptance | Acceptance message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object
): Acceptance
Creates an Acceptance message from a plain object. Also converts values to their respective internal types.
Parameters
Name | Type | Description |
---|---|---|
object | Object | Plain object |
Returns
Acceptance
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?
): string
Gets the default type url for Acceptance
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 an Acceptance message. Also converts values to other types if specified.
Parameters
Name | Type | Description |
---|---|---|
message | Acceptance | Acceptance |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object