Skip to main content

Interface: IScheduleNexusOperationCommandAttributes

command.v1.IScheduleNexusOperationCommandAttributes

Properties of a ScheduleNexusOperationCommandAttributes.

Hierarchy​

  • $Properties

    ↳ IScheduleNexusOperationCommandAttributes

Properties​

endpoint​

• Optional endpoint: null | string

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

Inherited from​

$Properties.endpoint

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

Inherited from​

$Properties.input

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.

Inherited from​

$Properties.nexusHeader

operation​

• Optional operation: null | string

Operation name.

Inherited from​

$Properties.operation

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

Inherited from​

$Properties.scheduleToCloseTimeout

scheduleToStartTimeout​

• Optional scheduleToStartTimeout: null | $Properties

Schedule-to-start timeout for this operation. Indicates how long the caller is willing to wait for the operation to be started (or completed if synchronous) by the handler. If the operation is not started within this timeout, it will fail with TIMEOUT_TYPE_SCHEDULE_TO_START. If not set or zero, no schedule-to-start timeout is enforced. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --) Requires server version 1.31.0 or later.

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. Indicates how long the caller is willing to wait for an asynchronous operation to complete after it has been started. If the operation does not complete within this timeout after starting, it will fail with TIMEOUT_TYPE_START_TO_CLOSE. Only applies to asynchronous operations. Synchronous operations ignore this timeout. If not set or zero, no start-to-close timeout is enforced. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --) Requires server version 1.31.0 or later.

Inherited from​

$Properties.startToCloseTimeout