Skip to main content

Interface: StartNexusOperationOptions

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

{@link NexusOperationIdConflictPolicy.FAIL}

idReusePolicy​

• Optional idReusePolicy: NexusOperationIdReusePolicy

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

Default

{@link 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: TypedSearchAttributes | SearchAttributePair[]

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.