Skip to main content

Interface: INexusOperationScheduledEventAttributes

history.v1.INexusOperationScheduledEventAttributes

Properties of a NexusOperationScheduledEventAttributes.

Hierarchy​

  • $Properties

    ↳ INexusOperationScheduledEventAttributes

Properties​

endpoint​

• Optional endpoint: null | string

Endpoint name, must exist in the endpoint registry.

Inherited from​

$Properties.endpoint

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.

Inherited from​

$Properties.endpointId

input​

• Optional input: null | $Properties

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.

Inherited from​

$Properties.input

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.

Inherited from​

$Properties.nexusHeader

operation​

• Optional operation: null | string

Operation name.

Inherited from​

$Properties.operation

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.

Inherited from​

$Properties.requestId

scheduleToCloseTimeout​

• Optional scheduleToCloseTimeout: null | $Properties

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

Inherited from​

$Properties.scheduleToCloseTimeout

scheduleToStartTimeout​

• Optional scheduleToStartTimeout: null | $Properties

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

Inherited from​

$Properties.scheduleToStartTimeout

service​

• Optional service: null | string

Service name.

Inherited from​

$Properties.service

startToCloseTimeout​

• Optional startToCloseTimeout: null | $Properties

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

Inherited from​

$Properties.startToCloseTimeout

workflowTaskCompletedEventId​

• Optional workflowTaskCompletedEventId: null | Long

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

Inherited from​

$Properties.workflowTaskCompletedEventId