Skip to main content

Class: StartNexusOperationExecutionRequest

Represents a StartNexusOperationExecutionRequest.

Properties​

completionCallbacks​

completionCallbacks: $Properties[]

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

endpoint​

endpoint: string

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

idConflictPolicy​

idConflictPolicy: NexusOperationIdConflictPolicy

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

identity​

identity: string

The identity of the client who initiated this request.

idReusePolicy​

idReusePolicy: 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.

input?​

optional input?: $Properties | null

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

links: $Properties[]

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.

namespace​

namespace: string

StartNexusOperationExecutionRequest namespace.

nexusHeader​

nexusHeader: object

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.

Index Signature​

[k: string]: string

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.

operation​

operation: string

Operation name.

operationId​

operationId: 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​

requestId: 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?: $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. --)

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

searchAttributes?​

optional searchAttributes?: $Properties | null

Search attributes for indexing.

service​

service: string

Service name.

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

userMetadata?​

optional userMetadata?: $Properties | null

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

Methods​

toJSON()​

toJSON(): object

Converts this StartNexusOperationExecutionRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): StartNexusOperationExecutionRequest & $Shape

Creates a new StartNexusOperationExecutionRequest instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

StartNexusOperationExecutionRequest & $Shape

StartNexusOperationExecutionRequest instance

Call Signature​

static create(properties?): StartNexusOperationExecutionRequest

Creates a new StartNexusOperationExecutionRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

StartNexusOperationExecutionRequest

StartNexusOperationExecutionRequest instance

decode()​

static decode(reader, length?): StartNexusOperationExecutionRequest & $Shape

Decodes a StartNexusOperationExecutionRequest message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

StartNexusOperationExecutionRequest & $Shape

StartNexusOperationExecutionRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): StartNexusOperationExecutionRequest & $Shape

Decodes a StartNexusOperationExecutionRequest message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

StartNexusOperationExecutionRequest & $Shape

StartNexusOperationExecutionRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified StartNexusOperationExecutionRequest message. Does not implicitly temporal.api.workflowservice.v1.StartNexusOperationExecutionRequest.verify|verify messages.

Parameters​

message​

$Properties

StartNexusOperationExecutionRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified StartNexusOperationExecutionRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.StartNexusOperationExecutionRequest.verify|verify messages.

Parameters​

message​

$Properties

StartNexusOperationExecutionRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): StartNexusOperationExecutionRequest

Creates a StartNexusOperationExecutionRequest message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

Plain object

Returns​

StartNexusOperationExecutionRequest

StartNexusOperationExecutionRequest

toObject()​

static toObject(message, options?): object

Creates a plain object from a StartNexusOperationExecutionRequest message. Also converts values to other types if specified.

Parameters​

message​

StartNexusOperationExecutionRequest

StartNexusOperationExecutionRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object