Class: ScheduleNexusOperationCommandAttributes
Represents a ScheduleNexusOperationCommandAttributes.
Properties
endpoint
endpoint:
string
Endpoint name, must exist in the endpoint registry or this command will fail.
input?
optionalinput?:$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?
optionalscheduleToCloseTimeout?:$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. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)
scheduleToStartTimeout?
optionalscheduleToStartTimeout?:$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. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --) Requires server version 1.31.0 or later.
service
service:
string
Service name.
startToCloseTimeout?
optionalstartToCloseTimeout?:$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. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --) Requires server version 1.31.0 or later.
Methods
toJSON()
toJSON():
object
Converts this ScheduleNexusOperationCommandAttributes to JSON.
Returns
object
JSON object
create()
Call Signature
staticcreate(properties?):ScheduleNexusOperationCommandAttributes&$Properties
Creates a new ScheduleNexusOperationCommandAttributes instance using the specified properties.
Parameters
properties?
Properties to set
Returns
ScheduleNexusOperationCommandAttributes & $Properties
ScheduleNexusOperationCommandAttributes instance
Call Signature
staticcreate(properties?):ScheduleNexusOperationCommandAttributes
Creates a new ScheduleNexusOperationCommandAttributes instance using the specified properties.
Parameters
properties?
Properties to set
Returns
ScheduleNexusOperationCommandAttributes
ScheduleNexusOperationCommandAttributes instance
decode()
staticdecode(reader,length?):ScheduleNexusOperationCommandAttributes&$Properties
Decodes a ScheduleNexusOperationCommandAttributes 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
ScheduleNexusOperationCommandAttributes & $Properties
ScheduleNexusOperationCommandAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited()
staticdecodeDelimited(reader):ScheduleNexusOperationCommandAttributes&$Properties
Decodes a ScheduleNexusOperationCommandAttributes message from the specified reader or buffer, length delimited.
Parameters
reader
Uint8Array<ArrayBufferLike> | Reader
Reader or buffer to decode from
Returns
ScheduleNexusOperationCommandAttributes & $Properties
ScheduleNexusOperationCommandAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode()
staticencode(message,writer?):Writer
Encodes the specified ScheduleNexusOperationCommandAttributes message. Does not implicitly temporal.api.command.v1.ScheduleNexusOperationCommandAttributes.verify|verify messages.
Parameters
message
ScheduleNexusOperationCommandAttributes message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
encodeDelimited()
staticencodeDelimited(message,writer?):Writer
Encodes the specified ScheduleNexusOperationCommandAttributes message, length delimited. Does not implicitly temporal.api.command.v1.ScheduleNexusOperationCommandAttributes.verify|verify messages.
Parameters
message
ScheduleNexusOperationCommandAttributes message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
fromObject()
staticfromObject(object):ScheduleNexusOperationCommandAttributes
Creates a ScheduleNexusOperationCommandAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
object
Plain object
Returns
ScheduleNexusOperationCommandAttributes
ScheduleNexusOperationCommandAttributes
toObject()
statictoObject(message,options?):object
Creates a plain object from a ScheduleNexusOperationCommandAttributes message. Also converts values to other types if specified.
Parameters
message
ScheduleNexusOperationCommandAttributes
ScheduleNexusOperationCommandAttributes
options?
IConversionOptions
Conversion options
Returns
object
Plain object