Class: StartNexusOperationExecutionRequest

workflowservice.v1.StartNexusOperationExecutionRequest

Represents a StartNexusOperationExecutionRequest.

Implements

• IStartNexusOperationExecutionRequest

Constructors

constructor

• new StartNexusOperationExecutionRequest(properties?): StartNexusOperationExecutionRequest

Constructs a new StartNexusOperationExecutionRequest.

Parameters

Name	Type	Description
properties?	IStartNexusOperationExecutionRequest	Properties to set

Returns

StartNexusOperationExecutionRequest

Properties

endpoint

• endpoint: string

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

Implementation of

IStartNexusOperationExecutionRequest.endpoint

---

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.

Implementation of

IStartNexusOperationExecutionRequest.idConflictPolicy

---

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.

Implementation of

IStartNexusOperationExecutionRequest.idReusePolicy

---

identity

• identity: string

The identity of the client who initiated this request.

Implementation of

IStartNexusOperationExecutionRequest.identity

---

input

• Optional input: null | IPayload

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

Implementation of

IStartNexusOperationExecutionRequest.input

---

namespace

• namespace: string

StartNexusOperationExecutionRequest namespace.

Implementation of

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

Implementation of

IStartNexusOperationExecutionRequest.nexusHeader

---

operation

• operation: string

Operation name.

Implementation of

IStartNexusOperationExecutionRequest.operation

---

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.

Implementation of

IStartNexusOperationExecutionRequest.operationId

---

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.

Implementation of

IStartNexusOperationExecutionRequest.requestId

---

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

Implementation of

IStartNexusOperationExecutionRequest.scheduleToCloseTimeout

---

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

Implementation of

IStartNexusOperationExecutionRequest.scheduleToStartTimeout

---

searchAttributes

• Optional searchAttributes: null | ISearchAttributes

Search attributes for indexing.

Implementation of

IStartNexusOperationExecutionRequest.searchAttributes

---

service

• service: string

Service name.

Implementation of

IStartNexusOperationExecutionRequest.service

---

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

Implementation of

IStartNexusOperationExecutionRequest.startToCloseTimeout

---

userMetadata

• Optional userMetadata: null | IUserMetadata

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

Implementation of

IStartNexusOperationExecutionRequest.userMetadata

Methods

toJSON

▸ toJSON(): Object

Converts this StartNexusOperationExecutionRequest to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): StartNexusOperationExecutionRequest

Creates a new StartNexusOperationExecutionRequest instance using the specified properties.

Parameters

Name	Type	Description
properties?	IStartNexusOperationExecutionRequest	Properties to set

Returns

StartNexusOperationExecutionRequest

StartNexusOperationExecutionRequest instance

---

decode

▸ decode(reader, length?): StartNexusOperationExecutionRequest

Decodes a StartNexusOperationExecutionRequest message from the specified reader or buffer.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from
length?	number	Message length if known beforehand

Returns

StartNexusOperationExecutionRequest

StartNexusOperationExecutionRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): StartNexusOperationExecutionRequest

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

StartNexusOperationExecutionRequest

StartNexusOperationExecutionRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

encode

▸ encode(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IStartNexusOperationExecutionRequest	StartNexusOperationExecutionRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IStartNexusOperationExecutionRequest	StartNexusOperationExecutionRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): StartNexusOperationExecutionRequest

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

StartNexusOperationExecutionRequest

StartNexusOperationExecutionRequest

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for StartNexusOperationExecutionRequest

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	StartNexusOperationExecutionRequest	StartNexusOperationExecutionRequest
options?	IConversionOptions	Conversion options

Returns

Object

Plain object