Interface: IStartNexusOperationExecutionRequest
workflowservice.v1.IStartNexusOperationExecutionRequest
Properties of a StartNexusOperationExecutionRequest.
Implemented by
Properties
endpoint
• Optional endpoint: null | string
Endpoint name, resolved to a URL via the cluster's endpoint registry.
idConflictPolicy
• Optional idConflictPolicy: null | NexusOperationIdConflictPolicy
Defines how to resolve an operation id conflict with a running operation. The default policy is NEXUS_OPERATION_ID_CONFLICT_POLICY_FAIL.
idReusePolicy
• Optional idReusePolicy: null | NexusOperationIdReusePolicy
Defines whether to allow re-using the operation id from a previously closed operation. The default policy is NEXUS_OPERATION_ID_REUSE_POLICY_ALLOW_DUPLICATE.
identity
• Optional identity: null | string
The identity of the client who initiated this request.
input
• Optional input: null | IPayload
Serialized input to the operation. Passed as the request payload.
namespace
• Optional namespace: null | string
StartNexusOperationExecutionRequest namespace
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.
operationId
• Optional operationId: null | string
Identifier for this operation. This is a caller-side ID, distinct from any internal operation identifiers generated by the handler. Must be unique among operations in the same namespace, subject to the rules imposed by id_reuse_policy and id_conflict_policy.
requestId
• Optional requestId: null | string
A unique identifier for this caller-side start request. Typically UUIDv4. StartOperation requests sent to the handler will use a server-generated request ID.
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. --)
scheduleToStartTimeout
• Optional scheduleToStartTimeout: null | IDuration
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 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. --)
searchAttributes
• Optional searchAttributes: null | ISearchAttributes
Search attributes for indexing.
service
• Optional service: null | string
Service name.
startToCloseTimeout
• Optional startToCloseTimeout: null | IDuration
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. 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. --)
userMetadata
• Optional userMetadata: null | IUserMetadata
Metadata for use by user interfaces to display the fixed as-of-start summary and details of the operation.