Class: NexusOperationScheduledEventAttributes
Event marking that an operation was scheduled by a workflow via the ScheduleNexusOperation command.
Properties
endpoint
endpoint:
string
Endpoint name, must exist in the endpoint registry.
endpointId
endpointId:
string
Endpoint ID as resolved in the endpoint registry at the time this event was generated. This is stored on the event and used internally by the server in case the endpoint is renamed from the time the event was originally scheduled.
input?
optionalinput?:$Properties|null
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.
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
operation
operation:
string
Operation name.
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.
scheduleToCloseTimeout?
optionalscheduleToCloseTimeout?:$Properties|null
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. --) (-- api-linter: core::0142::time-field-names=disabled aip.dev/not-precedent: "timeout" is an acceptable suffix for duration fields in this API. --)
scheduleToStartTimeout?
optionalscheduleToStartTimeout?:$Properties|null
Schedule-to-start timeout for this operation. See ScheduleNexusOperationCommandAttributes.schedule_to_start_timeout for details. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)
service
service:
string
Service name.
startToCloseTimeout?
optionalstartToCloseTimeout?:$Properties|null
Start-to-close timeout for this operation. See ScheduleNexusOperationCommandAttributes.start_to_close_timeout for details. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)
workflowTaskCompletedEventId
workflowTaskCompletedEventId:
Long
The WORKFLOW_TASK_COMPLETED event that the corresponding ScheduleNexusOperation command was reported with.
Methods
toJSON()
toJSON():
object
Converts this NexusOperationScheduledEventAttributes to JSON.
Returns
object
JSON object
create()
Call Signature
staticcreate(properties?):NexusOperationScheduledEventAttributes&$Properties
Creates a new NexusOperationScheduledEventAttributes instance using the specified properties.
Parameters
properties?
Properties to set
Returns
NexusOperationScheduledEventAttributes & $Properties
NexusOperationScheduledEventAttributes instance
Call Signature
staticcreate(properties?):NexusOperationScheduledEventAttributes
Creates a new NexusOperationScheduledEventAttributes instance using the specified properties.
Parameters
properties?
Properties to set
Returns
NexusOperationScheduledEventAttributes
NexusOperationScheduledEventAttributes instance
decode()
staticdecode(reader,length?):NexusOperationScheduledEventAttributes&$Properties
Decodes a NexusOperationScheduledEventAttributes message from the specified reader or buffer.
Parameters
reader
Uint8Array<ArrayBufferLike> | Reader
Reader or buffer to decode from
length?
number
Message length if known beforehand
Returns
NexusOperationScheduledEventAttributes & $Properties
NexusOperationScheduledEventAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited()
staticdecodeDelimited(reader):NexusOperationScheduledEventAttributes&$Properties
Decodes a NexusOperationScheduledEventAttributes message from the specified reader or buffer, length delimited.
Parameters
reader
Uint8Array<ArrayBufferLike> | Reader
Reader or buffer to decode from
Returns
NexusOperationScheduledEventAttributes & $Properties
NexusOperationScheduledEventAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode()
staticencode(message,writer?):Writer
Encodes the specified NexusOperationScheduledEventAttributes message. Does not implicitly temporal.api.history.v1.NexusOperationScheduledEventAttributes.verify|verify messages.
Parameters
message
NexusOperationScheduledEventAttributes message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
encodeDelimited()
staticencodeDelimited(message,writer?):Writer
Encodes the specified NexusOperationScheduledEventAttributes message, length delimited. Does not implicitly temporal.api.history.v1.NexusOperationScheduledEventAttributes.verify|verify messages.
Parameters
message
NexusOperationScheduledEventAttributes message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
fromObject()
staticfromObject(object):NexusOperationScheduledEventAttributes
Creates a NexusOperationScheduledEventAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
object
Plain object
Returns
NexusOperationScheduledEventAttributes
NexusOperationScheduledEventAttributes
toObject()
statictoObject(message,options?):object
Creates a plain object from a NexusOperationScheduledEventAttributes message. Also converts values to other types if specified.
Parameters
message
NexusOperationScheduledEventAttributes
NexusOperationScheduledEventAttributes
options?
IConversionOptions
Conversion options
Returns
object
Plain object