Class: ScheduleNexusOperation

coresdk.workflow_commands.ScheduleNexusOperation

A request to begin a Nexus operation

Implements

• IScheduleNexusOperation

Constructors

constructor

• new ScheduleNexusOperation(properties?): ScheduleNexusOperation

Constructs a new ScheduleNexusOperation.

Parameters

Name	Type	Description
properties?	IScheduleNexusOperation	Properties to set

Returns

ScheduleNexusOperation

Properties

endpoint

• endpoint: string

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

Implementation of

IScheduleNexusOperation.endpoint

---

input

• Optional input: null | IPayload

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.

Implementation of

IScheduleNexusOperation.input

---

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

IScheduleNexusOperation.nexusHeader

---

operation

• operation: string

Operation name.

Implementation of

IScheduleNexusOperation.operation

---

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.

Implementation of

IScheduleNexusOperation.scheduleToCloseTimeout

---

seq

• seq: number

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

Implementation of

IScheduleNexusOperation.seq

---

service

• service: string

Service name.

Implementation of

IScheduleNexusOperation.service

Methods

toJSON

▸ toJSON(): Object

Converts this ScheduleNexusOperation to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): ScheduleNexusOperation

Creates a new ScheduleNexusOperation instance using the specified properties.

Parameters

Name	Type	Description
properties?	IScheduleNexusOperation	Properties to set

Returns

ScheduleNexusOperation

ScheduleNexusOperation instance

---

decode

▸ decode(reader, length?): ScheduleNexusOperation

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

ScheduleNexusOperation

ScheduleNexusOperation

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): ScheduleNexusOperation

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

Parameters

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

Returns

ScheduleNexusOperation

ScheduleNexusOperation

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

Parameters

Name	Type	Description
message	IScheduleNexusOperation	ScheduleNexusOperation message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IScheduleNexusOperation	ScheduleNexusOperation message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): ScheduleNexusOperation

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

ScheduleNexusOperation

ScheduleNexusOperation

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ScheduleNexusOperation

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 ScheduleNexusOperation message. Also converts values to other types if specified.

Parameters

Name	Type	Description
message	ScheduleNexusOperation	ScheduleNexusOperation
options?	IConversionOptions	Conversion options

Returns

Object

Plain object