Class: StartNexusOperationExecutionRequest
workflowservice.v1.StartNexusOperationExecutionRequest
Represents a StartNexusOperationExecutionRequest.
Properties
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.
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.
identity
• identity: string
The identity of the client who initiated this request.
input
• Optional input: null | $Properties
Serialized input to the operation. Passed as the request payload.
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
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: null | $Properties
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: null | $Properties
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: null | $Properties
Search attributes for indexing.
service
• service: string
Service name.
startToCloseTimeout
• Optional startToCloseTimeout: null | $Properties
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: null | $Properties
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
▸ create(properties?): StartNexusOperationExecutionRequest & $Properties
Creates a new StartNexusOperationExecutionRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
StartNexusOperationExecutionRequest & $Properties
StartNexusOperationExecutionRequest instance
▸ create(properties?): StartNexusOperationExecutionRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
StartNexusOperationExecutionRequest
decode
▸ decode(reader, length?): StartNexusOperationExecutionRequest & $Properties
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 & $Properties
StartNexusOperationExecutionRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): StartNexusOperationExecutionRequest & $Properties
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 & $Properties
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 | $Properties | 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 | $Properties | 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
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