Skip to main content

Interface: IStartNexusOperationExecutionRequest

Properties of a StartNexusOperationExecutionRequest.

Extends​

Properties​

completionCallbacks?​

optional completionCallbacks?: $Properties[] | null

Completion callbacks to be invoked once the Nexus operation reaches a terminal state.

Inherited from​

$Properties.completionCallbacks

endpoint?​

optional endpoint?: string | null

Endpoint name, resolved to a URL via the cluster's endpoint registry.

Inherited from​

$Properties.endpoint

idConflictPolicy?​

optional idConflictPolicy?: NexusOperationIdConflictPolicy | null

Defines how to resolve an operation id conflict with a running operation. The default policy is NEXUS_OPERATION_ID_CONFLICT_POLICY_FAIL.

Inherited from​

$Properties.idConflictPolicy

identity?​

optional identity?: string | null

The identity of the client who initiated this request.

Inherited from​

$Properties.identity

idReusePolicy?​

optional idReusePolicy?: NexusOperationIdReusePolicy | null

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.

Inherited from​

$Properties.idReusePolicy

input?​

optional input?: $Properties | null

Serialized input to the operation. Passed as the request payload.

Inherited from​

$Properties.input

optional links?: $Properties[] | null

Links to be associated with the Nexus operation. Callbacks may also have associated links; links already included with a callback should not be duplicated here.

Inherited from​

$Properties.links

namespace?​

optional namespace?: string | null

StartNexusOperationExecutionRequest namespace

Inherited from​

$Properties.namespace

nexusHeader?​

optional nexusHeader?: {[k: string]: string; } | null

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

onConflictOptions?​

optional onConflictOptions?: $Properties | null

Defines actions to be done to the existing running standalone Nexus when the conflict policy NEXUS_OPERATION_ID_CONFLICT_POLICY_USE_EXISTING is used. If not set or set to a empty object (all options with default value), it will not modify the running operation.

Inherited from​

$Properties.onConflictOptions

operation?​

optional operation?: string | null

Operation name.

Inherited from​

$Properties.operation

operationId?​

optional operationId?: string | null

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.

Inherited from​

$Properties.operationId

requestId?​

optional requestId?: string | null

A unique identifier for this caller-side start request. Typically UUIDv4. StartOperation requests sent to the handler will use a server-generated request ID.

Inherited from​

$Properties.requestId

scheduleToCloseTimeout?​

optional scheduleToCloseTimeout?: $Properties | null

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?: $Properties | null

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

Inherited from​

$Properties.scheduleToStartTimeout

searchAttributes?​

optional searchAttributes?: $Properties | null

Search attributes for indexing.

Inherited from​

$Properties.searchAttributes

service?​

optional service?: string | null

Service name.

Inherited from​

$Properties.service

startToCloseTimeout?​

optional startToCloseTimeout?: $Properties | null

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

Inherited from​

$Properties.startToCloseTimeout

userMetadata?​

optional userMetadata?: $Properties | null

Metadata for use by user interfaces to display the fixed as-of-start summary and details of the operation.

Inherited from​

$Properties.userMetadata