package temporal.api.command.v1
Get desktop application:
View/edit binary Protocol Buffers messages
message
message.proto:96Used in:
string timer_id = 1
The same timer id from the start timer command
message
message.proto:101Used in:
optional details = 1
message
message.proto:285Used in:
enums.v1.CommandType command_type = 1
optional user_metadata = 301
Metadata on the command. This is sometimes carried over to the history event if one is created as a result of the command. Most commands won't have this information, and how this information is used is dependent upon the interface that reads it. Current well-known uses: * start_child_workflow_execution_command_attributes - populates temporal.api.workflow.v1.WorkflowExecutionInfo.user_metadata where the summary and details are used by user interfaces to show fixed as-of-start workflow summary and details. * start_timer_command_attributes - populates temporal.api.history.v1.HistoryEvent for timer started where the summary is used to identify the timer.
repeated event_group_markers = 302
Event Group Markers attached to the command by the workflow author.
oneof attributes
The command details. The type must match that in `command_type`.
schedule_activity_task_command_attributes = 2
start_timer_command_attributes = 3
complete_workflow_execution_command_attributes = 4
fail_workflow_execution_command_attributes = 5
request_cancel_activity_task_command_attributes = 6
cancel_timer_command_attributes = 7
cancel_workflow_execution_command_attributes = 8
request_cancel_external_workflow_execution_command_attributes = 9
record_marker_command_attributes = 10
continue_as_new_workflow_execution_command_attributes = 11
start_child_workflow_execution_command_attributes = 12
signal_external_workflow_execution_command_attributes = 13
upsert_workflow_search_attributes_command_attributes = 14
protocol_message_command_attributes = 15
modify_workflow_properties_command_attributes = 17
16 is available for use - it was used as part of a prototype that never made it into a release
schedule_nexus_operation_command_attributes = 18
request_cancel_nexus_operation_command_attributes = 19
message
message.proto:88Used in:
optional result = 1
message
message.proto:157Used in:
optional workflow_type = 1
optional task_queue = 2
optional input = 3
optional workflow_run_timeout = 4
Timeout of a single workflow run.
optional workflow_task_timeout = 5
Timeout of a single workflow task.
optional backoff_start_interval = 6
How long the workflow start will be delayed - not really a "backoff" in the traditional sense.
optional retry_policy = 7
enums.v1.ContinueAsNewInitiator initiator = 8
Should be removed
optional failure = 9
Should be removed
optional last_completion_result = 10
Should be removed
string cron_schedule = 11
Should be removed. Not necessarily unused but unclear and not exposed by SDKs.
optional header = 12
optional memo = 13
optional search_attributes = 14
bool inherit_build_id = 15
If this is set, the new execution inherits the Build ID of the current execution. Otherwise, the assignment rules will be used to independently assign a Build ID to the new execution. Deprecated. Only considered for versioning v0.2.
enums.v1.ContinueAsNewVersioningBehavior initial_versioning_behavior = 16
Experimental. Optionally decide the versioning behavior that the first task of the new run should use. For example, choose to AutoUpgrade on continue-as-new instead of inheriting the pinned version of the previous run.
message
message.proto:92Used in:
optional failure = 1
message
message.proto:143Used in:
optional upserted_memo = 1
If set, update the workflow memo with the provided values. The values will be merged with the existing memo. If the user wants to delete values, a default/empty Payload should be used as the value for the key being deleted.
message
message.proto:226Used in:
string message_id = 1
The message ID of the message to which this command is a pointer.
message
message.proto:150Used in:
string marker_name = 1
map<string, > details = 2
optional header = 3
optional failure = 4
message
message.proto:72Used in:
int64 scheduled_event_id = 1
The `ACTIVITY_TASK_SCHEDULED` event id for the activity being cancelled.
message
message.proto:105Used in:
string namespace = 1
Deprecated. Cross-namespace operations are disabled by default as of server 1.30.1.
string workflow_id = 2
string run_id = 3
string control = 4
Deprecated.
bool child_workflow_only = 5
Set this to true if the workflow being cancelled is a child of the workflow originating this command. The request will be rejected if it is set to true and the target workflow is *not* a child of the requesting workflow.
string reason = 6
Reason for requesting the cancellation
message
message.proto:279Used in:
int64 scheduled_event_id = 1
The `NEXUS_OPERATION_SCHEDULED` event ID (a unique identifier) for the operation to be canceled. The operation may ignore cancellation and end up with any completion state.
message
message.proto:22Used in:
string activity_id = 1
optional activity_type = 2
optional task_queue = 4
optional header = 5
optional input = 6
optional schedule_to_close_timeout = 7
Indicates how long the caller is willing to wait for activity completion. The "schedule" time is when the activity is initially scheduled, not when the most recent retry is scheduled. Limits how long retries will be attempted. Either this or `start_to_close_timeout` must be specified. When not specified, defaults to the workflow execution timeout. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)
optional schedule_to_start_timeout = 8
Limits the time an activity task can stay in a task queue before a worker picks it up. The "schedule" time is when the most recent retry is scheduled. This timeout should usually not be set: it's useful in specific scenarios like worker-specific task queues. This timeout is always non retryable, as all a retry would achieve is to put it back into the same queue. Defaults to `schedule_to_close_timeout` or workflow execution timeout if that is not specified. More info: https://docs.temporal.io/docs/content/what-is-a-schedule-to-start-timeout/ (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)
optional start_to_close_timeout = 9
Maximum time an activity is allowed to execute after being picked up by a worker. This timeout is always retryable. Either this or `schedule_to_close_timeout` must be specified. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)
optional heartbeat_timeout = 10
Maximum permitted time between successful worker heartbeats.
optional retry_policy = 11
Activities are provided by a default retry policy which is controlled through the service's dynamic configuration. Retries will be attempted until `schedule_to_close_timeout` has elapsed. To disable retries set retry_policy.maximum_attempts to 1.
bool request_eager_execution = 12
Request to start the activity directly bypassing matching service and worker polling The slot for executing the activity should be reserved when setting this field to true.
bool use_workflow_build_id = 13
If this is set, the activity would be assigned to the Build ID of the workflow. Otherwise, Assignment rules of the activity's Task Queue will be used to determine the Build ID.
optional priority = 14
Priority metadata. If this message is not present, or any fields are not present, they inherit the values from the workflow.
message
message.proto:231Used in:
string endpoint = 1
Endpoint name, must exist in the endpoint registry or this command will fail.
string service = 2
Service name.
string operation = 3
Operation name.
optional input = 4
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.
optional schedule_to_close_timeout = 5
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. --)
map<string, string> nexus_header = 6
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.
optional schedule_to_start_timeout = 7
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.
optional start_to_close_timeout = 8
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.
message
message.proto:120Used in:
string namespace = 1
Deprecated. Cross-namespace operations are disabled by default as of server 1.30.1.
optional execution = 2
string signal_name = 3
The workflow author-defined name of the signal to send to the workflow.
optional input = 4
Serialized value(s) to provide with the signal.
string control = 5
Deprecated
bool child_workflow_only = 6
Set this to true if the workflow being cancelled is a child of the workflow originating this command. The request will be rejected if it is set to true and the target workflow is *not* a child of the requesting workflow.
optional header = 7
Headers that are passed by the workflow that is sending a signal to the external workflow that is receiving this signal.
message
message.proto:193Used in:
string namespace = 1
Deprecated. Cross-namespace operations are disabled by default as of server 1.30.1.
string workflow_id = 2
optional workflow_type = 3
optional task_queue = 4
optional input = 5
optional workflow_execution_timeout = 6
Total workflow execution timeout including retries and continue as new.
optional workflow_run_timeout = 7
Timeout of a single workflow run.
optional workflow_task_timeout = 8
Timeout of a single workflow task.
enums.v1.ParentClosePolicy parent_close_policy = 9
Default: PARENT_CLOSE_POLICY_TERMINATE.
string control = 10
enums.v1.WorkflowIdReusePolicy workflow_id_reuse_policy = 11
Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.
optional retry_policy = 12
string cron_schedule = 13
Establish a cron schedule for the child workflow.
optional header = 14
optional memo = 15
optional search_attributes = 16
bool inherit_build_id = 17
If this is set, the child workflow inherits the Build ID of the parent. Otherwise, the assignment rules of the child's Task Queue will be used to independently assign a Build ID to it. Deprecated. Only considered for versioning v0.2.
optional priority = 18
Priority metadata. If this message is not present, or any fields are not present, they inherit the values from the workflow.
message
message.proto:77Used in:
string timer_id = 1
An id for the timer, currently live timers must have different ids. Typically autogenerated by the SDK.
optional start_to_fire_timeout = 2
How long until the timer fires, producing a `TIMER_FIRED` event. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)
message
message.proto:139Used in:
optional search_attributes = 1