Skip to main content

Interface: StartNexusOperationOptions

Options for starting a standalone Nexus operation via NexusServiceClient.startOperation or NexusServiceClient.executeOperation.

Properties​

headers?​

optional headers?: Record<string, string>

Headers to attach to the Nexus request. Transmitted to the handler as-is. Useful for propagating tracing information.

id​

id: string

Caller-side identifier for this operation. Must be unique among operations in the same namespace, subject to idReusePolicy and idConflictPolicy.

idConflictPolicy?​

optional idConflictPolicy?: NexusOperationIdConflictPolicy

How to handle an operation ID that is in use by a currently running operation.

Default​

NexusOperationIdConflictPolicy.FAIL

idReusePolicy?​

optional idReusePolicy?: NexusOperationIdReusePolicy

How to handle an operation ID that was used by a previously closed operation.

Default​

NexusOperationIdReusePolicy.ALLOW_DUPLICATE

scheduleToCloseTimeout?​

optional scheduleToCloseTimeout?: Duration

Schedule-to-close timeout for this operation.

scheduleToStartTimeout?​

optional scheduleToStartTimeout?: Duration

Schedule-to-start timeout for this operation.

searchAttributes?​

optional searchAttributes?: SearchAttributePair[] | TypedSearchAttributes

Search attributes for indexing.

startToCloseTimeout?​

optional startToCloseTimeout?: Duration

Start-to-close timeout for this operation.

summary?​

optional summary?: string

Single-line Temporal-markdown summary used by user interfaces to display operation metadata.