Class: ScheduleNexusOperation
coresdk.workflow_commands.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: null | $Properties
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: 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.
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 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: 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. 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
▸ create(properties?): ScheduleNexusOperation & $Properties
Creates a new ScheduleNexusOperation instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
ScheduleNexusOperation & $Properties
ScheduleNexusOperation instance
▸ create(properties?): ScheduleNexusOperation
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): ScheduleNexusOperation & $Properties
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 & $Properties
ScheduleNexusOperation
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ScheduleNexusOperation & $Properties
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 & $Properties
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 | $Properties | 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 | $Properties | 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
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