Skip to main content

Interface: IScheduleNexusOperationCommandAttributes

command.v1.IScheduleNexusOperationCommandAttributes

Properties of a ScheduleNexusOperationCommandAttributes.

Implemented by

Properties

endpoint

Optional endpoint: null | string

Endpoint name, must exist in the endpoint registry or this command will fail.


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 sent in this command.


nexusHeader

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

Header to attach to the Nexus request. Users are responsible for encrypting sensitive data in this header as it is stored in workflow history and transmitted to external services as-is. This is useful for propagating tracing information. 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.


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.