Class: NexusOperationScheduledEventAttributes
history.v1.NexusOperationScheduledEventAttributes
Event marking that an operation was scheduled by a workflow via the ScheduleNexusOperation command.
Implements
Constructors
constructor
• new NexusOperationScheduledEventAttributes(properties?): NexusOperationScheduledEventAttributes
Constructs a new NexusOperationScheduledEventAttributes.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | INexusOperationScheduledEventAttributes | Properties to set |
Returns
NexusOperationScheduledEventAttributes
Properties
endpoint
• endpoint: string
Endpoint name, must exist in the endpoint registry.
Implementation of
INexusOperationScheduledEventAttributes.endpoint
input
• Optional input: null | IPayload
Input for the operation. The server converts this into Nexus request content and the appropriate content headers internally when sending the StartOperation request. On the handler side, if it is also backed by Temporal, the content is transformed back to the original Payload stored in this event.
Implementation of
INexusOperationScheduledEventAttributes.input
nexusHeader
• nexusHeader: Object
Header to attach to the Nexus request. Note these headers are not the same as Temporal headers on internal activities and child workflows, these are transmitted to Nexus operations that may be external and are not traditional payloads.
Index signature
▪ [k: string]: string
Implementation of
INexusOperationScheduledEventAttributes.nexusHeader
operation
• operation: string
Operation name.
Implementation of
INexusOperationScheduledEventAttributes.operation
requestId
• requestId: string
A unique ID generated by the history service upon creation of this event. The ID will be transmitted with all nexus StartOperation requests and is used as an idempotentency key.
Implementation of
INexusOperationScheduledEventAttributes.requestId
scheduleToCloseTimeout
• Optional scheduleToCloseTimeout: null | IDuration
Schedule-to-close timeout for this operation. Indicates how long the caller is willing to wait for operation completion. Calls are retried internally by the server. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)
Implementation of
INexusOperationScheduledEventAttributes.scheduleToCloseTimeout
service
• service: string
Service name.
Implementation of
INexusOperationScheduledEventAttributes.service
workflowTaskCompletedEventId
• workflowTaskCompletedEventId: Long
The WORKFLOW_TASK_COMPLETED event that the corresponding ScheduleNexusOperation command was reported with.
Implementation of
INexusOperationScheduledEventAttributes.workflowTaskCompletedEventId
Methods
toJSON
▸ toJSON(): Object
Converts this NexusOperationScheduledEventAttributes to JSON.
Returns
Object
JSON object
create
▸ create(properties?): NexusOperationScheduledEventAttributes
Creates a new NexusOperationScheduledEventAttributes instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | INexusOperationScheduledEventAttributes | Properties to set |
Returns
NexusOperationScheduledEventAttributes
NexusOperationScheduledEventAttributes instance
decode
▸ decode(reader, length?): NexusOperationScheduledEventAttributes
Decodes a NexusOperationScheduledEventAttributes 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
NexusOperationScheduledEventAttributes
NexusOperationScheduledEventAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): NexusOperationScheduledEventAttributes
Decodes a NexusOperationScheduledEventAttributes message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
NexusOperationScheduledEventAttributes
NexusOperationScheduledEventAttributes
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 NexusOperationScheduledEventAttributes message. Does not implicitly temporal.api.history.v1.NexusOperationScheduledEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | INexusOperationScheduledEventAttributes | NexusOperationScheduledEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified NexusOperationScheduledEventAttributes message, length delimited. Does not implicitly temporal.api.history.v1.NexusOperationScheduledEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | INexusOperationScheduledEventAttributes | NexusOperationScheduledEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): NexusOperationScheduledEventAttributes
Creates a NexusOperationScheduledEventAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
NexusOperationScheduledEventAttributes
NexusOperationScheduledEventAttributes
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for NexusOperationScheduledEventAttributes
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 NexusOperationScheduledEventAttributes message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | NexusOperationScheduledEventAttributes | NexusOperationScheduledEventAttributes |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object