Class: NexusOperationStartedEventAttributes
history.v1.NexusOperationStartedEventAttributes
Event marking an asynchronous operation was started by the responding Nexus handler. If the operation completes synchronously, this event is not generated. In rare situations, such as request timeouts, the service may fail to record the actual start time and will fabricate this event upon receiving the operation completion via callback.
Implements
Constructors
constructor
• new NexusOperationStartedEventAttributes(properties?): NexusOperationStartedEventAttributes
Constructs a new NexusOperationStartedEventAttributes.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | INexusOperationStartedEventAttributes | Properties to set |
Returns
NexusOperationStartedEventAttributes
Properties
operationId
• operationId: string
The operation ID returned by the Nexus handler in the response to the StartOperation request. This ID is used when canceling the operation.
Implementation of
INexusOperationStartedEventAttributes.operationId
scheduledEventId
• scheduledEventId: Long
The ID of the NEXUS_OPERATION_SCHEDULED event this task corresponds to.
Implementation of
INexusOperationStartedEventAttributes.scheduledEventId
Methods
toJSON
▸ toJSON(): Object
Converts this NexusOperationStartedEventAttributes to JSON.
Returns
Object
JSON object
create
▸ create(properties?): NexusOperationStartedEventAttributes
Creates a new NexusOperationStartedEventAttributes instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | INexusOperationStartedEventAttributes | Properties to set |
Returns
NexusOperationStartedEventAttributes
NexusOperationStartedEventAttributes instance
decode
▸ decode(reader, length?): NexusOperationStartedEventAttributes
Decodes a NexusOperationStartedEventAttributes 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
NexusOperationStartedEventAttributes
NexusOperationStartedEventAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): NexusOperationStartedEventAttributes
Decodes a NexusOperationStartedEventAttributes message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
NexusOperationStartedEventAttributes
NexusOperationStartedEventAttributes
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 NexusOperationStartedEventAttributes message. Does not implicitly temporal.api.history.v1.NexusOperationStartedEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | INexusOperationStartedEventAttributes | NexusOperationStartedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified NexusOperationStartedEventAttributes message, length delimited. Does not implicitly temporal.api.history.v1.NexusOperationStartedEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | INexusOperationStartedEventAttributes | NexusOperationStartedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): NexusOperationStartedEventAttributes
Creates a NexusOperationStartedEventAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
NexusOperationStartedEventAttributes
NexusOperationStartedEventAttributes
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for NexusOperationStartedEventAttributes
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 NexusOperationStartedEventAttributes message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | NexusOperationStartedEventAttributes | NexusOperationStartedEventAttributes |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object