Class: NexusOperationCanceledEventAttributes
history.v1.NexusOperationCanceledEventAttributes
Nexus operation completed as canceled. May or may not have been due to a cancellation request by the workflow.
Implements
Constructors
constructor
• new NexusOperationCanceledEventAttributes(properties?): NexusOperationCanceledEventAttributes
Constructs a new NexusOperationCanceledEventAttributes.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | INexusOperationCanceledEventAttributes | Properties to set |
Returns
NexusOperationCanceledEventAttributes
Properties
failure
• Optional failure: null | IFailure
Cancellation details.
Implementation of
INexusOperationCanceledEventAttributes.failure
requestId
• requestId: string
The request ID allocated at schedule time.
Implementation of
INexusOperationCanceledEventAttributes.requestId
scheduledEventId
• scheduledEventId: Long
The ID of the NEXUS_OPERATION_SCHEDULED event. Uniquely identifies this operation.
Implementation of
INexusOperationCanceledEventAttributes.scheduledEventId
Methods
toJSON
▸ toJSON(): Object
Converts this NexusOperationCanceledEventAttributes to JSON.
Returns
Object
JSON object
create
▸ create(properties?): NexusOperationCanceledEventAttributes
Creates a new NexusOperationCanceledEventAttributes instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | INexusOperationCanceledEventAttributes | Properties to set |
Returns
NexusOperationCanceledEventAttributes
NexusOperationCanceledEventAttributes instance
decode
▸ decode(reader, length?): NexusOperationCanceledEventAttributes
Decodes a NexusOperationCanceledEventAttributes 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
NexusOperationCanceledEventAttributes
NexusOperationCanceledEventAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): NexusOperationCanceledEventAttributes
Decodes a NexusOperationCanceledEventAttributes message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
NexusOperationCanceledEventAttributes
NexusOperationCanceledEventAttributes
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 NexusOperationCanceledEventAttributes message. Does not implicitly temporal.api.history.v1.NexusOperationCanceledEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | INexusOperationCanceledEventAttributes | NexusOperationCanceledEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified NexusOperationCanceledEventAttributes message, length delimited. Does not implicitly temporal.api.history.v1.NexusOperationCanceledEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | INexusOperationCanceledEventAttributes | NexusOperationCanceledEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): NexusOperationCanceledEventAttributes
Creates a NexusOperationCanceledEventAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
NexusOperationCanceledEventAttributes
NexusOperationCanceledEventAttributes
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for NexusOperationCanceledEventAttributes
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 NexusOperationCanceledEventAttributes message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | NexusOperationCanceledEventAttributes | NexusOperationCanceledEventAttributes |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object