Skip to main content

Class: ScheduleNexusOperation

A request to begin a Nexus operation

Properties​

cancellationType​

cancellationType: NexusOperationCancellationType

Defines behaviour of the underlying nexus operation when operation cancellation has been requested.

endpoint​

endpoint: string

Endpoint name, must exist in the endpoint registry or this command will fail.

input?​

optional input?: $Properties | null

Input for the operation. The server converts this into Nexus request content and the appropriate content headers internally when sending the StartOperation request. On the handler side, if it is also backed by Temporal, the content is transformed back to the original Payload sent in this command.

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.

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.

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 the operation is not started within this timeout, it will fail with TIMEOUT_TYPE_SCHEDULE_TO_START. If not set or zero, no schedule-to-start timeout is enforced.

seq​

seq: number

Lang's incremental sequence number, used as the operation identifier

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. If the operation does not complete within this timeout after starting, it will fail with TIMEOUT_TYPE_START_TO_CLOSE. Only applies to asynchronous operations. Synchronous operations ignore this timeout. If not set or zero, no start-to-close timeout is enforced.

Methods​

toJSON()​

toJSON(): object

Converts this ScheduleNexusOperation to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ScheduleNexusOperation & $Properties

Creates a new ScheduleNexusOperation instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ScheduleNexusOperation & $Properties

ScheduleNexusOperation instance

Call Signature​

static create(properties?): ScheduleNexusOperation

Creates a new ScheduleNexusOperation instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ScheduleNexusOperation

ScheduleNexusOperation instance

decode()​

static decode(reader, length?): ScheduleNexusOperation & $Properties

Decodes a ScheduleNexusOperation 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​

ScheduleNexusOperation & $Properties

ScheduleNexusOperation

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ScheduleNexusOperation & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ScheduleNexusOperation & $Properties

ScheduleNexusOperation

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 ScheduleNexusOperation message. Does not implicitly coresdk.workflow_commands.ScheduleNexusOperation.verify|verify messages.

Parameters​

message​

$Properties

ScheduleNexusOperation message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified ScheduleNexusOperation message, length delimited. Does not implicitly coresdk.workflow_commands.ScheduleNexusOperation.verify|verify messages.

Parameters​

message​

$Properties

ScheduleNexusOperation message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ScheduleNexusOperation

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

ScheduleNexusOperation

ScheduleNexusOperation

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ScheduleNexusOperation

ScheduleNexusOperation

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object