Skip to main content

Interface: INexusOperationScheduledEventAttributes

history.v1.INexusOperationScheduledEventAttributes

Properties of a NexusOperationScheduledEventAttributes.

Implemented by

Properties

endpoint

Optional endpoint: null | string

Endpoint name, must exist in the endpoint registry.


endpointId

Optional endpointId: null | 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

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.


nexusHeader

Optional nexusHeader: null | { [k: string]: string; }

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.


operation

Optional operation: null | string

Operation name.


requestId

Optional requestId: null | 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

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. --)


service

Optional service: null | string

Service name.


workflowTaskCompletedEventId

Optional workflowTaskCompletedEventId: null | Long

The WORKFLOW_TASK_COMPLETED event that the corresponding ScheduleNexusOperation command was reported with.