package temporal.api.workflowservice.v1
Get desktop application:
View/edit binary Protocol Buffers messages
service WorkflowService
service.proto:29WorkflowService API defines how Temporal SDKs and other clients interact with the Temporal server to create and interact with workflows and activities. Users are expected to call `StartWorkflowExecution` to create a new workflow execution. To drive workflows, a worker using a Temporal SDK must exist which regularly polls for workflow and activity tasks from the service. For each workflow task, the sdk must process the (incremental or complete) event history and respond back with any newly generated commands. For each activity task, the worker is expected to execute the user's code which implements that activity, responding with completion or failure.
CountActivityExecutions is a visibility API to count activity executions in a specific namespace.
message
request_response.proto:3446string namespace = 1
string query = 2
Visibility query, see https://docs.temporal.io/list-filter for the syntax.
message
request_response.proto:3452int64 count = 1
If `query` is not grouping by any field, the count is an approximate number of activities that match the query. If `query` is grouping by a field, the count is simply the sum of the counts of the groups returned in the response. This number can be smaller than the total number of activities matching the query.
repeated groups = 2
Contains the groups if the request is grouping by a field. The list might not be complete, and the counts of each group is approximate.
CountNexusOperationExecutions is a visibility API to count Nexus operations in a specific namespace.
message
request_response.proto:3470string namespace = 1
string query = 2
Visibility query, see https://docs.temporal.io/list-filter for the syntax. See also ListNexusOperationExecutionsRequest for search attributes available for Nexus operations.
message
request_response.proto:3477int64 count = 1
If `query` is not grouping by any field, the count is an approximate number of operations that match the query. If `query` is grouping by a field, the count is simply the sum of the counts of the groups returned in the response. This number can be smaller than the total number of operations matching the query.
repeated groups = 2
Contains the groups if the request is grouping by a field. The list might not be complete, and the counts of each group is approximate.
rpc CountSchedules (, )
service.proto:853CountSchedules is a visibility API to count schedules in a specific namespace.
message
request_response.proto:1500string namespace = 1
string query = 2
Visibility query, see https://docs.temporal.io/list-filter for the syntax.
message
request_response.proto:1506int64 count = 1
If `query` is not grouping by any field, the count is an approximate number of schedules that match the query. If `query` is grouping by a field, the count is simply the sum of the counts of the groups returned in the response. This number can be smaller than the total number of schedules matching the query.
repeated groups = 2
Contains the groups if the request is grouping by a field. The list might not be complete, and the counts of each group is approximate.
rpc CountWorkers (, )
service.proto:1569CountWorkers counts the number of workers in a specific namespace.
message
request_response.proto:3069string namespace = 1
string query = 2
Query to filter workers before counting. Supported filter fields are the same as in ListWorkersRequest.
bool include_system_workers = 3
When true, the count will include system workers that are created implicitly by the server and not by the user. By default, system workers are excluded.
message
request_response.proto:3079int64 count = 1
Number of workers matching the query.
CountWorkflowExecutions is a visibility API to count of workflow executions in a specific namespace.
message
request_response.proto:1045string namespace = 1
string query = 2
message
request_response.proto:1050int64 count = 1
If `query` is not grouping by any field, the count is an approximate number of workflows that matches the query. If `query` is grouping by a field, the count is simply the sum of the counts of the groups returned in the response. This number can be smaller than the total number of workflows matching the query.
repeated groups = 2
`groups` contains the groups if the request is grouping by a field. The list might not be complete, and the counts of each group is approximate.
rpc CreateSchedule (, )
service.proto:753Creates a new schedule.
message
request_response.proto:1361(-- api-linter: core::0203::optional=disabled aip.dev/not-precedent: field_behavior annotation not available in our gogo fork --)
string namespace = 1
The namespace the schedule should be created in.
string schedule_id = 2
The id of the new schedule.
optional schedule = 3
The schedule spec, policies, action, and initial state.
optional initial_patch = 4
Optional initial patch (e.g. to run the action once immediately).
string identity = 5
The identity of the client who initiated this request.
string request_id = 6
A unique identifier for this create request for idempotence. Typically UUIDv4.
optional memo = 7
Memo and search attributes to attach to the schedule itself.
optional search_attributes = 8
message
request_response.proto:1379bytes conflict_token = 1
Creates a new Worker Deployment. Experimental. This API might significantly change or be removed in a future release.
message
request_response.proto:2602Creates a new WorkerDeployment.
string namespace = 1
string deployment_name = 2
The name of the Worker Deployment to create. If a Worker Deployment with this name already exists, an error will be returned.
string identity = 4
Optional. The identity of the client who initiated this request.
string request_id = 5
A unique identifier for this create request for idempotence. Typically UUIDv4.
message
request_response.proto:2614bytes conflict_token = 1
This value is returned so that it can be optionally passed to APIs that write to the WorkerDeployment state to ensure that the state did not change between this API call and a future write.
Creates a new Worker Deployment Version. Experimental. This API might significantly change or be removed in a future release.
message
request_response.proto:2648Creates a new WorkerDeploymentVersion.
string namespace = 1
optional deployment_version = 2
Required.
optional compute_config = 4
Optional. Contains the new worker compute configuration for the Worker Deployment. Used for worker scale management.
string identity = 3
Optional. The identity of the client who initiated this request.
string request_id = 5
A unique identifier for this create request for idempotence. Typically UUIDv4. If a second request with the same ID is recieved, it is considered a successful no-op. Retrying with a different request ID for the same deployment name + build ID is an error.
message
request_response.proto:2666(message has no fields)
rpc CreateWorkflowRule (, )
service.proto:1481Create a new workflow rule. The rules are used to control the workflow execution. The rule will be applied to all running and new workflows in the namespace. If the rule with such ID already exist this call will fail Note: the rules are part of namespace configuration and will be stored in the namespace config. Namespace config is eventually consistent.
message
request_response.proto:2833string namespace = 1
optional spec = 2
The rule specification .
bool force_scan = 3
If true, the rule will be applied to the currently running workflows via batch job. If not set , the rule will only be applied when triggering condition is satisfied. visibility_query in the rule will be used to select the workflows to apply the rule to.
string request_id = 4
Used to de-dupe requests. Typically should be UUID.
string identity = 5
Identity of the actor who created the rule. Will be stored with the rule.
string description = 6
Rule description.Will be stored with the rule.
message
request_response.proto:2854optional rule = 1
Created rule.
string job_id = 2
Batch Job ID if force-scan flag was provided. Otherwise empty.
DeleteActivityExecution asynchronously deletes a specific activity execution (when ActivityExecution.run_id is provided) or the latest activity execution (when ActivityExecution.run_id is not provided). If the activity Execution is running, it will be terminated before deletion. (-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: Activity deletion not exposed to HTTP, users should use cancel or terminate. --)
message
request_response.proto:3528string namespace = 1
string activity_id = 2
string run_id = 3
Activity run ID, targets the latest run if run_id is empty.
message
request_response.proto:3535(message has no fields)
DeleteNexusOperationExecution asynchronously deletes a specific Nexus operation run (when run_id is provided) or the latest run (when run_id is not provided). If the operation is running, it will be terminated before deletion. (-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: Nexus operation deletion not exposed to HTTP, users should use cancel or terminate. --)
message
request_response.proto:3570string namespace = 1
string operation_id = 2
string run_id = 3
Operation run ID, targets the latest run if empty.
message
request_response.proto:3577(message has no fields)
rpc DeleteSchedule (, )
service.proto:829Deletes a schedule, removing it from the system.
message
request_response.proto:1472string namespace = 1
The namespace of the schedule to delete.
string schedule_id = 2
The id of the schedule to delete.
string identity = 3
The identity of the client who initiated this request.
message
request_response.proto:1481(message has no fields)
Deletes records of (an old) Deployment. A deployment can only be deleted if it has no Version in it. Experimental. This API might significantly change or be removed in a future release.
message
request_response.proto:2693Deletes records of (an old) Deployment. A deployment can only be deleted if it has no Version in it.
string namespace = 1
string deployment_name = 2
string identity = 3
Optional. The identity of the client who initiated this request.
message
request_response.proto:2700(message has no fields)
Used for manual deletion of Versions. User can delete a Version only when all the following conditions are met: - It is not the Current or Ramping Version of its Deployment. - It has no active pollers (none of the task queues in the Version have pollers) - It is not draining (see WorkerDeploymentVersionInfo.drainage_info). This condition can be skipped by passing `skip-drainage=true`. Experimental. This API might significantly change or be removed in a future release.
message
request_response.proto:2675Used for manual deletion of Versions. User can delete a Version only when all the following conditions are met: - It is not the Current or Ramping Version of its Deployment. - It has no active pollers (none of the task queues in the Version have pollers) - It is not draining (see WorkerDeploymentVersionInfo.drainage_info). This condition can be skipped by passing `skip-drainage=true`.
string namespace = 1
string version = 2
Deprecated. Use `deployment_version`.
optional deployment_version = 5
Required.
bool skip_drainage = 3
Pass to force deletion even if the Version is draining. In this case the open pinned workflows will be stuck until manually moved to another version by UpdateWorkflowExecutionOptions.
string identity = 4
Optional. The identity of the client who initiated this request.
message
request_response.proto:2688(message has no fields)
DeleteWorkflowExecution asynchronously deletes a specific Workflow Execution (when WorkflowExecution.run_id is provided) or the latest Workflow Execution (when WorkflowExecution.run_id is not provided). If the Workflow Execution is Running, it will be terminated before deletion. (-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: Workflow deletion not exposed to HTTP, users should use cancel or terminate. --)
message
request_response.proto:965string namespace = 1
optional workflow_execution = 2
Workflow Execution to delete. If run_id is not specified, the latest one is used.
message
request_response.proto:971(message has no fields)
rpc DeleteWorkflowRule (, )
service.proto:1504Delete rule by rule id
message
request_response.proto:2873string namespace = 1
string rule_id = 2
ID of the rule to delete. Unique within the namespace.
message
request_response.proto:2880(message has no fields)
rpc DeprecateNamespace (, )
service.proto:89DeprecateNamespace is used to update the state of a registered namespace to DEPRECATED. Once the namespace is deprecated it cannot be used to start new workflow executions. Existing workflow executions will continue to run on deprecated namespaces. Deprecated. (-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: Deprecated --)
message
request_response.proto:131Deprecated.
string namespace = 1
string security_token = 2
message
request_response.proto:137Deprecated.
(message has no fields)
DescribeActivityExecution returns information about an activity execution. It can be used to: - Get current activity info without waiting - Long-poll for next state change and return new activity info Response can optionally include activity input or outcome (if the activity has completed).
message
request_response.proto:3202string namespace = 1
string activity_id = 2
string run_id = 3
Activity run ID. If empty the request targets the latest run.
bool include_input = 4
Include the input field in the response.
bool include_outcome = 5
Include the outcome (result/failure) in the response if the activity has completed.
bytes long_poll_token = 6
Token from a previous DescribeActivityExecutionResponse. If present, long-poll until activity state changes from the state encoded in this token. If absent, return current state immediately. If present, run_id must also be present. Note that activity state may change multiple times between requests, therefore it is not guaranteed that a client making a sequence of long-poll requests will see a complete sequence of state changes.
bool include_heartbeat_details = 7
Include the heartbeat_details field inside info in the response if available.
bool include_last_failure = 8
Include the last_failure field inside info in the response if available.
message
request_response.proto:3224string run_id = 1
The run ID of the activity, useful when run_id was not specified in the request.
optional info = 2
Information about the activity execution. Fields heartbeat_details and last_failure are omitted unless the request has include_heartbeat_details or include_last_failure set to true, respectively.
optional input = 3
Serialized activity input, passed as arguments to the activity function. Only set if include_input was true in the request.
optional outcome = 4
Only set if the activity is completed and include_outcome was true in the request.
bytes long_poll_token = 5
Token for follow-on long-poll requests. Absent only if the activity is complete.
repeated callbacks = 6
Callbacks attached to this activity execution and their current state.
DescribeBatchOperation returns the information about a batch operation
message
request_response.proto:1872string namespace = 1
Namespace that contains the batch operation
string job_id = 2
Batch job id
message
request_response.proto:1879enums.v1.BatchOperationType operation_type = 1
Batch operation type
string job_id = 2
Batch job ID
enums.v1.BatchOperationState state = 3
Batch operation state
optional start_time = 4
Batch operation start time
optional close_time = 5
Batch operation close time
int64 total_operation_count = 6
Total operation count
int64 complete_operation_count = 7
Complete operation count
int64 failure_operation_count = 8
Failure operation count
string identity = 9
Identity indicates the operator identity
string reason = 10
Reason indicates the reason to stop a operation
rpc DescribeDeployment (, )
service.proto:958Describes a worker deployment. Experimental. This API might significantly change or be removed in a future release. Deprecated. Replaced with `DescribeWorkerDeploymentVersion`.
message
request_response.proto:2397[cleanup-wv-pre-release] Pre-release deployment APIs, clean up later
string namespace = 1
optional deployment = 2
message
request_response.proto:2402[cleanup-wv-pre-release] Pre-release deployment APIs, clean up later
optional deployment_info = 1
rpc DescribeNamespace (, )
service.proto:49DescribeNamespace returns the information and configuration for a registered namespace.
message
request_response.proto:86string namespace = 1
string id = 2
bool weak_consistency = 3
If true, the server may serve the response from an eventually-consistent source instead of reading through to persistence. Defaults to false, which preserves read-after-write consistency. SDKs should set this when fetching namespace capabilities on worker/client startup.
DescribeNexusOperationExecution returns information about a Nexus operation. Supported use cases include: - Get current operation info without waiting - Long-poll for next state change and return new operation info Response can optionally include operation input or outcome (if the operation has completed).
message
request_response.proto:3347string namespace = 1
string operation_id = 2
string run_id = 3
Operation run ID. If empty the request targets the latest run.
bool include_input = 4
Include the input field in the response.
bool include_outcome = 5
Include the outcome (result/failure) in the response if the operation has completed.
bytes long_poll_token = 6
Token from a previous DescribeNexusOperationExecutionResponse. If present, this RPC will long-poll until operation state changes from the state encoded in this token. If absent, return current state immediately. If present, run_id must also be present. Note that operation state may change multiple times between requests, therefore it is not guaranteed that a client making a sequence of long-poll requests will see a complete sequence of state changes.
message
request_response.proto:3365string run_id = 1
The run ID of the operation, useful when run_id was not specified in the request.
optional info = 2
Information about the operation.
optional input = 3
Serialized operation input, passed as the request payload. Only set if include_input was true in the request.
oneof outcome
Only set if the operation is completed and include_outcome was true in the request.
result = 4
The result if the operation completed successfully.
failure = 5
The failure if the operation completed unsuccessfully.
bytes long_poll_token = 6
Token for follow-on long-poll requests. Absent only if the operation is complete.
rpc DescribeSchedule (, )
service.proto:769Returns the schedule description and current state of an existing schedule.
message
request_response.proto:1383string namespace = 1
The namespace of the schedule to describe.
string schedule_id = 2
The id of the schedule to describe.
message
request_response.proto:1390optional schedule = 1
The complete current schedule details. This may not match the schedule as created because: - some types of schedule specs may get compiled into others (e.g. CronString into StructuredCalendarSpec) - some unspecified fields may be replaced by defaults - some fields in the state are modified automatically - the schedule may have been modified by UpdateSchedule or PatchSchedule
optional info = 2
Extra schedule state info.
optional memo = 3
The memo and search attributes that the schedule was created with.
optional search_attributes = 4
bytes conflict_token = 5
This value can be passed back to UpdateSchedule to ensure that the schedule was not modified between a Describe and an Update, which could lead to lost updates and other confusion.
rpc DescribeTaskQueue (, )
service.proto:710DescribeTaskQueue returns the following information about the target task queue, broken down by Build ID: - List of pollers - Workflow Reachability status - Backlog info for Workflow and/or Activity tasks
message
request_response.proto:1172(-- api-linter: core::0203::optional=disabled aip.dev/not-precedent: field_behavior annotation not available in our gogo fork --)
string namespace = 1
optional task_queue = 2
Sticky queues are not supported in deprecated ENHANCED mode.
enums.v1.TaskQueueType task_queue_type = 3
If unspecified (TASK_QUEUE_TYPE_UNSPECIFIED), then default value (TASK_QUEUE_TYPE_WORKFLOW) will be used. Only supported in default mode (use `task_queue_types` in ENHANCED mode instead).
bool report_stats = 8
Report stats for the requested task queue type(s).
bool report_config = 11
Report Task Queue Config
bool include_task_queue_status = 4
Deprecated, use `report_stats` instead. If true, the task queue status will be included in the response.
enums.v1.DescribeTaskQueueMode api_mode = 5
Deprecated. ENHANCED mode is also being deprecated. Select the API mode to use for this request: DEFAULT mode (if unset) or ENHANCED mode. Consult the documentation for each field to understand which mode it is supported in.
optional versions = 6
Deprecated (as part of the ENHANCED mode deprecation). Optional. If not provided, the result for the default Build ID will be returned. The default Build ID is the one mentioned in the first unconditional Assignment Rule. If there is no default Build ID, the result for the unversioned queue will be returned. (-- api-linter: core::0140::prepositions --)
repeated enums.v1.TaskQueueType task_queue_types = 7
Deprecated (as part of the ENHANCED mode deprecation). Task queue types to report info about. If not specified, all types are considered.
bool report_pollers = 9
Deprecated (as part of the ENHANCED mode deprecation). Report list of pollers for requested task queue types and versions.
bool report_task_reachability = 10
Deprecated (as part of the ENHANCED mode deprecation). Report task reachability for the requested versions and all task types (task reachability is not reported per task type).
message
request_response.proto:1218repeated pollers = 1
optional stats = 5
Statistics for the task queue. Only set if `report_stats` is set on the request.
map<int32, > stats_by_priority_key = 8
Task queue stats breakdown by priority key. Only contains actively used priority keys. Only set if `report_stats` is set on the request. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "by" is used to clarify the keys and values. --)
optional versioning_info = 4
Specifies which Worker Deployment Version(s) Server routes this Task Queue's tasks to. When not present, it means the tasks are routed to Unversioned workers (workers with UNVERSIONED or unspecified WorkerVersioningMode.) Task Queue Versioning info is updated indirectly by calling SetWorkerDeploymentCurrentVersion and SetWorkerDeploymentRampingVersion on Worker Deployments. Note: This information is not relevant to Pinned workflow executions and their activities as they are always routed to their Pinned Deployment Version. However, new workflow executions are typically not Pinned until they complete their first task (unless they are started with a Pinned VersioningOverride or are Child Workflows of a Pinned parent).
optional config = 6
Only populated if report_task_queue_config is set to true.
optional effective_rate_limit = 7
optional task_queue_status = 2
Deprecated. Status of the task queue. Only populated when `include_task_queue_status` is set to true in the request.
map<string, > versions_info = 3
Deprecated. Only returned in ENHANCED mode. This map contains Task Queue information for each Build ID. Empty string as key value means unversioned.
rpc DescribeWorker (, )
service.proto:1632DescribeWorker returns information about the specified worker.
message
request_response.proto:3057string namespace = 1
Namespace this worker belongs to.
string worker_instance_key = 2
Worker instance key to describe.
message
request_response.proto:3065optional worker_info = 1
Describes a Worker Deployment. Experimental. This API might significantly change or be removed in a future release.
message
request_response.proto:2435string namespace = 1
string deployment_name = 2
message
request_response.proto:2440bytes conflict_token = 1
This value is returned so that it can be optionally passed to APIs that write to the Worker Deployment state to ensure that the state did not change between this read and a future write.
optional worker_deployment_info = 2
Describes a worker deployment version. Experimental. This API might significantly change or be removed in a future release.
message
request_response.proto:2406string namespace = 1
string version = 2
Deprecated. Use `deployment_version`.
optional deployment_version = 3
Required.
bool report_task_queue_stats = 4
Report stats for task queues which have been polled by this version.
message
request_response.proto:2416optional worker_deployment_version_info = 1
repeated version_task_queues = 2
All the Task Queues that have ever polled from this Deployment version.
DescribeWorkflowExecution returns information about the specified workflow execution.
message
request_response.proto:1154string namespace = 1
optional execution = 2
message
request_response.proto:1159optional execution_config = 1
optional workflow_execution_info = 2
repeated pending_activities = 3
repeated pending_children = 4
optional pending_workflow_task = 5
repeated callbacks = 6
repeated pending_nexus_operations = 7
optional workflow_extended_info = 8
DescribeWorkflowRule return the rule specification for existing rule id. If there is no rule with such id - NOT FOUND error will be returned.
message
request_response.proto:2862string namespace = 1
string rule_id = 2
User-specified ID of the rule to read. Unique within the namespace.
message
request_response.proto:2868optional rule = 1
The rule that was read.
ExecuteMultiOperation executes multiple operations within a single workflow. Operations are started atomically, meaning if *any* operation fails to be started, none are, and the request fails. Upon start, the API returns only when *all* operations have a response. Upon failure, it returns `MultiOperationExecutionFailure` where the status code equals the status code of the *first* operation that failed to be started. (-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: To be exposed over HTTP in the future. --)
message
request_response.proto:2031string namespace = 1
repeated operations = 2
List of operations to execute within a single workflow. Preconditions: - The list of operations must not be empty. - The workflow ids must match across operations. - The only valid list of operations at this time is [StartWorkflow, UpdateWorkflow], in this order. Note that additional operation-specific restrictions have to be considered.
string resource_id = 3
Resource ID for routing. Should match operations[0].start_workflow.workflow_id
message
request_response.proto:2069IMPORTANT: For [StartWorkflow, UpdateWorkflow] combination ("Update-with-Start") when both 1. the workflow update for the requested update ID has already completed, and 2. the workflow for the requested workflow ID has already been closed, then you'll receive - an update response containing the update's outcome, and - a start response with a `status` field that reflects the workflow's current state.
repeated responses = 1
rpc FetchWorkerConfig (, )
service.proto:1598FetchWorkerConfig returns the worker configuration for a specific worker.
message
request_response.proto:3003string namespace = 1
Namespace this worker belongs to.
string identity = 2
The identity of the client who initiated this request.
string reason = 3
Reason for sending worker command, can be used for audit purpose.
optional selector = 6
Defines which workers should receive this command. only single worker is supported at this time.
string resource_id = 7
Resource ID for routing. Contains the worker grouping key.
message
request_response.proto:3020optional worker_config = 1
The worker configuration.
rpc GetClusterInfo (, )
service.proto:724GetClusterInfo returns information about temporal cluster
message
request_response.proto:1268(message has no fields)
message
request_response.proto:1272GetClusterInfoResponse contains information about Temporal cluster.
map<string, string> supported_clients = 1
Key is client name i.e "temporal-go", "temporal-java", or "temporal-cli". Value is ranges of supported versions of this client i.e ">1.1.1 <=1.4.0 || ^5.0.0".
string server_version = 2
string cluster_id = 3
optional version_info = 4
string cluster_name = 5
int32 history_shard_count = 6
string persistence_store = 7
string visibility_store = 8
int64 initial_failover_version = 9
int64 failover_version_increment = 10
Returns the current deployment (and its info) for a given deployment series. Experimental. This API might significantly change or be removed in a future release. Deprecated. Replaced by `current_version` returned by `DescribeWorkerDeployment`.
message
request_response.proto:2809Returns the Current Deployment of a deployment series. [cleanup-wv-pre-release] Pre-release deployment APIs, clean up later
string namespace = 1
string series_name = 2
message
request_response.proto:2814[cleanup-wv-pre-release] Pre-release deployment APIs, clean up later
optional current_deployment_info = 1
Returns the reachability level of a worker deployment to help users decide when it is time to decommission a deployment. Reachability level is calculated based on the deployment's `status` and existing workflows that depend on the given deployment for their execution. Calculating reachability is relatively expensive. Therefore, server might return a recently cached value. In such a case, the `last_update_time` will inform you about the actual reachability calculation time. Experimental. This API might significantly change or be removed in a future release. Deprecated. Replaced with `DrainageInfo` returned by `DescribeWorkerDeploymentVersion`.
message
request_response.proto:2819[cleanup-wv-pre-release] Pre-release deployment APIs, clean up later
string namespace = 1
optional deployment = 2
message
request_response.proto:2825[cleanup-wv-pre-release] Pre-release deployment APIs, clean up later
optional deployment_info = 1
enums.v1.DeploymentReachability reachability = 2
optional last_update_time = 3
Reachability level might come from server cache. This timestamp specifies when the value was actually calculated.
rpc GetSearchAttributes (, )
service.proto:622GetSearchAttributes is a visibility API to get all legal keys that could be used in list APIs (-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: We do not expose this search attribute API to HTTP (but may expose on OperatorService). --)
message
request_response.proto:1068(message has no fields)
message
request_response.proto:1071map<string, enums.v1.IndexedValueType> keys = 1
rpc GetSystemInfo (, )
service.proto:734GetSystemInfo returns information about the system.
message
request_response.proto:1287(message has no fields)
message
request_response.proto:1290string server_version = 1
Version of the server.
optional capabilities = 2
All capabilities the system supports.
Deprecated. Use `GetWorkerVersioningRules`. Will be removed in server version v1.32.0. Fetches the worker build id versioning sets for a task queue.
message
request_response.proto:1587[cleanup-wv-pre-release]
string namespace = 1
string task_queue = 2
Must be set, the task queue to interrogate about worker id compatibility.
int32 max_sets = 3
Limits how many compatible sets will be returned. Specify 1 to only return the current default major version set. 0 returns all sets.
message
request_response.proto:1596[cleanup-wv-pre-release]
repeated major_version_sets = 1
Major version sets, in order from oldest to newest. The last element of the list will always be the current default major version. IE: New workflows will target the most recent version in that version set. There may be fewer sets returned than exist, if the request chose to limit this response.
Deprecated. Use `DescribeTaskQueue`. Will be removed in server version v1.32.0. Fetches task reachability to determine whether a worker may be retired. The request may specify task queues to query for or let the server fetch all task queues mapped to the given build IDs. When requesting a large number of task queues or all task queues associated with the given build ids in a namespace, all task queues will be listed in the response but some of them may not contain reachability information due to a server enforced limit. When reaching the limit, task queues that reachability information could not be retrieved for will be marked with a single TASK_REACHABILITY_UNSPECIFIED entry. The caller may issue another call to get the reachability for those task queues. Open source users can adjust this limit by setting the server's dynamic config value for `limit.reachabilityTaskQueueScan` with the caveat that this call can strain the visibility store.
message
request_response.proto:1731[cleanup-wv-pre-release] Deprecated. Use `DescribeTaskQueue`.
string namespace = 1
repeated string build_ids = 2
Build ids to retrieve reachability for. An empty string will be interpreted as an unversioned worker. The number of build ids that can be queried in a single API call is limited. Open source users can adjust this limit by setting the server's dynamic config value for `limit.reachabilityQueryBuildIds` with the caveat that this call can strain the visibility store.
repeated string task_queues = 3
Task queues to retrieve reachability for. Leave this empty to query for all task queues associated with given build ids in the namespace. Must specify at least one task queue if querying for an unversioned worker. The number of task queues that the server will fetch reachability information for is limited. See the `GetWorkerTaskReachabilityResponse` documentation for more information.
enums.v1.TaskReachability reachability = 4
Type of reachability to query for. `TASK_REACHABILITY_NEW_WORKFLOWS` is always returned in the response. Use `TASK_REACHABILITY_EXISTING_WORKFLOWS` if your application needs to respond to queries on closed workflows. Otherwise, use `TASK_REACHABILITY_OPEN_WORKFLOWS`. Default is `TASK_REACHABILITY_EXISTING_WORKFLOWS` if left unspecified. See the TaskReachability docstring for information about each enum variant.
message
request_response.proto:1757[cleanup-wv-pre-release] Deprecated. Use `DescribeTaskQueue`.
repeated build_id_reachability = 1
Task reachability, broken down by build id and then task queue. When requesting a large number of task queues or all task queues associated with the given build ids in a namespace, all task queues will be listed in the response but some of them may not contain reachability information due to a server enforced limit. When reaching the limit, task queues that reachability information could not be retrieved for will be marked with a single TASK_REACHABILITY_UNSPECIFIED entry. The caller may issue another call to get the reachability for those task queues. Open source users can adjust this limit by setting the server's dynamic config value for `limit.reachabilityTaskQueueScan` with the caveat that this call can strain the visibility store.
Fetches the Build ID assignment and redirect rules for a Task Queue. Will be removed in server version v1.32.0.
message
request_response.proto:1713[cleanup-wv-pre-release]
string namespace = 1
string task_queue = 2
message
request_response.proto:1719[cleanup-wv-pre-release]
repeated assignment_rules = 1
repeated compatible_redirect_rules = 2
bytes conflict_token = 3
This value can be passed back to UpdateWorkerVersioningRulesRequest to ensure that the rules were not modified between this List and the Update, which could lead to lost updates and other confusion.
GetWorkflowExecutionHistory returns the history of specified workflow execution. Fails with `NotFound` if the specified workflow execution is unknown to the service.
message
request_response.proto:232string namespace = 1
optional execution = 2
int32 maximum_page_size = 3
bytes next_page_token = 4
If a `GetWorkflowExecutionHistoryResponse` or a `PollWorkflowTaskQueueResponse` had one of these, it should be passed here to fetch the next page.
bool wait_new_event = 5
If set to true, the RPC call will not resolve until there is a new event which matches the `history_event_filter_type`, or a timeout is hit.
enums.v1.HistoryEventFilterType history_event_filter_type = 6
Filter returned events such that they match the specified filter type. Default: HISTORY_EVENT_FILTER_TYPE_ALL_EVENT.
bool skip_archival = 7
message
request_response.proto:248optional history = 1
repeated raw_history = 2
Raw history is an alternate representation of history that may be returned if configured on the frontend. This is not supported by all SDKs. Either this or `history` will be set.
bytes next_page_token = 3
Will be set if there are more history events than were included in this response
bool archived = 4
GetWorkflowExecutionHistoryReverse returns the history of specified workflow execution in reverse order (starting from last event). Fails with`NotFound` if the specified workflow execution is unknown to the service.
message
request_response.proto:258string namespace = 1
optional execution = 2
int32 maximum_page_size = 3
bytes next_page_token = 4
message
request_response.proto:265optional history = 1
bytes next_page_token = 3
Will be set if there are more history events than were included in this response
ListActivityExecutions is a visibility API to list activity executions in a specific namespace.
message
request_response.proto:3260string namespace = 1
int32 page_size = 2
Max number of executions to return per page.
bytes next_page_token = 3
Token returned in ListActivityExecutionsResponse.
string query = 4
Visibility query, see https://docs.temporal.io/list-filter for the syntax.
message
request_response.proto:3270repeated executions = 1
bytes next_page_token = 2
Token to use to fetch the next page. If empty, there is no next page.
ListArchivedWorkflowExecutions is a visibility API to list archived workflow executions in a specific namespace.
message
request_response.proto:1019string namespace = 1
int32 page_size = 2
bytes next_page_token = 3
string query = 4
message
request_response.proto:1026repeated executions = 1
bytes next_page_token = 2
ListBatchOperations returns a list of batch operations
message
request_response.proto:1902string namespace = 1
Namespace that contains the batch operation
int32 page_size = 2
List page size
bytes next_page_token = 3
Next page token
message
request_response.proto:1911repeated operation_info = 1
BatchOperationInfo contains the basic info about batch operation
bytes next_page_token = 2
ListClosedWorkflowExecutions is a visibility API to list the closed executions in a specific namespace. (-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: HTTP users should use ListWorkflowExecutions instead. --)
message
request_response.proto:990string namespace = 1
int32 maximum_page_size = 2
bytes next_page_token = 3
optional start_time_filter = 4
oneof filters
execution_filter = 5
type_filter = 6
status_filter = 7
message
request_response.proto:1002repeated executions = 1
bytes next_page_token = 2
rpc ListDeployments (, )
service.proto:986Lists worker deployments in the namespace. Optionally can filter based on deployment series name. Experimental. This API might significantly change or be removed in a future release. Deprecated. Replaced with `ListWorkerDeployments`.
message
request_response.proto:2449[cleanup-wv-pre-release] Pre-release deployment APIs, clean up later
string namespace = 1
int32 page_size = 2
bytes next_page_token = 3
string series_name = 4
Optional. Use to filter based on exact series name match.
message
request_response.proto:2458[cleanup-wv-pre-release] Pre-release deployment APIs, clean up later
bytes next_page_token = 1
repeated deployments = 2
rpc ListNamespaces (, )
service.proto:59ListNamespaces returns the information and configuration for all namespaces.
message
request_response.proto:75int32 page_size = 1
bytes next_page_token = 2
optional namespace_filter = 3
message
request_response.proto:81repeated namespaces = 1
bytes next_page_token = 2
ListNexusOperationExecutions is a visibility API to list Nexus operations in a specific namespace.
message
request_response.proto:3417string namespace = 1
int32 page_size = 2
Max number of operations to return per page.
bytes next_page_token = 3
Token returned in ListNexusOperationExecutionsResponse.
string query = 4
Visibility query, see https://docs.temporal.io/list-filter for the syntax. Search attributes that are avaialble for Nexus operations include: - OperationId - RunId - Endpoint - Service - Operation - RequestId - StartTime - ExecutionTime - CloseTime - ExecutionStatus - ExecutionDuration - StateTransitionCount
message
request_response.proto:3440repeated operations = 1
bytes next_page_token = 2
Token to use to fetch the next page. If empty, there is no next page.
ListOpenWorkflowExecutions is a visibility API to list the open executions in a specific namespace. (-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: HTTP users should use ListWorkflowExecutions instead. --)
message
request_response.proto:974string namespace = 1
int32 maximum_page_size = 2
bytes next_page_token = 3
optional start_time_filter = 4
oneof filters
execution_filter = 5
type_filter = 6
message
request_response.proto:985repeated executions = 1
bytes next_page_token = 2
Lists matching times within a range.
message
request_response.proto:1458string namespace = 1
The namespace of the schedule to query.
string schedule_id = 2
The id of the schedule to query.
optional start_time = 3
Time range to query.
optional end_time = 4
message
request_response.proto:1468repeated start_time = 1
rpc ListSchedules (, )
service.proto:843List all schedules in a namespace.
message
request_response.proto:1484string namespace = 1
The namespace to list schedules in.
int32 maximum_page_size = 2
How many to return at once.
bytes next_page_token = 3
Token to get the next page of results.
string query = 4
Query to filter schedules.
message
request_response.proto:1495repeated schedules = 1
bytes next_page_token = 2
(-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: We do not expose this low-level API to HTTP. --)
message
request_response.proto:1349string namespace = 1
optional task_queue = 2
message
request_response.proto:1354repeated activity_task_queue_partitions = 1
repeated workflow_task_queue_partitions = 2
Lists all Worker Deployments that are tracked in the Namespace. Experimental. This API might significantly change or be removed in a future release.
message
request_response.proto:2621string namespace = 1
int32 page_size = 2
bytes next_page_token = 3
message
request_response.proto:2627bytes next_page_token = 1
repeated worker_deployments = 2
The list of worker deployments.
rpc ListWorkers (, )
service.proto:1559ListWorkers is a visibility API to list worker status information in a specific namespace.
message
request_response.proto:2932string namespace = 1
int32 page_size = 2
bytes next_page_token = 3
string query = 4
`query` in ListWorkers is used to filter workers based on worker attributes. Supported attributes: * WorkerInstanceKey * WorkerIdentity * HostName * TaskQueue * DeploymentName * BuildId * SdkName * SdkVersion * StartTime * Status
bool include_system_workers = 5
When true, the response will include system workers that are created implicitly by the server and not by the user. By default, system workers are excluded.
message
request_response.proto:2956repeated workers_info = 1
Deprecated: Use workers instead. This field returns full WorkerInfo which includes expensive runtime metrics. We will stop populating this field in the future.
repeated workers = 3
Limited worker information.
bytes next_page_token = 2
Next page token
ListWorkflowExecutions is a visibility API to list workflow executions in a specific namespace.
message
request_response.proto:1007string namespace = 1
int32 page_size = 2
bytes next_page_token = 3
string query = 4
message
request_response.proto:1014repeated executions = 1
bytes next_page_token = 2
rpc ListWorkflowRules (, )
service.proto:1514Return all namespace workflow rules
message
request_response.proto:2883string namespace = 1
bytes next_page_token = 2
message
request_response.proto:2888repeated rules = 1
bytes next_page_token = 2
rpc PatchSchedule (, )
service.proto:799Makes a specific change to a schedule or triggers an immediate action.
message
request_response.proto:1443string namespace = 1
The namespace of the schedule to patch.
string schedule_id = 2
The id of the schedule to patch.
optional patch = 3
string identity = 4
The identity of the client who initiated this request.
string request_id = 5
A unique identifier for this update request for idempotence. Typically UUIDv4.
message
request_response.proto:1455(message has no fields)
rpc PauseActivity (, )
service.proto:1397PauseActivity pauses the execution of an activity specified by its ID or type. If there are multiple pending activities of the provided type - all of them will be paused Pausing an activity means: - If the activity is currently waiting for a retry or is running and subsequently fails, it will not be rescheduled until it is unpaused. - If the activity is already paused, calling this method will have no effect. - If the activity is running and finishes successfully, the activity will be completed. - If the activity is running and finishes with failure: * if there is no retry left - the activity will be completed. * if there are more retries left - the activity will be paused. For long-running activities: - activities in paused state will send a cancellation with "activity_paused" set to 'true' in response to 'RecordActivityTaskHeartbeat'. - The activity should respond to the cancellation accordingly. Returns a `NotFound` error if there is no pending activity with the provided ID or type This API will be deprecated soon and replaced with a newer PauseActivityExecution that is better named and structured to work well for standalone activities.
message
request_response.proto:2159Deprecated. Use `PauseActivityExecutionRequest`.
string namespace = 1
Namespace of the workflow which scheduled this activity.
optional execution = 2
Execution info of the workflow which scheduled this activity
string identity = 3
The identity of the client who initiated this request.
oneof activity
either activity id or activity type must be provided
string id = 4
Only the activity with this ID will be paused.
string type = 5
Pause all running activities of this type. Note: Experimental - the behavior of pause by activity type might change in a future release.
string reason = 6
Reason to pause the activity.
string request_id = 7
Used to de-dupe pause requests.
message
request_response.proto:2211Deprecated. Use `PauseActivityExecutionResponse`.
(message has no fields)
PauseActivityExecution pauses the execution of an activity specified by its ID. This API can be used to target a workflow activity or a standalone activity Pausing an activity means: - If the activity is currently waiting for a retry or is running and subsequently fails, it will not be rescheduled until it is unpaused. - If the activity is already paused, calling this method will have no effect. - If the activity is running and finishes successfully, the activity will be completed. - If the activity is running and finishes with failure: * if there is no retry left - the activity will be completed. * if there are more retries left - the activity will be paused. For long-running activities: - activities in paused state will send a cancellation with "activity_paused" set to 'true' in response to 'RecordActivityTaskHeartbeat'. Returns a `NotFound` error if there is no pending activity with the provided ID
message
request_response.proto:2185string namespace = 1
Namespace of the workflow which scheduled this activity.
string workflow_id = 2
If provided, pause a workflow activity (or activities) for the given workflow ID. If empty, targets a standalone activity.
string activity_id = 3
The ID of the activity to target.
string run_id = 4
Run ID of the workflow or standalone activity.
string identity = 5
The identity of the client who initiated this request.
string reason = 6
Reason to pause the activity.
string resource_id = 7
Resource ID for routing. Contains "workflow:{workflow_id}" for workflow activities or "activity:{activity_id}" for standalone activities.
string request_id = 8
Used to de-dupe pause requests.
message
request_response.proto:2214(message has no fields)
Note: This is an experimental API and the behavior may change in a future release. PauseWorkflowExecution pauses the workflow execution specified in the request. Pausing a workflow execution results in - The workflow execution status changes to `PAUSED` and a new WORKFLOW_EXECUTION_PAUSED event is added to the history - No new workflow tasks or activity tasks are dispatched. - Any workflow task currently executing on the worker will be allowed to complete. - Any activity task currently executing will be paused. - All server-side events will continue to be processed by the server. - Queries & Updates on a paused workflow will be rejected.
message
request_response.proto:3085Request to pause a workflow execution.
string namespace = 1
Namespace of the workflow to pause.
string workflow_id = 2
ID of the workflow execution to be paused. Required.
string run_id = 3
Run ID of the workflow execution to be paused. Optional. If not provided, the current run of the workflow will be paused.
string identity = 4
The identity of the client who initiated this request.
string reason = 5
Reason to pause the workflow execution.
string request_id = 6
A unique identifier for this pause request for idempotence. Typically UUIDv4.
message
request_response.proto:3101Response to a successful PauseWorkflowExecution request.
(message has no fields)
PollActivityExecution long-polls for an activity execution to complete and returns the outcome (result or failure).
message
request_response.proto:3246string namespace = 1
string activity_id = 2
string run_id = 3
Activity run ID. If empty the request targets the latest run.
message
request_response.proto:3253string run_id = 1
The run ID of the activity, useful when run_id was not specified in the request.
optional outcome = 2
PollActivityTaskQueue is called by workers to process activity tasks from a specific task queue. The worker is expected to call one of the `RespondActivityTaskXXX` methods when it is done processing the task. An activity task is dispatched whenever a `SCHEDULE_ACTIVITY_TASK` command is produced during workflow execution. An in memory `ACTIVITY_TASK_STARTED` event is written to mutable state before the task is dispatched to the worker. The started event, and the final event (`ACTIVITY_TASK_COMPLETED` / `ACTIVITY_TASK_FAILED` / `ACTIVITY_TASK_TIMED_OUT`) will both be written permanently to Workflow execution history when Activity is finished. This is done to avoid writing many events in the case of a failure/retry loop. (-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: We do not expose worker API to HTTP. --)
message
request_response.proto:484string namespace = 1
optional task_queue = 2
string poller_group_id = 10
Unless this is the first poll, the client must pass one of the poller group IDs received in `poller_group_infos` of the last the PollActivityTaskQueueResponse according to the instructions. If not set, the poll is routed randomly which can cause it to be blocked without receiving a task while the queue actually has tasks in another server location.
string identity = 3
The identity of the worker/client
string worker_instance_key = 8
A unique key for this worker instance, used for tracking worker lifecycle. This is guaranteed to be unique, whereas identity is not guaranteed to be unique.
string worker_control_task_queue = 9
A dedicated per-worker Nexus task queue on which the server sends control tasks (e.g. activity cancellation) to this specific worker instance.
optional task_queue_metadata = 4
optional worker_version_capabilities = 5
Information about this worker's build identifier and if it is choosing to use the versioning feature. See the `WorkerVersionCapabilities` docstring for more. Deprecated. Replaced by deployment_options.
optional deployment_options = 6
Worker deployment options that user has set in the worker.
PollNexusOperationExecution long-polls for a Nexus operation for a given wait stage to complete and returns the outcome (result or failure).
message
request_response.proto:3388string namespace = 1
string operation_id = 2
string run_id = 3
Operation run ID. If empty the request targets the latest run.
enums.v1.NexusOperationWaitStage wait_stage = 4
Stage to wait for. The operation may be in a more advanced stage when the poll is unblocked.
message
request_response.proto:3398string run_id = 1
The run ID of the operation, useful when run_id was not specified in the request.
enums.v1.NexusOperationWaitStage wait_stage = 2
The current stage of the operation. May be more advanced than the stage requested in the poll.
string operation_token = 3
Operation token. Only populated for asynchronous operations after a successful StartOperation call.
oneof outcome
The operation outcome, available if the operation is in a closed state.
result = 4
The result if the operation completed successfully.
failure = 5
The failure if the operation completed unsuccessfully.
rpc PollNexusTaskQueue (, )
service.proto:1317PollNexusTaskQueue is a long poll call used by workers to receive Nexus tasks. (-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: We do not expose worker API to HTTP. --)
message
request_response.proto:1952string namespace = 1
optional task_queue = 3
string poller_group_id = 9
Unless this is the first poll, the client must pass one of the poller group IDs received in `poller_group_infos` of the last the PollNexusTaskQueueResponse according to the instructions. If not set, the poll is routed randomly which can cause it to be blocked without receiving a task while the queue actually has tasks in another server location.
string identity = 2
The identity of the client who initiated this request.
string worker_instance_key = 8
A unique key for this worker instance, used for tracking worker lifecycle. This is guaranteed to be unique, whereas identity is not guaranteed to be unique.
optional worker_version_capabilities = 4
Information about this worker's build identifier and if it is choosing to use the versioning feature. See the `WorkerVersionCapabilities` docstring for more. Deprecated. Replaced by deployment_options.
optional deployment_options = 6
Worker deployment options that user has set in the worker.
repeated worker_heartbeat = 7
Worker info to be sent to the server.
message
request_response.proto:1976bytes task_token = 1
An opaque unique identifier for this task for correlating a completion request the embedded request.
optional request = 2
Embedded request as translated from the incoming frontend request.
optional poller_scaling_decision = 3
Server-advised information the SDK may use to adjust its poller count.
string poller_group_id = 4
This poller group ID identifies the owner of the nexus task awaiting for synchronous response. Corresponding `RespondNexusTaskCompleted` and `RespondNexusTaskFailed` calls should pass this value for proper response routing.
repeated poller_group_infos = 5
The weighted list of poller groups IDs that client should use for future polls to this task queue. Client is expected to: 1. Maintain minimum number of pollers no less than the number of groups. 2. Try to assign the next poll to a group without any pending polls, 3. If every group has some pending polls, assign the next poll to a group randomly according to the weights.
Polls a Workflow Execution for the outcome of a Workflow Update previously issued through the UpdateWorkflowExecution RPC. The effective timeout on this call will be shorter of the the caller-supplied gRPC timeout and the server's configured long-poll timeout. (-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: We don't expose update polling API to HTTP in favor of a potential future non-blocking form. --)
message
request_response.proto:1917string namespace = 1
The namespace of the Workflow Execution to which the Update was originally issued.
optional update_ref = 2
The Update reference returned in the initial UpdateWorkflowExecutionResponse.
string identity = 3
The identity of the worker/client who is polling this Update outcome.
optional wait_policy = 4
Specifies client's intent to wait for Update results. Omit to request a non-blocking poll.
message
request_response.proto:1930optional outcome = 1
The outcome of the update if and only if the update has completed. If this response is being returned before the update has completed (e.g. due to the specification of a wait policy that only waits on UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ACCEPTED) then this field will not be set.
enums.v1.UpdateWorkflowExecutionLifecycleStage stage = 2
The most advanced lifecycle stage that the Update is known to have reached, where lifecycle stages are ordered UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_UNSPECIFIED < UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ADMITTED < UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ACCEPTED < UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_COMPLETED. UNSPECIFIED will be returned if and only if the server's maximum wait time was reached before the Update reached the stage specified in the request WaitPolicy, and before the context deadline expired; clients may may then retry the call as needed.
optional update_ref = 3
Sufficient information to address this Update.
PollWorkflowTaskQueue is called by workers to make progress on workflows. A WorkflowTask is dispatched to callers for active workflow executions with pending workflow tasks. The worker is expected to call `RespondWorkflowTaskCompleted` when it is done processing the task. The service will create a `WorkflowTaskStarted` event in the history for this task before handing it to the worker. (-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: We do not expose worker API to HTTP. --)
message
request_response.proto:271string namespace = 1
optional task_queue = 2
string poller_group_id = 10
Unless this is the first poll, the client must pass one of the poller group IDs received in `poller_group_infos` of the last the PollWorkflowTaskQueueResponse according to the instructions. If not set, the poll is routed randomly which can cause it to be blocked without receiving a task while the queue actually has tasks in another server location.
string identity = 3
The identity of the worker/client who is polling this task queue
string worker_instance_key = 8
A unique key for this worker instance, used for tracking worker lifecycle. This is guaranteed to be unique, whereas identity is not guaranteed to be unique.
string worker_control_task_queue = 9
A dedicated per-worker Nexus task queue on which the server sends control tasks (e.g. activity cancellation) to this specific worker instance.
string binary_checksum = 4
Deprecated. Use deployment_options instead. Each worker process should provide an ID unique to the specific set of code it is running "checksum" in this field name isn't very accurate, it should be though of as an id.
optional worker_version_capabilities = 5
Deprecated. Use deployment_options instead. Information about this worker's build identifier and if it is choosing to use the versioning feature. See the `WorkerVersionCapabilities` docstring for more.
optional deployment_options = 6
Worker deployment options that user has set in the worker.
rpc QueryWorkflow (, )
service.proto:677QueryWorkflow requests a query be executed for a specified workflow execution.
message
request_response.proto:1140string namespace = 1
optional execution = 2
optional query = 3
enums.v1.QueryRejectCondition query_reject_condition = 4
QueryRejectCondition can used to reject the query if workflow state does not satisfy condition. Default: QUERY_REJECT_CONDITION_NONE.
message
request_response.proto:1149optional query_result = 1
optional query_rejected = 2
RecordActivityTaskHeartbeat is optionally called by workers while they execute activities. If a worker fails to heartbeat within the `heartbeat_timeout` interval for the activity task, then the current attempt times out. Depending on RetryPolicy, this may trigger a retry or time out the activity. For workflow activities, an `ACTIVITY_TASK_TIMED_OUT` event will be written to the workflow history. Calling `RecordActivityTaskHeartbeat` will fail with `NotFound` in such situations, in that event, the SDK should request cancellation of the activity. The request may contain response `details` which will be persisted by the server and may be used by the activity to checkpoint progress. The `cancel_requested` field in the response indicates whether cancellation has been requested for the activity.
message
request_response.proto:579bytes task_token = 1
The task token as received in `PollActivityTaskQueueResponse`
optional details = 2
Arbitrary data, of which the most recent call is kept, to store for this activity
string identity = 3
The identity of the worker/client
string namespace = 4
string resource_id = 5
Resource ID for routing. Contains the workflow ID or activity ID for standalone activities.
message
request_response.proto:591bool cancel_requested = 1
Will be set to true if the activity has been asked to cancel itself. The SDK should then notify the activity of cancellation if it is still running.
bool activity_paused = 2
Will be set to true if the activity is paused.
bool activity_reset = 3
Will be set to true if the activity was reset. Applies only to the current run.
See `RecordActivityTaskHeartbeat`. This version allows clients to record heartbeats by namespace/workflow id/activity id instead of task token. (-- api-linter: core::0136::prepositions=disabled aip.dev/not-precedent: "By" is used to indicate request type. --)
message
request_response.proto:604string namespace = 1
Namespace of the workflow which scheduled this activity
string workflow_id = 2
Id of the workflow which scheduled this activity, leave empty to target a standalone activity
string run_id = 3
For a workflow activity - the run ID of the workflow which scheduled this activity. For a standalone activity - the run ID of the activity.
string activity_id = 4
Id of the activity we're heartbeating
optional details = 5
Arbitrary data, of which the most recent call is kept, to store for this activity
string identity = 6
The identity of the worker/client
string resource_id = 7
Resource ID for routing. Contains "workflow:workflow_id" or "activity:activity_id" for standalone activities.
message
request_response.proto:622bool cancel_requested = 1
Will be set to true if the activity has been asked to cancel itself. The SDK should then notify the activity of cancellation if it is still running.
bool activity_paused = 2
Will be set to true if the activity is paused.
bool activity_reset = 3
Will be set to true if the activity was reset. Applies only to the current run.
WorkerHeartbeat receive heartbeat request from the worker.
message
request_response.proto:2915string namespace = 1
Namespace this worker belongs to.
string identity = 2
The identity of the client who initiated this request.
repeated worker_heartbeat = 3
string resource_id = 4
Resource ID for routing. Contains the worker grouping key.
message
request_response.proto:2928(message has no fields)
rpc RegisterNamespace (, )
service.proto:37RegisterNamespace creates a new namespace which can be used as a container for all resources. A Namespace is a top level entity within Temporal, and is used as a container for resources like workflow executions, task queues, etc. A Namespace acts as a sandbox and provides isolation for all resources within the namespace. All resources belongs to exactly one namespace.
message
request_response.proto:53string namespace = 1
string description = 2
string owner_email = 3
optional workflow_execution_retention_period = 4
repeated clusters = 5
string active_cluster_name = 6
map<string, string> data = 7
A key-value map for any customized purpose.
string security_token = 8
bool is_global_namespace = 9
enums.v1.ArchivalState history_archival_state = 10
If unspecified (ARCHIVAL_STATE_UNSPECIFIED) then default server configuration is used.
string history_archival_uri = 11
enums.v1.ArchivalState visibility_archival_state = 12
If unspecified (ARCHIVAL_STATE_UNSPECIFIED) then default server configuration is used.
string visibility_archival_uri = 13
message
request_response.proto:72(message has no fields)
RequestCancelActivityExecution requests cancellation of an activity execution. Cancellation is cooperative: this call records the request, but the activity must detect and acknowledge it for the activity to reach CANCELED status. The cancellation signal is delivered via `cancel_requested` in the heartbeat response; SDKs surface this via language-idiomatic mechanisms (context cancellation, exceptions, abort signals).
message
request_response.proto:3495string namespace = 1
string activity_id = 2
string run_id = 3
Activity run ID, targets the latest run if run_id is empty.
string identity = 4
The identity of the worker/client.
string request_id = 5
Used to de-dupe cancellation requests.
string reason = 6
Reason for requesting the cancellation, recorded and available via the PollActivityExecution API. Not propagated to a worker if an activity attempt is currently running.
message
request_response.proto:3509(message has no fields)
RequestCancelNexusOperationExecution requests cancellation of a Nexus operation. Requesting to cancel an operation does not automatically transition the operation to canceled status. The operation will only transition to canceled status if it supports cancellation and the handler processes the cancellation request.
message
request_response.proto:3538string namespace = 1
string operation_id = 2
string run_id = 3
Operation run ID, targets the latest run if empty.
string identity = 4
The identity of the client who initiated this request.
string request_id = 5
Used to de-dupe cancellation requests.
string reason = 6
Reason for requesting the cancellation, recorded and available via the DescribeNexusOperationExecution API.
message
request_response.proto:3551(message has no fields)
RequestCancelWorkflowExecution is called by workers when they want to request cancellation of a workflow execution. This results in a new `WORKFLOW_EXECUTION_CANCEL_REQUESTED` event being written to the workflow history and a new workflow task created for the workflow. It returns success if the requested workflow is already closed. It fails with 'NotFound' if the requested workflow doesn't exist.
message
request_response.proto:788string namespace = 1
optional workflow_execution = 2
string identity = 3
The identity of the worker/client
string request_id = 4
Used to de-dupe cancellation requests
string first_execution_run_id = 5
If set, this call will error if the most recent (if no run id is set on `workflow_execution`), or specified (if it is) workflow execution is not part of the same execution chain as this id.
string reason = 6
Reason for requesting the cancellation
repeated links = 7
Links to be associated with the WorkflowExecutionCanceled event.
message
request_response.proto:805(message has no fields)
rpc ResetActivity (, )
service.proto:1461ResetActivity resets the execution of an activity specified by its ID or type. If there are multiple pending activities of the provided type - all of them will be reset. Resetting an activity means: * number of attempts will be reset to 0. * activity timeouts will be reset. * if the activity is waiting for retry, and it is not paused or 'keep_paused' is not provided: it will be scheduled immediately (* see 'jitter' flag), Flags: 'jitter': the activity will be scheduled at a random time within the jitter duration. If the activity currently paused it will be unpaused, unless 'keep_paused' flag is provided. 'reset_heartbeats': the activity heartbeat timer and heartbeats will be reset. 'keep_paused': if the activity is paused, it will remain paused. Returns a `NotFound` error if there is no pending activity with the provided ID or type. This API will be deprecated soon and replaced with a newer ResetActivityExecution that is better named and structured to work well for standalone activities.
message
request_response.proto:2287NOTE: keep in sync with temporal.api.batch.v1.BatchOperationResetActivities Deprecated. Use `ResetActivityExecutionRequest`.
string namespace = 1
Namespace of the workflow which scheduled this activity.
optional execution = 2
Execution info of the workflow which scheduled this activity
string identity = 3
The identity of the client who initiated this request.
oneof activity
either activity id, activity type or update_all must be provided
string id = 4
Only activity with this ID will be reset.
string type = 5
Reset all running activities with of this type.
bool match_all = 10
Reset all running activities.
bool reset_heartbeat = 6
Indicates that activity should reset heartbeat details. This flag will be applied only to the new instance of the activity.
bool keep_paused = 7
If activity is paused, it will remain paused after reset
optional jitter = 8
If set, and activity is in backoff, the activity will start at a random time within the specified jitter duration. (unless it is paused and keep_paused is set)
bool restore_original_options = 9
If set, the activity options will be restored to the defaults. Default options are then options activity was created with. They are part of the first schedule event.
message
request_response.proto:2359Deprecated. Use `ResetActivityExecutionRequest`.
(message has no fields)
ResetActivityExecution resets the execution of an activity specified by its ID. This API can be used to target a workflow activity or a standalone activity. Resetting an activity means: * number of attempts will be reset to 0. * activity timeouts will be reset. * if the activity is waiting for retry, and it is not paused or 'keep_paused' is not provided: it will be scheduled immediately (* see 'jitter' flag) Returns a `NotFound` error if there is no pending activity with the provided ID or type.
message
request_response.proto:2323string namespace = 1
Namespace of the workflow which scheduled this activity.
string workflow_id = 2
If provided, targets a workflow activity for the given workflow ID. If empty, targets a standalone activity.
string activity_id = 3
The ID of the activity to target.
string run_id = 4
Run ID of the workflow or standalone activity.
string identity = 5
The identity of the client who initiated this request.
bool reset_heartbeat = 6
Indicates that activity should reset heartbeat details. This flag will be applied only to the new instance of the activity.
bool keep_paused = 7
If activity is paused, it will remain paused after reset
optional jitter = 8
If set, and activity is in backoff, the activity will start at a random time within the specified jitter duration. (unless it is paused and keep_paused is set)
bool restore_original_options = 9
If set, the activity options will be restored to the defaults. Default options are then options activity was created with. They are part of the first schedule event.
string resource_id = 10
Resource ID for routing. Contains "workflow:{workflow_id}" for workflow activities or "activity:{activity_id}" for standalone activities.
message
request_response.proto:2362(message has no fields)
ResetStickyTaskQueue resets the sticky task queue related information in the mutable state of a given workflow. This is prudent for workers to perform if a workflow has been paged out of their cache. Things cleared are: 1. StickyTaskQueue 2. StickyScheduleToStartTimeout When possible, ShutdownWorker should be preferred over ResetStickyTaskQueue (particularly when a worker is shutting down or cycling). (-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: We do not expose worker API to HTTP. --)
message
request_response.proto:1107string namespace = 1
optional execution = 2
message
request_response.proto:1112(message has no fields)
ResetWorkflowExecution will reset an existing workflow execution to a specified `WORKFLOW_TASK_COMPLETED` event (exclusive). It will immediately terminate the current execution instance. "Exclusive" means the identified completed event itself is not replayed in the reset history; the preceding `WORKFLOW_TASK_STARTED` event remains and will be marked as failed immediately, and a new workflow task will be scheduled to retry it.
message
request_response.proto:916string namespace = 1
optional workflow_execution = 2
The workflow to reset. If this contains a run ID then the workflow will be reset back to the provided event ID in that run. Otherwise it will be reset to the provided event ID in the current run. In all cases the current run will be terminated and a new run started.
string reason = 3
int64 workflow_task_finish_event_id = 4
The id of a `WORKFLOW_TASK_COMPLETED`,`WORKFLOW_TASK_TIMED_OUT`, `WORKFLOW_TASK_FAILED`, or `WORKFLOW_TASK_STARTED` event to reset to.
string request_id = 5
Used to de-dupe reset requests
enums.v1.ResetReapplyType reset_reapply_type = 6
Deprecated. Use `options`. Default: RESET_REAPPLY_TYPE_SIGNAL
repeated enums.v1.ResetReapplyExcludeType reset_reapply_exclude_types = 7
Event types not to be reapplied
repeated post_reset_operations = 8
Operations to perform after the workflow has been reset. These operations will be applied to the *new* run of the workflow execution in the order they are provided. All operations are applied to the workflow before the first new workflow task is generated
string identity = 9
The identity of the worker/client
message
request_response.proto:941string run_id = 1
RespondActivityTaskFailed is called by workers when processing an activity task fails. For workflow activities, this results in a new `ACTIVITY_TASK_CANCELED` event being written to the workflow history and a new workflow task created for the workflow. Fails with `NotFound` if the task token is no longer valid due to activity timeout, already being completed, or never having existed.
message
request_response.proto:739bytes task_token = 1
The task token as received in `PollActivityTaskQueueResponse`
optional details = 2
Serialized additional information to attach to the cancellation
string identity = 3
The identity of the worker/client
string namespace = 4
string resource_id = 8
Resource ID for routing. Contains the workflow ID or activity ID for standalone activities.
optional worker_version = 5
Version info of the worker who processed this task. This message's `build_id` field should always be set by SDKs. Workers opting into versioning will also set the `use_versioning` field to true. See message docstrings for more. Deprecated. Use `deployment_options` instead.
optional deployment = 6
Deployment info of the worker that completed this task. Must be present if user has set `WorkerDeploymentOptions` regardless of versioning being enabled or not. Deprecated. Replaced with `deployment_options`.
optional deployment_options = 7
Worker deployment options that user has set in the worker.
message
request_response.proto:762(message has no fields)
See `RespondActivityTaskCanceled`. This version allows clients to record failures by namespace/workflow id/activity id instead of task token. (-- api-linter: core::0136::prepositions=disabled aip.dev/not-precedent: "By" is used to indicate request type. --)
message
request_response.proto:765string namespace = 1
Namespace of the workflow which scheduled this activity
string workflow_id = 2
Id of the workflow which scheduled this activity, leave empty to target a standalone activity
string run_id = 3
For a workflow activity - the run ID of the workflow which scheduled this activity. For a standalone activity - the run ID of the activity.
string activity_id = 4
Id of the activity to confirm is cancelled
optional details = 5
Serialized additional information to attach to the cancellation
string identity = 6
The identity of the worker/client
optional deployment_options = 7
Worker deployment options that user has set in the worker.
string resource_id = 8
Resource ID for routing. Contains "workflow:workflow_id" or "activity:activity_id" for standalone activities.
message
request_response.proto:785(message has no fields)
RespondActivityTaskCompleted is called by workers when they successfully complete an activity task. For workflow activities, this results in a new `ACTIVITY_TASK_COMPLETED` event being written to the workflow history and a new workflow task created for the workflow. Fails with `NotFound` if the task token is no longer valid due to activity timeout, already being completed, or never having existed.
message
request_response.proto:635bytes task_token = 1
The task token as received in `PollActivityTaskQueueResponse`
optional result = 2
The result of successfully executing the activity
string identity = 3
The identity of the worker/client
string namespace = 4
string resource_id = 8
Resource ID for routing. Contains the workflow ID or activity ID for standalone activities.
optional worker_version = 5
Version info of the worker who processed this task. This message's `build_id` field should always be set by SDKs. Workers opting into versioning will also set the `use_versioning` field to true. See message docstrings for more. Deprecated. Use `deployment_options` instead.
optional deployment = 6
Deployment info of the worker that completed this task. Must be present if user has set `WorkerDeploymentOptions` regardless of versioning being enabled or not. Deprecated. Replaced with `deployment_options`.
optional deployment_options = 7
Worker deployment options that user has set in the worker.
message
request_response.proto:658(message has no fields)
See `RespondActivityTaskCompleted`. This version allows clients to record completions by namespace/workflow id/activity id instead of task token. (-- api-linter: core::0136::prepositions=disabled aip.dev/not-precedent: "By" is used to indicate request type. --)
message
request_response.proto:661string namespace = 1
Namespace of the workflow which scheduled this activity
string workflow_id = 2
Id of the workflow which scheduled this activity, leave empty to target a standalone activity
string run_id = 3
For a workflow activity - the run ID of the workflow which scheduled this activity. For a standalone activity - the run ID of the activity.
string activity_id = 4
Id of the activity to complete
optional result = 5
The serialized result of activity execution
string identity = 6
The identity of the worker/client
string resource_id = 7
Resource ID for routing. Contains "workflow:workflow_id" or "activity:activity_id" for standalone activities.
message
request_response.proto:679(message has no fields)
RespondActivityTaskFailed is called by workers when processing an activity task fails. This results in a new `ACTIVITY_TASK_FAILED` event being written to the workflow history and a new workflow task created for the workflow. Fails with `NotFound` if the task token is no longer valid due to activity timeout, already being completed, or never having existed.
message
request_response.proto:682bytes task_token = 1
The task token as received in `PollActivityTaskQueueResponse`
optional failure = 2
Detailed failure information
string identity = 3
The identity of the worker/client
string namespace = 4
string resource_id = 9
Resource ID for routing. Contains the workflow ID or activity ID for standalone activities.
optional last_heartbeat_details = 5
Additional details to be stored as last activity heartbeat
optional worker_version = 6
Version info of the worker who processed this task. This message's `build_id` field should always be set by SDKs. Workers opting into versioning will also set the `use_versioning` field to true. See message docstrings for more. Deprecated. Use `deployment_options` instead.
optional deployment = 7
Deployment info of the worker that completed this task. Must be present if user has set `WorkerDeploymentOptions` regardless of versioning being enabled or not. Deprecated. Replaced with `deployment_options`.
optional deployment_options = 8
Worker deployment options that user has set in the worker.
message
request_response.proto:707repeated failures = 1
Server validation failures could include last_heartbeat_details payload is too large, request failure is too large
See `RecordActivityTaskFailed`. This version allows clients to record failures by namespace/workflow id/activity id instead of task token. (-- api-linter: core::0136::prepositions=disabled aip.dev/not-precedent: "By" is used to indicate request type. --)
message
request_response.proto:713string namespace = 1
Namespace of the workflow which scheduled this activity
string workflow_id = 2
Id of the workflow which scheduled this activity, leave empty to target a standalone activity
string run_id = 3
For a workflow activity - the run ID of the workflow which scheduled this activity. For a standalone activity - the run ID of the activity.
string activity_id = 4
Id of the activity to fail
optional failure = 5
Detailed failure information
string identity = 6
The identity of the worker/client
optional last_heartbeat_details = 7
Additional details to be stored as last activity heartbeat
string resource_id = 8
Resource ID for routing. Contains "workflow:workflow_id" or "activity:activity_id" for standalone activities.
message
request_response.proto:733repeated failures = 1
Server validation failures could include last_heartbeat_details payload is too large, request failure is too large
RespondNexusTaskCompleted is called by workers to respond to Nexus tasks received via PollNexusTaskQueue. (-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: We do not expose worker API to HTTP. --)
message
request_response.proto:1997string namespace = 1
string identity = 2
The identity of the client who initiated this request.
bytes task_token = 3
A unique identifier for this task as received via a poll response.
optional response = 4
Embedded response to be translated into a frontend response.
string poller_group_id = 5
Client must forward the poller_group_id received in PollNexusTaskQueueResponse for proper routing of the response.
message
request_response.proto:2010(message has no fields)
RespondNexusTaskFailed is called by workers to fail Nexus tasks received via PollNexusTaskQueue. (-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: We do not expose worker API to HTTP. --)
message
request_response.proto:2013string namespace = 1
string identity = 2
The identity of the client who initiated this request.
bytes task_token = 3
A unique identifier for this task.
optional error = 4
Deprecated. Use the failure field instead.
optional failure = 5
The error the handler failed with. Must contain a NexusHandlerFailureInfo object.
string poller_group_id = 6
Client must forward the poller_group_id received in PollNexusTaskQueueResponse for proper routing of the response.
message
request_response.proto:2028(message has no fields)
RespondQueryTaskCompleted is called by workers to complete queries which were delivered on the `query` (not `queries`) field of a `PollWorkflowTaskQueueResponse`. Completing the query will unblock the corresponding client call to `QueryWorkflow` and return the query result a response. (-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: We do not expose worker API to HTTP. --)
message
request_response.proto:1075bytes task_token = 1
enums.v1.QueryResultType completed_type = 2
optional query_result = 3
The result of the query. Mutually exclusive with `error_message` and `failure`. Set when the query succeeds.
string error_message = 4
A plain error message that must be set if completed_type is QUERY_RESULT_TYPE_FAILED. SDKs should also fill in the more complete `failure` field to provide the full context and support encryption of failure information. `error_message` will be duplicated if the `failure` field is present to support callers that pre-date the addition of that field, regardless of whether or not a custom failure converter is used. Mutually exclusive with `query_result`. Set when the query fails.
string namespace = 6
optional failure = 7
The full reason for this query failure. This field is newer than `error_message` and can be encoded by the SDK's failure converter to support E2E encryption of messages and stack traces. Mutually exclusive with `query_result`. Set when the query fails.
enums.v1.WorkflowTaskFailedCause cause = 8
Why did the task fail? It's important to note that many of the variants in this enum cannot apply to worker responses. See the type's doc for more.
string poller_group_id = 9
Client must forward the poller_group_id received in PollWorkflowTaskQueueResponse for proper routing of the response.
message
request_response.proto:1104(message has no fields)
RespondWorkflowTaskCompleted is called by workers to successfully complete workflow tasks they received from `PollWorkflowTaskQueue`. Completing a WorkflowTask will write a `WORKFLOW_TASK_COMPLETED` event to the workflow's history, along with events corresponding to whatever commands the SDK generated while executing the task (ex timer started, activity task scheduled, etc). (-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: We do not expose worker API to HTTP. --)
message
request_response.proto:369bytes task_token = 1
The task token as received in `PollWorkflowTaskQueueResponse`
repeated commands = 2
A list of commands generated when driving the workflow code in response to the new task
string identity = 3
The identity of the worker/client
optional sticky_attributes = 4
May be set by workers to indicate that the worker desires future tasks to be provided with incremental history on a sticky queue.
bool return_new_workflow_task = 5
If set, the worker wishes to immediately receive the next workflow task as a response to this completion. This can save on polling round-trips.
bool force_create_new_workflow_task = 6
Can be used to *force* creation of a new workflow task, even if no commands have resolved or one would not otherwise have been generated. This is used when the worker knows it is doing something useful, but cannot complete it within the workflow task timeout. Local activities which run for longer than the task timeout being the prime example.
string binary_checksum = 7
Deprecated. Use `deployment_options` instead. Worker process' unique binary id
map<string, > query_results = 8
Responses to the `queries` field in the task being responded to
string namespace = 9
string resource_id = 18
Resource ID for routing. Contains the workflow ID from the original task.
optional worker_version_stamp = 10
Version info of the worker who processed this task. This message's `build_id` field should always be set by SDKs. Workers opting into versioning will also set the `use_versioning` field to true. See message docstrings for more. Deprecated. Use `deployment_options` and `versioning_behavior` instead.
repeated messages = 11
Protocol messages piggybacking on a WFT as a transport
optional sdk_metadata = 12
Data the SDK wishes to record for itself, but server need not interpret, and does not directly impact workflow state.
optional metering_metadata = 13
Local usage data collected for metering
optional capabilities = 14
All capabilities the SDK supports.
optional deployment = 15
Deployment info of the worker that completed this task. Must be present if user has set `WorkerDeploymentOptions` regardless of versioning being enabled or not. Deprecated. Replaced with `deployment_options`.
enums.v1.VersioningBehavior versioning_behavior = 16
Versioning behavior of this workflow execution as set on the worker that completed this task. UNSPECIFIED means versioning is not enabled in the worker.
optional deployment_options = 17
Worker deployment options that user has set in the worker.
string worker_instance_key = 19
A unique key for this worker instance, used for tracking worker lifecycle. This is guaranteed to be unique, whereas identity is not guaranteed to be unique.
string worker_control_task_queue = 20
A dedicated per-worker Nexus task queue on which the server sends control tasks (e.g. activity cancellation) to this specific worker instance.
message
request_response.proto:439optional workflow_task = 1
See `RespondWorkflowTaskCompletedResponse::return_new_workflow_task`
repeated activity_tasks = 2
See `ScheduleActivityTaskCommandAttributes::request_eager_execution`
int64 reset_history_event_id = 3
If non zero, indicates the server has discarded the workflow task that was being responded to. Will be the event ID of the last workflow task started event in the history before the new workflow task. Server is only expected to discard a workflow task if it could not have modified the workflow state.
RespondWorkflowTaskFailed is called by workers to indicate the processing of a workflow task failed. This results in a `WORKFLOW_TASK_FAILED` event written to the history, and a new workflow task will be scheduled. This API can be used to report unhandled failures resulting from applying the workflow task. Temporal will only append first WorkflowTaskFailed event to the history of workflow execution for consecutive failures. (-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: We do not expose worker API to HTTP. --)
message
request_response.proto:450bytes task_token = 1
The task token as received in `PollWorkflowTaskQueueResponse`
enums.v1.WorkflowTaskFailedCause cause = 2
Why did the task fail? It's important to note that many of the variants in this enum cannot apply to worker responses. See the type's doc for more.
optional failure = 3
Failure details
string identity = 4
The identity of the worker/client
string binary_checksum = 5
Deprecated. Use `deployment_options` instead. Worker process' unique binary id
string namespace = 6
string resource_id = 11
Resource ID for routing. Contains the workflow ID from the original task.
repeated messages = 7
Protocol messages piggybacking on a WFT as a transport
optional worker_version = 8
Version info of the worker who processed this task. This message's `build_id` field should always be set by SDKs. Workers opting into versioning will also set the `use_versioning` field to true. See message docstrings for more. Deprecated. Use `deployment_options` instead.
optional deployment = 9
Deployment info of the worker that completed this task. Must be present if user has set `WorkerDeploymentOptions` regardless of versioning being enabled or not. Deprecated. Replaced with `deployment_options`.
optional deployment_options = 10
Worker deployment options that user has set in the worker.
message
request_response.proto:481(message has no fields)
ScanWorkflowExecutions _was_ a visibility API to list large amount of workflow executions in a specific namespace without order. It has since been deprecated in favor of `ListWorkflowExecutions` and rewritten to use `ListWorkflowExecutions` internally. Deprecated: Replaced with `ListWorkflowExecutions`. (-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: HTTP users should use ListWorkflowExecutions instead. --)
message
request_response.proto:1032Deprecated: Use with `ListWorkflowExecutions`.
string namespace = 1
int32 page_size = 2
bytes next_page_token = 3
string query = 4
message
request_response.proto:1040Deprecated: Use with `ListWorkflowExecutions`.
repeated executions = 1
bytes next_page_token = 2
Sets a deployment as the current deployment for its deployment series. Can optionally update the metadata of the deployment as well. Experimental. This API might significantly change or be removed in a future release. Deprecated. Replaced by `SetWorkerDeploymentCurrentVersion`.
message
request_response.proto:2464[cleanup-wv-pre-release] Pre-release deployment APIs, clean up later
string namespace = 1
optional deployment = 2
string identity = 3
Optional. The identity of the client who initiated this request.
optional update_metadata = 4
Optional. Use to add or remove user-defined metadata entries. Metadata entries are exposed when describing a deployment. It is a good place for information such as operator name, links to internal deployment pipelines, etc.
message
request_response.proto:2475[cleanup-wv-pre-release] Pre-release deployment APIs, clean up later
optional current_deployment_info = 1
optional previous_deployment_info = 2
Info of the deployment that was current before executing this operation.
Set/unset the Current Version of a Worker Deployment. Automatically unsets the Ramping Version if it is the Version being set as Current. Experimental. This API might significantly change or be removed in a future release.
message
request_response.proto:2482Set/unset the Current Version of a Worker Deployment.
string namespace = 1
string deployment_name = 2
string version = 3
Deprecated. Use `build_id`.
string build_id = 7
The build id of the Version that you want to set as Current. Pass an empty value to set the Current Version to nil. A nil Current Version represents all the unversioned workers (those with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)
bytes conflict_token = 4
Optional. This can be the value of conflict_token from a Describe, or another Worker Deployment API. Passing a non-nil conflict token will cause this request to fail if the Deployment's configuration has been modified between the API call that generated the token and this one.
string identity = 5
Optional. The identity of the client who initiated this request.
bool ignore_missing_task_queues = 6
Optional. By default this request would be rejected if not all the expected Task Queues are being polled by the new Version, to protect against accidental removal of Task Queues, or worker health issues. Pass `true` here to bypass this protection. The set of expected Task Queues is the set of all the Task Queues that were ever poller by the existing Current Version of the Deployment, with the following exclusions: - Task Queues that are not used anymore (inferred by having empty backlog and a task add_rate of 0.) - Task Queues that are moved to another Worker Deployment (inferred by the Task Queue having a different Current Version than the Current Version of this deployment.) WARNING: Do not set this flag unless you are sure that the missing task queue pollers are not needed. If the request is unexpectedly rejected due to missing pollers, then that means the pollers have not reached to the server yet. Only set this if you expect those pollers to never arrive.
bool allow_no_pollers = 9
Optional. By default this request will be rejected if no pollers have been seen for the proposed Current Version, in order to protect users from routing tasks to pollers that do not exist, leading to possible timeouts. Pass `true` here to bypass this protection.
message
request_response.proto:2520bytes conflict_token = 1
This value is returned so that it can be optionally passed to APIs that write to the Worker Deployment state to ensure that the state did not change between this API call and a future write.
string previous_version = 2
Deprecated. Use `previous_deployment_version`.
optional previous_deployment_version = 3
The version that was current before executing this operation. Deprecated in favor of idempotency of the API. Use `DescribeWorkerDeployment` to get the Current version info before calling this API. By passing the `conflict_token` got from the `DescribeWorkerDeployment` call to this API you can ensure there is no interfering changes between the two calls.
Set/unset the ManagerIdentity of a Worker Deployment. Experimental. This API might significantly change or be removed in a future release.
message
request_response.proto:2770Update the ManagerIdentity of a Worker Deployment.
string namespace = 1
string deployment_name = 2
oneof new_manager_identity
string manager_identity = 3
Arbitrary value for `manager_identity`. Empty will unset the field.
bool self = 4
True will set `manager_identity` to `identity`.
bytes conflict_token = 5
Optional. This can be the value of conflict_token from a Describe, or another Worker Deployment API. Passing a non-nil conflict token will cause this request to fail if the Deployment's configuration has been modified between the API call that generated the token and this one.
string identity = 6
Required. The identity of the client who initiated this request.
message
request_response.proto:2793bytes conflict_token = 1
This value is returned so that it can be optionally passed to APIs that write to the Worker Deployment state to ensure that the state did not change between this API call and a future write.
string previous_manager_identity = 2
What the `manager_identity` field was before this change. Deprecated in favor of idempotency of the API. Use `DescribeWorkerDeployment` to get the manager identity before calling this API. By passing the `conflict_token` got from the `DescribeWorkerDeployment` call to this API you can ensure there is no interfering changes between the two calls.
Set/unset the Ramping Version of a Worker Deployment and its ramp percentage. Can be used for gradual ramp to unversioned workers too. Experimental. This API might significantly change or be removed in a future release.
message
request_response.proto:2536Set/unset the Ramping Version of a Worker Deployment and its ramp percentage.
string namespace = 1
string deployment_name = 2
string version = 3
Deprecated. Use `build_id`.
string build_id = 8
The build id of the Version that you want to ramp traffic to. Pass an empty value to set the Ramping Version to nil. A nil Ramping Version represents all the unversioned workers (those with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)
float percentage = 4
Ramp percentage to set. Valid range: [0,100].
bytes conflict_token = 5
Optional. This can be the value of conflict_token from a Describe, or another Worker Deployment API. Passing a non-nil conflict token will cause this request to fail if the Deployment's configuration has been modified between the API call that generated the token and this one.
string identity = 6
Optional. The identity of the client who initiated this request.
bool ignore_missing_task_queues = 7
Optional. By default this request would be rejected if not all the expected Task Queues are being polled by the new Version, to protect against accidental removal of Task Queues, or worker health issues. Pass `true` here to bypass this protection. The set of expected Task Queues equals to all the Task Queues ever polled from the existing Current Version of the Deployment, with the following exclusions: - Task Queues that are not used anymore (inferred by having empty backlog and a task add_rate of 0.) - Task Queues that are moved to another Worker Deployment (inferred by the Task Queue having a different Current Version than the Current Version of this deployment.) WARNING: Do not set this flag unless you are sure that the missing task queue poller are not needed. If the request is unexpectedly rejected due to missing pollers, then that means the pollers have not reached to the server yet. Only set this if you expect those pollers to never arrive. Note: this check only happens when the ramping version is about to change, not every time that the percentage changes. Also note that the check is against the deployment's Current Version, not the previous Ramping Version.
bool allow_no_pollers = 10
Optional. By default this request will be rejected if no pollers have been seen for the proposed Current Version, in order to protect users from routing tasks to pollers that do not exist, leading to possible timeouts. Pass `true` here to bypass this protection.
message
request_response.proto:2580bytes conflict_token = 1
This value is returned so that it can be optionally passed to APIs that write to the Worker Deployment state to ensure that the state did not change between this API call and a future write.
string previous_version = 2
Deprecated. Use `previous_deployment_version`.
optional previous_deployment_version = 4
The version that was ramping before executing this operation. Deprecated in favor of idempotency of the API. Use `DescribeWorkerDeployment` to get the Ramping version info before calling this API. By passing the `conflict_token` got from the `DescribeWorkerDeployment` call to this API you can ensure there is no interfering changes between the two calls.
float previous_percentage = 3
The ramping version percentage before executing this operation. Deprecated in favor of idempotency of the API. Use `DescribeWorkerDeployment` to get the Ramping version info before calling this API. By passing the `conflict_token` got from the `DescribeWorkerDeployment` call to this API you can ensure there is no interfering changes between the two calls.
rpc ShutdownWorker (, )
service.proto:673ShutdownWorker is used to indicate that the given sticky task queue is no longer being polled by its worker. Following the completion of ShutdownWorker, newly-added workflow tasks will instead be placed in the normal task queue, eligible for any worker to pick up. ShutdownWorker should be called by workers while shutting down, after they've shut down their pollers. If another sticky poll request is issued, the sticky task queue will be revived. As of Temporal Server v1.25.0, ShutdownWorker hasn't yet been implemented. (-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: We do not expose worker API to HTTP. --)
message
request_response.proto:1115string namespace = 1
string sticky_task_queue = 2
sticky_task_queue may not always be populated. We want to ensure all workers send a shutdown request to update worker state for heartbeating, as well as cancel pending poll calls early, instead of waiting for timeouts.
string identity = 3
string reason = 4
optional worker_heartbeat = 5
string worker_instance_key = 6
Technically this is also sent in the WorkerHeartbeat, but since worker heartbeating can be turned off, this needs to be a separate, top-level field.
string task_queue = 7
Task queue name the worker is polling on. This allows server to cancel all outstanding poll RPC calls from SDK. This avoids a race condition that can lead to tasks being lost.
repeated enums.v1.TaskQueueType task_queue_types = 8
Task queue types that help server cancel outstanding poll RPC calls from SDK. This avoids a race condition that can lead to tasks being lost.
message
request_response.proto:1137(message has no fields)
SignalWithStartWorkflowExecution is used to ensure a signal is sent to a workflow, even if it isn't yet started. If the workflow is running, a `WORKFLOW_EXECUTION_SIGNALED` event is recorded in the history and a workflow task is generated. If the workflow is not running or not found, then the workflow is created with `WORKFLOW_EXECUTION_STARTED` and `WORKFLOW_EXECUTION_SIGNALED` events in its history, and a workflow task is generated. (-- api-linter: core::0136::prepositions=disabled aip.dev/not-precedent: "With" is used to indicate combined operation. --)
message
request_response.proto:840string namespace = 1
string workflow_id = 2
optional workflow_type = 3
optional task_queue = 4
The task queue to start this workflow on, if it will be started
optional input = 5
Serialized arguments to the workflow. These are passed as arguments to the workflow function.
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
string identity = 9
The identity of the worker/client
string request_id = 10
Used to de-dupe signal w/ start requests
enums.v1.WorkflowIdReusePolicy workflow_id_reuse_policy = 11
Defines whether to allow re-using the workflow id from a previously *closed* workflow. The default policy is WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE. See `workflow_id_reuse_policy` for handling a workflow id duplication with a *running* workflow.
enums.v1.WorkflowIdConflictPolicy workflow_id_conflict_policy = 22
Defines how to resolve a workflow id conflict with a *running* workflow. The default policy is WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING. Note that WORKFLOW_ID_CONFLICT_POLICY_FAIL is an invalid option. See `workflow_id_reuse_policy` for handling a workflow id duplication with a *closed* workflow.
string signal_name = 12
The workflow author-defined name of the signal to send to the workflow
optional signal_input = 13
Serialized value(s) to provide with the signal
string control = 14
Deprecated.
optional retry_policy = 15
Retry policy for the workflow
string cron_schedule = 16
See https://docs.temporal.io/docs/content/what-is-a-temporal-cron-job/
optional memo = 17
optional search_attributes = 18
optional header = 19
optional workflow_start_delay = 20
Time to wait before dispatching the first workflow task. Cannot be used with `cron_schedule`. Note that the signal will be delivered with the first workflow task. If the workflow gets another SignalWithStartWorkflow before the delay a workflow task will be dispatched immediately and the rest of the delay period will be ignored, even if that request also had a delay. Signal via SignalWorkflowExecution will not unblock the workflow.
optional user_metadata = 23
Metadata on the workflow if it is started. This is carried over to the WorkflowExecutionInfo for use by user interfaces to display the fixed as-of-start summary and details of the workflow.
repeated links = 24
Links to be associated with the WorkflowExecutionStarted and WorkflowExecutionSignaled events.
optional versioning_override = 25
If set, takes precedence over the Versioning Behavior sent by the SDK on Workflow Task completion. To unset the override after the workflow is running, use UpdateWorkflowExecutionOptions.
optional priority = 26
Priority metadata
optional time_skipping_config = 27
Time-skipping configuration. If not set, time skipping is disabled.
message
request_response.proto:905string run_id = 1
The run id of the workflow that was started - or just signaled, if it was already running.
bool started = 2
If true, a new workflow was started.
optional signal_link = 3
Link to be associated with the WorkflowExecutionSignaled event. Added on the response to propagate the backlink. Available from Temporal server 1.31 and up.
SignalWorkflowExecution is used to send a signal to a running workflow execution. This results in a `WORKFLOW_EXECUTION_SIGNALED` event recorded in the history and a workflow task being created for the execution.
message
request_response.proto:811Keep the parameters in sync with: - temporal.api.batch.v1.BatchOperationSignal. - temporal.api.workflow.v1.PostResetOperation.SignalWorkflow.
string namespace = 1
optional workflow_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 identity = 5
The identity of the worker/client
string request_id = 6
Used to de-dupe sent signals
string control = 7
Deprecated.
optional header = 8
Headers that are passed with the signal to the processing workflow. These can include things like auth or tracing tokens.
repeated links = 10
Links to be associated with the WorkflowExecutionSignaled event.
message
request_response.proto:833optional link = 1
Link to be associated with the WorkflowExecutionSignaled event. Added on the response to propagate the backlink. Available from Temporal server 1.31 and up.
StartActivityExecution starts a new activity execution. Returns an `ActivityExecutionAlreadyStarted` error if an instance already exists with same activity ID in this namespace unless permitted by the specified ID conflict policy.
message
request_response.proto:3121string namespace = 1
string identity = 2
The identity of the client who initiated this request
string request_id = 3
A unique identifier for this start request. Typically UUIDv4.
string activity_id = 4
Identifier for this activity. Required. This identifier should be meaningful in the user's own system. It must be unique among activities in the same namespace, subject to the rules imposed by id_reuse_policy and id_conflict_policy.
optional activity_type = 5
The type of the activity, a string that corresponds to a registered activity on a worker.
optional task_queue = 6
Task queue to schedule this activity on.
optional schedule_to_close_timeout = 7
Indicates how long the caller is willing to wait for an activity completion. Limits how long retries will be attempted. Either this or `start_to_close_timeout` must be specified. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)
optional schedule_to_start_timeout = 8
Limits time an activity task can stay in a task queue before a worker picks it up. 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` if not specified. (-- 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
The retry policy for the activity. Will never exceed `schedule_to_close_timeout`.
optional input = 12
Serialized arguments to the activity. These are passed as arguments to the activity function.
enums.v1.ActivityIdReusePolicy id_reuse_policy = 13
Defines whether to allow re-using the activity id from a previously *closed* activity. The default policy is ACTIVITY_ID_REUSE_POLICY_ALLOW_DUPLICATE.
enums.v1.ActivityIdConflictPolicy id_conflict_policy = 14
Defines how to resolve an activity id conflict with a *running* activity. The default policy is ACTIVITY_ID_CONFLICT_POLICY_FAIL.
optional search_attributes = 15
Search attributes for indexing.
optional header = 16
Header for context propagation and tracing purposes.
optional user_metadata = 17
Metadata for use by user interfaces to display the fixed as-of-start summary and details of the activity.
optional priority = 18
Priority metadata.
repeated completion_callbacks = 19
Callbacks to be called by the server when this activity reaches a terminal state. Callback addresses must be whitelisted in the server's dynamic configuration.
repeated links = 20
Links to be associated with the activity. Callbacks may also have associated links; links already included with a callback should not be duplicated here.
optional on_conflict_options = 21
Options for handling conflicts when using ACTIVITY_ID_CONFLICT_POLICY_USE_EXISTING.
optional start_delay = 22
Time to wait before dispatching the first activity task. This delay is not applied to retry attempts.
message
request_response.proto:3193string run_id = 1
The run ID of the activity that was started - or used (via ACTIVITY_ID_CONFLICT_POLICY_USE_EXISTING).
bool started = 2
If true, a new activity was started.
optional link = 3
Link to the started activity.
StartBatchOperation starts a new batch operation
message
request_response.proto:1821string namespace = 1
Namespace that contains the batch operation
string visibility_query = 2
Visibility query defines the the group of workflow to apply the batch operation This field and `executions` are mutually exclusive
string job_id = 3
Job ID defines the unique ID for the batch job
string reason = 4
Reason to perform the batch operation
repeated executions = 5
Executions to apply the batch operation This field and `visibility_query` are mutually exclusive
float max_operations_per_second = 6
Limit for the number of operations processed per second within this batch. Its purpose is to reduce the stress on the system caused by batch operations, which helps to prevent system overload and minimize potential delays in executing ongoing tasks for user workers. Note that when no explicit limit is provided, the server will operate according to its limit defined by the dynamic configuration key `worker.batcherRPS`. This also applies if the value in this field exceeds the server's configured limit.
oneof operation
Operation input
termination_operation = 10
signal_operation = 11
cancellation_operation = 12
deletion_operation = 13
reset_operation = 14
update_workflow_options_operation = 15
unpause_activities_operation = 16
reset_activities_operation = 17
update_activity_options_operation = 18
message
request_response.proto:1855(message has no fields)
StartNexusOperationExecution starts a new Nexus operation. Returns a `NexusOperationExecutionAlreadyStarted` error if an instance already exists with same operation ID in this namespace unless permitted by the specified ID conflict policy.
message
request_response.proto:3276string namespace = 1
string identity = 2
The identity of the client who initiated this request.
string request_id = 3
A unique identifier for this caller-side start request. Typically UUIDv4. StartOperation requests sent to the handler will use a server-generated request ID.
string operation_id = 4
Identifier for this operation. This is a caller-side ID, distinct from any internal operation identifiers generated by the handler. Must be unique among operations in the same namespace, subject to the rules imposed by id_reuse_policy and id_conflict_policy.
string endpoint = 5
Endpoint name, resolved to a URL via the cluster's endpoint registry.
string service = 6
Service name.
string operation = 7
Operation name.
optional schedule_to_close_timeout = 8
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. --)
optional schedule_to_start_timeout = 9
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 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. --)
optional start_to_close_timeout = 10
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. 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. --)
optional input = 11
Serialized input to the operation. Passed as the request payload.
enums.v1.NexusOperationIdReusePolicy id_reuse_policy = 12
Defines whether to allow re-using the operation id from a previously *closed* operation. The default policy is NEXUS_OPERATION_ID_REUSE_POLICY_ALLOW_DUPLICATE.
enums.v1.NexusOperationIdConflictPolicy id_conflict_policy = 13
Defines how to resolve an operation id conflict with a *running* operation. The default policy is NEXUS_OPERATION_ID_CONFLICT_POLICY_FAIL.
optional search_attributes = 14
Search attributes for indexing.
map<string, string> nexus_header = 15
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 user_metadata = 16
Metadata for use by user interfaces to display the fixed as-of-start summary and details of the operation.
message
request_response.proto:3340string run_id = 1
The run ID of the operation that was started - or used (via NEXUS_OPERATION_ID_CONFLICT_POLICY_USE_EXISTING).
bool started = 2
If true, a new operation was started.
StartWorkflowExecution starts a new workflow execution. It will create the execution with a `WORKFLOW_EXECUTION_STARTED` event in its history and also schedule the first workflow task. Returns `WorkflowExecutionAlreadyStarted`, if an instance already exists with same workflow id.
rpc StopBatchOperation (, )
service.proto:1275StopBatchOperation stops a batch operation
message
request_response.proto:1858string namespace = 1
Namespace that contains the batch operation
string job_id = 2
Batch job id
string reason = 3
Reason to stop a batch operation
string identity = 4
Identity of the operator
message
request_response.proto:1869(message has no fields)
TerminateActivityExecution terminates an existing activity execution immediately. Termination does not reach the worker and the activity code cannot react to it. A terminated activity may have a running attempt.
message
request_response.proto:3512string namespace = 1
string activity_id = 2
string run_id = 3
Activity run ID, targets the latest run if run_id is empty.
string identity = 4
The identity of the worker/client.
string request_id = 5
Used to de-dupe termination requests.
string reason = 6
Reason for requesting the termination, recorded in in the activity's result failure outcome.
message
request_response.proto:3525(message has no fields)
TerminateNexusOperationExecution terminates an existing Nexus operation immediately. Termination happens immediately and the operation handler cannot react to it. A terminated operation will have its outcome set to a failure with a termination reason.
message
request_response.proto:3554string namespace = 1
string operation_id = 2
string run_id = 3
Operation run ID, targets the latest run if empty.
string identity = 4
The identity of the client who initiated this request.
string request_id = 5
Used to de-dupe termination requests.
string reason = 6
Reason for requesting the termination, recorded in the operation's result failure outcome.
message
request_response.proto:3567(message has no fields)
TerminateWorkflowExecution terminates an existing workflow execution by recording a `WORKFLOW_EXECUTION_TERMINATED` event in the history and immediately terminating the execution instance.
message
request_response.proto:945string namespace = 1
optional workflow_execution = 2
string reason = 3
optional details = 4
Serialized additional information to attach to the termination event
string identity = 5
The identity of the worker/client
string first_execution_run_id = 6
If set, this call will error if the most recent (if no run id is set on `workflow_execution`), or specified (if it is) workflow execution is not part of the same execution chain as this id.
repeated links = 7
Links to be associated with the WorkflowExecutionTerminated event.
message
request_response.proto:962(message has no fields)
TriggerWorkflowRule allows to: * trigger existing rule for a specific workflow execution; * trigger rule for a specific workflow execution without creating a rule; This is useful for one-off operations.
message
request_response.proto:2893string namespace = 1
optional execution = 2
Execution info of the workflow which scheduled this activity
oneof rule
Either provide id of existing rule, or rule specification
string id = 4
spec = 5
Note: Rule ID and expiration date are not used in the trigger request.
string identity = 3
The identity of the client who initiated this request
message
request_response.proto:2910bool applied = 1
True is the rule was applied, based on the rule conditions (predicate/visibility_query).
rpc UnpauseActivity (, )
service.proto:1427UnpauseActivity unpauses the execution of an activity specified by its ID or type. If there are multiple pending activities of the provided type - all of them will be unpaused. If activity is not paused, this call will have no effect. If the activity was paused while waiting for retry, it will be scheduled immediately (* see 'jitter' flag). Once the activity is unpaused, all timeout timers will be regenerated. Flags: 'jitter': the activity will be scheduled at a random time within the jitter duration. 'reset_attempts': the number of attempts will be reset. 'reset_heartbeat': the activity heartbeat timer and heartbeats will be reset. Returns a `NotFound` error if there is no pending activity with the provided ID or type This API will be deprecated soon and replaced with a newer UnpauseActivityExecution that is better named and structured to work well for standalone activities.
message
request_response.proto:2218Deprecated. Use `UnpauseActivityExecutionRequest`.
string namespace = 1
Namespace of the workflow which scheduled this activity.
optional execution = 2
Execution info of the workflow which scheduled this activity
string identity = 3
The identity of the client who initiated this request.
oneof activity
either activity id or activity type must be provided
string id = 4
Only the activity with this ID will be unpaused.
string type = 5
Unpause all running activities with of this type.
bool unpause_all = 6
Unpause all running activities.
bool reset_attempts = 7
Providing this flag will also reset the number of attempts.
bool reset_heartbeat = 8
Providing this flag will also reset the heartbeat details.
optional jitter = 9
If set, the activity will start at a random time within the specified jitter duration.
message
request_response.proto:2279Deprecated. Use `UnpauseActivityExecutionResponse`.
(message has no fields)
UnpauseActivityExecution unpauses the execution of an activity specified by its ID. This API can be used to target a workflow activity or a standalone activity. If activity is not paused, this call will have no effect. If the activity was paused while waiting for retry, it will be scheduled immediately (* see 'jitter' flag). Once the activity is unpaused, all timeout timers will be regenerated. Returns a `NotFound` error if there is no pending activity with the provided ID
message
request_response.proto:2247string namespace = 1
Namespace of the workflow which scheduled this activity.
string workflow_id = 2
If provided, targets a workflow activity for the given workflow ID. If empty, targets a standalone activity.
string activity_id = 3
The ID of the activity to target.
string run_id = 4
Run ID of the workflow or standalone activity.
string identity = 5
The identity of the client who initiated this request.
bool reset_attempts = 6
Providing this flag will also reset the number of attempts.
bool reset_heartbeat = 7
Providing this flag will also reset the heartbeat details.
string reason = 8
Reason to unpause the activity.
optional jitter = 9
If set, the activity will start at a random time within the specified jitter duration.
string resource_id = 10
Resource ID for routing. Contains "workflow:{workflow_id}" for workflow activities or "activity:{activity_id}" for standalone activities.
message
request_response.proto:2282(message has no fields)
Note: This is an experimental API and the behavior may change in a future release. UnpauseWorkflowExecution unpauses a previously paused workflow execution specified in the request. Unpausing a workflow execution results in - The workflow execution status changes to `RUNNING` and a new WORKFLOW_EXECUTION_UNPAUSED event is added to the history - Workflow tasks and activity tasks are resumed.
message
request_response.proto:3103string namespace = 1
Namespace of the workflow to unpause.
string workflow_id = 2
ID of the workflow execution to be paused. Required.
string run_id = 3
Run ID of the workflow execution to be paused. Optional. If not provided, the current run of the workflow will be paused.
string identity = 4
The identity of the client who initiated this request.
string reason = 5
Reason to unpause the workflow execution.
string request_id = 6
A unique identifier for this unpause request for idempotence. Typically UUIDv4.
message
request_response.proto:3119Response to a successful UnpauseWorkflowExecution request.
(message has no fields)
UpdateActivityExecutionOptions is called by the client to update the options of an activity by its ID. This API can be used to target a workflow activity or a standalone activity.
message
request_response.proto:2115string namespace = 1
Namespace of the workflow which scheduled this activity
string workflow_id = 2
If provided, targets a workflow activity for the given workflow ID. If empty, targets a standalone activity.
string activity_id = 3
The ID of the activity to target.
string run_id = 4
Run ID of the workflow or standalone activity.
string identity = 5
The identity of the client who initiated this request
optional activity_options = 6
Activity options. Partial updates are accepted and controlled by update_mask
optional update_mask = 7
Controls which fields from `activity_options` will be applied
bool restore_original = 8
If set, the activity options will be restored to the default. Default options are then options activity was created with. They are part of the first schedule event. This flag cannot be combined with any other option; if you supply restore_original together with other options, the request will be rejected.
string resource_id = 9
Resource ID for routing. Contains "workflow:{workflow_id}" for workflow activities or "activity:{activity_id}" for standalone activities.
message
request_response.proto:2153optional activity_options = 1
Activity options after an update
UpdateActivityOptions is called by the client to update the options of an activity by its ID or type. If there are multiple pending activities of the provided type - all of them will be updated. This API will be deprecated soon and replaced with a newer UpdateActivityExecutionOptions that is better named and structured to work well for standalone activities.
message
request_response.proto:2082NOTE: keep in sync with temporal.api.batch.v1.BatchOperationUpdateActivityOptions Deprecated. Use `UpdateActivityExecutionOptionsRequest`.
string namespace = 1
Namespace of the workflow which scheduled this activity
optional execution = 2
Execution info of the workflow which scheduled this activity
string identity = 3
The identity of the client who initiated this request
optional activity_options = 4
Activity options. Partial updates are accepted and controlled by update_mask
optional update_mask = 5
Controls which fields from `activity_options` will be applied
oneof activity
either activity id, activity type or update_all must be provided
string id = 6
Only activity with this ID will be updated.
string type = 7
Update all running activities of this type.
bool match_all = 9
Update all running activities.
bool restore_original = 8
If set, the activity options will be restored to the default. Default options are then options activity was created with. They are part of the first schedule event. This flag cannot be combined with any other option; if you supply restore_original together with other options, the request will be rejected.
message
request_response.proto:2148Deprecated. Use `UpdateActivityExecutionOptionsResponse`.
optional activity_options = 1
Activity options after an update
rpc UpdateNamespace (, )
service.proto:70UpdateNamespace is used to update the information and configuration of a registered namespace.
message
request_response.proto:111string namespace = 1
optional update_info = 2
optional config = 3
optional replication_config = 4
string security_token = 5
string delete_bad_binary = 6
bool promote_namespace = 7
promote local namespace to global namespace. Ignored if namespace is already global namespace.
message
request_response.proto:122optional namespace_info = 1
optional config = 2
optional replication_config = 3
int64 failover_version = 4
bool is_global_namespace = 5
rpc UpdateSchedule (, )
service.proto:783Changes the configuration or state of an existing schedule.
message
request_response.proto:1411string namespace = 1
The namespace of the schedule to update.
string schedule_id = 2
The id of the schedule to update.
optional schedule = 3
The new schedule. The four main fields of the schedule (spec, action, policies, state) are replaced completely by the values in this message.
bytes conflict_token = 4
This can be the value of conflict_token from a DescribeScheduleResponse, which will cause this request to fail if the schedule has been modified between the Describe and this Update. If missing, the schedule will be updated unconditionally.
string identity = 5
The identity of the client who initiated this request.
string request_id = 6
A unique identifier for this update request for idempotence. Typically UUIDv4.
optional search_attributes = 7
Schedule search attributes to be updated. Do not set this field if you do not want to update the search attributes. A non-null empty object will set the search attributes to an empty map. Note: you cannot only update the search attributes with `UpdateScheduleRequest`, you must also set the `schedule` field; otherwise, it will unset the schedule.
optional memo = 8
Schedule memo to replace. If set, replaces the entire memo. Do not set this field if you do not want to update the memo. A non-null empty object will clear the memo.
message
request_response.proto:1440(message has no fields)
Updates task queue configuration. For the overall queue rate limit: the rate limit set by this api overrides the worker-set rate limit, which uncouples the rate limit from the worker lifecycle. If the overall queue rate limit is unset, the worker-set rate limit takes effect.
message
request_response.proto:2968string namespace = 1
string identity = 2
string task_queue = 3
Selects the task queue to update.
enums.v1.TaskQueueType task_queue_type = 4
optional update_queue_rate_limit = 5
Update to queue-wide rate limit. If not set, this configuration is unchanged. NOTE: A limit set by the worker is overriden; and restored again when reset. If the `rate_limit` field in the `RateLimitUpdate` is missing, remove the existing rate limit.
optional update_fairness_key_rate_limit_default = 6
Update to the default fairness key rate limit. If not set, this configuration is unchanged. If the `rate_limit` field in the `RateLimitUpdate` is missing, remove the existing rate limit.
map<string, float> set_fairness_weight_overrides = 7
If set, overrides the fairness weight for each specified fairness key. Fairness keys not listed in this map will keep their existing overrides (if any).
repeated string unset_fairness_weight_overrides = 8
If set, removes any existing fairness weight overrides for each specified fairness key. Fairness weights for corresponding keys fall back to the values set during task creation (if any), or to the default weight of 1.0.
message
request_response.proto:2999optional config = 1
Deprecated. Use `UpdateWorkerVersioningRules`. Will be removed in server version v1.32.0. Allows users to specify sets of worker build id versions on a per task queue basis. Versions are ordered, and may be either compatible with some extant version, or a new incompatible version, forming sets of ids which are incompatible with each other, but whose contained members are compatible with one another. A single build id may be mapped to multiple task queues using this API for cases where a single process hosts multiple workers. To query which workers can be retired, use the `GetWorkerTaskReachability` API. NOTE: The number of task queues mapped to a single build id is limited by the `limit.taskQueuesPerBuildId` (default is 20), if this limit is exceeded this API will error with a FailedPrecondition. (-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: We do yet expose versioning API to HTTP. --)
message
request_response.proto:1525[cleanup-wv-pre-release]
string namespace = 1
string task_queue = 2
Must be set, the task queue to apply changes to. Because all workers on a given task queue must have the same set of workflow & activity implementations, there is no reason to specify a task queue type here.
oneof operation
string add_new_build_id_in_new_default_set = 3
A new build id. This operation will create a new set which will be the new overall default version for the queue, with this id as its only member. This new set is incompatible with all previous sets/versions. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: In makes perfect sense here. --)
add_new_compatible_build_id = 4
Adds a new id to an existing compatible set, see sub-message definition for more.
string promote_set_by_build_id = 5
Promote an existing set to be the current default (if it isn't already) by targeting an existing build id within it. This field's value is the extant build id. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: Names are hard. --)
string promote_build_id_within_set = 6
Promote an existing build id within some set to be the current default for that set. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: Within makes perfect sense here. --)
merge_sets = 7
Merge two existing sets together, thus declaring all build IDs in both sets compatible with one another. The primary set's default will become the default for the merged set. This is useful if you've accidentally declared a new ID as incompatible you meant to declare as compatible. The unusual case of incomplete replication during failover could also result in a split set, which this operation can repair.
message
request_response.proto:1581[cleanup-wv-pre-release]
(message has no fields)
rpc UpdateWorkerConfig (, )
service.proto:1616UpdateWorkerConfig updates the worker configuration of one or more workers. Can be used to partially update the worker configuration. Can be used to update the configuration of multiple workers.
message
request_response.proto:3025string namespace = 1
Namespace this worker belongs to.
string identity = 2
The identity of the client who initiated this request.
string reason = 3
Reason for sending worker command, can be used for audit purpose.
optional worker_config = 4
Partial updates are accepted and controlled by update_mask. The worker configuration to set.
optional update_mask = 5
Controls which fields from `worker_config` will be applied
optional selector = 6
Defines which workers should receive this command.
string resource_id = 7
Resource ID for routing. Contains the worker grouping key.
message
request_response.proto:3048oneof response
worker_config = 1
The worker configuration. Will be returned if the command was sent to a single worker.
Updates the compute config attached to a Worker Deployment Version. Experimental. This API might significantly change or be removed in a future release.
message
request_response.proto:2704Used to update the compute config of a Worker Deployment Version.
string namespace = 1
optional deployment_version = 2
Required.
map<string, > compute_config_scaling_groups = 6
Optional. Contains the compute config scaling groups to add or update for the Worker Deployment.
repeated string remove_compute_config_scaling_groups = 7
Optional. Contains the compute config scaling groups to remove from the Worker Deployment.
string identity = 3
Optional. The identity of the client who initiated this request.
string request_id = 4
A unique identifier for this create request for idempotence. Typically UUIDv4. If a second request with the same ID is recieved, it is considered a successful no-op. Retrying with a different request ID for the same deployment name + build ID is an error.
message
request_response.proto:2726(message has no fields)
Updates the user-given metadata attached to a Worker Deployment Version. Experimental. This API might significantly change or be removed in a future release.
message
request_response.proto:2751Used to update the user-defined metadata of a Worker Deployment Version.
string namespace = 1
string version = 2
Deprecated. Use `deployment_version`.
optional deployment_version = 5
Required.
map<string, > upsert_entries = 3
repeated string remove_entries = 4
List of keys to remove from the metadata.
string identity = 6
Optional. The identity of the client who initiated this request.
message
request_response.proto:2764optional metadata = 1
Full metadata after performing the update.
Use this API to manage Worker Versioning Rules for a given Task Queue. There are two types of rules: Build ID Assignment rules and Compatible Build ID Redirect rules. Assignment rules determine how to assign new executions to a Build IDs. Their primary use case is to specify the latest Build ID but they have powerful features for gradual rollout of a new Build ID. Once a workflow execution is assigned to a Build ID and it completes its first Workflow Task, the workflow stays on the assigned Build ID regardless of changes in assignment rules. This eliminates the need for compatibility between versions when you only care about using the new version for new workflows and let existing workflows finish in their own version. Activities, Child Workflows and Continue-as-New executions have the option to inherit the Build ID of their parent/previous workflow or use the latest assignment rules to independently select a Build ID. Redirect rules should only be used when you want to move workflows and activities assigned to one Build ID (source) to another compatible Build ID (target). You are responsible to make sure the target Build ID of a redirect rule is able to process event histories made by the source Build ID by using [Patching](https://docs.temporal.io/workflows#patching) or other means. Will be removed in server version v1.32.0. (-- api-linter: core::0127::http-annotation=disabled aip.dev/not-precedent: We do yet expose versioning API to HTTP. --)
message
request_response.proto:1610(-- api-linter: core::0134::request-mask-required=disabled aip.dev/not-precedent: UpdateNamespace RPC doesn't follow Google API format. --) (-- api-linter: core::0134::request-resource-required=disabled aip.dev/not-precedent: GetWorkerBuildIdCompatibilityRequest RPC doesn't follow Google API format. --) [cleanup-wv-pre-release]
string namespace = 1
string task_queue = 2
bytes conflict_token = 3
A valid conflict_token can be taken from the previous ListWorkerVersioningRulesResponse or UpdateWorkerVersioningRulesResponse. An invalid token will cause this request to fail, ensuring that if the rules for this Task Queue have been modified between the previous and current operation, the request will fail instead of causing an unpredictable mutation.
oneof operation
insert_assignment_rule = 4
replace_assignment_rule = 5
delete_assignment_rule = 6
add_compatible_redirect_rule = 7
replace_compatible_redirect_rule = 8
delete_compatible_redirect_rule = 9
commit_build_id = 10
message
request_response.proto:1702[cleanup-wv-pre-release]
repeated assignment_rules = 1
repeated compatible_redirect_rules = 2
bytes conflict_token = 3
This value can be passed back to UpdateWorkerVersioningRulesRequest to ensure that the rules were not modified between the two updates, which could lead to lost updates and other confusion.
Invokes the specified Update function on user Workflow code.
UpdateWorkflowExecutionOptions partially updates the WorkflowExecutionOptions of an existing workflow execution.
message
request_response.proto:2368Keep the parameters in sync with: - temporal.api.batch.v1.BatchOperationUpdateWorkflowExecutionOptions. - temporal.api.workflow.v1.PostResetOperation.UpdateWorkflowOptions.
string namespace = 1
The namespace name of the target Workflow.
optional workflow_execution = 2
The target Workflow Id and (optionally) a specific Run Id thereof. (-- api-linter: core::0203::optional=disabled aip.dev/not-precedent: false positive triggered by the word "optional" --)
optional workflow_execution_options = 3
Workflow Execution options. Partial updates are accepted and controlled by update_mask.
optional update_mask = 4
Controls which fields from `workflow_execution_options` will be applied. To unset a field, set it to null and use the update mask to indicate that it should be mutated.
string identity = 5
Optional. The identity of the client who initiated this request.
message
request_response.proto:2387optional workflow_execution_options = 1
Workflow Execution options after update.
optional update_time = 2
The Workflow Execution time when the options were updated. When time skipping is enabled, this is the workflow's virtual time rather than wall-clock time.
Validates the compute config without attaching it to a Worker Deployment Version. Experimental. This API might significantly change or be removed in a future release.
message
request_response.proto:2730Used to validate the compute config without attaching it to a Worker Deployment Version.
string namespace = 1
optional deployment_version = 2
Required.
map<string, > compute_config_scaling_groups = 6
Optional. Contains the compute config scaling groups to add or update for the Worker Deployment.
repeated string remove_compute_config_scaling_groups = 7
Optional. Contains the compute config scaling groups to remove from the Worker Deployment.
string identity = 3
Optional. The identity of the client who initiated this request.
message
request_response.proto:2747(message has no fields)
message
request_response.proto:3464Used in:
repeated group_values = 1
int64 count = 2
message
request_response.proto:3489Used in:
repeated group_values = 1
int64 count = 2
message
request_response.proto:1518Used in:
repeated group_values = 1
int64 count = 2
message
request_response.proto:1062Used in:
repeated group_values = 1
int64 count = 2
message
request_response.proto:96Used as response type in: WorkflowService.DescribeNamespace
Used as field type in:
optional namespace_info = 1
optional config = 2
optional replication_config = 3
int64 failover_version = 4
bool is_global_namespace = 5
repeated failover_history = 6
Contains the historical state of failover_versions for the cluster, truncated to contain only the last N states to ensure that the list does not grow unbounded.
repeated poller_group_infos = 7
The initial info that client should use for poller group assignment. This information is updated through poll response. Client is supposed to use the info received in the latest poll response.
message
request_response.proto:1245Used in:
float requests_per_second = 1
The effective rate limit for the task queue.
enums.v1.RateLimitSource rate_limit_source = 2
Source of the RateLimit Configuration,which can be one of the following values: - SOURCE_API: The rate limit that is set via the TaskQueueConfig api. - SOURCE_WORKER: The rate limit is the value set using the workerOptions in TaskQueueActivitiesPerSecond. - SOURCE_SYSTEM: The rate limit is the default value set by the system
message
request_response.proto:2422(-- api-linter: core::0123::resource-annotation=disabled --)
Used in:
string name = 1
enums.v1.TaskQueueType type = 2
optional stats = 3
Only set if `report_task_queue_stats` is set on the request.
map<int32, > stats_by_priority_key = 4
Task queue stats breakdown by priority key. Only contains actively used priority keys. Only set if `report_task_queue_stats` is set to true in the request. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "by" is used to clarify the key. --)
message
request_response.proto:2047Used in:
oneof operation
start_workflow = 1
Additional restrictions: - setting `cron_schedule` is invalid - setting `request_eager_execution` is invalid - setting `workflow_start_delay` is invalid
update_workflow = 2
Additional restrictions: - setting `first_execution_run_id` is invalid - setting `workflow_execution.run_id` is invalid
message
request_response.proto:2072Used in:
oneof response
start_workflow = 1
update_workflow = 2
message
request_response.proto:1298System capability details.
Used in:
bool signal_and_query_header = 1
True if signal and query headers are supported.
bool internal_error_differentiation = 2
True if internal errors are differentiated from other types of errors for purposes of retrying non-internal errors. When unset/false, clients retry all failures. When true, clients should only retry non-internal errors.
bool activity_failure_include_heartbeat = 3
True if RespondActivityTaskFailed API supports including heartbeat details
bool supports_schedules = 4
Supports scheduled workflow features.
bool encoded_failure_attributes = 5
True if server uses protos that include temporal.api.failure.v1.Failure.encoded_attributes
bool build_id_based_versioning = 6
True if server supports dispatching Workflow and Activity tasks based on a worker's build_id (see: https://github.com/temporalio/proposals/blob/a123af3b559f43db16ea6dd31870bfb754c4dc5e/versioning/worker-versions.md)
bool upsert_memo = 7
True if server supports upserting workflow memo
bool eager_workflow_start = 8
True if server supports eager workflow task dispatching for the StartWorkflowExecution API
bool sdk_metadata = 9
True if the server knows about the sdk metadata field on WFT completions and will record it in history
bool count_group_by_execution_status = 10
True if the server supports count group by execution status (-- api-linter: core::0140::prepositions=disabled --)
bool nexus = 11
True if the server supports Nexus operations. This flag is dependent both on server version and for Nexus to be enabled via server configuration.
bool server_scaled_deployments = 12
True if the server supports server-scaled deployments. This flag is dependent both on server version and for server-scaled deployments to be enabled via server configuration.
message
request_response.proto:2634(-- api-linter: core::0123::resource-annotation=disabled --) A subset of WorkerDeploymentInfo
Used in:
string name = 1
optional create_time = 2
optional routing_config = 3
optional latest_version_summary = 4
Summary of the version that was added most recently in the Worker Deployment.
optional current_version_summary = 5
Summary of the current version of the Worker Deployment.
optional ramping_version_summary = 6
Summary of the ramping version of the Worker Deployment.
message
request_response.proto:515Used as response type in: WorkflowService.PollActivityTaskQueue
Used as field type in:
bytes task_token = 1
A unique identifier for this task
string workflow_namespace = 2
The namespace of the activity. If this is a workflow activity then this is the namespace of the workflow also. If this is a standalone activity then the name of this field is misleading, but retained for compatibility with workflow activities.
optional workflow_type = 3
Type of the requesting workflow (if this is a workflow activity).
optional workflow_execution = 4
Execution info of the requesting workflow (if this is a workflow activity)
optional activity_type = 5
string activity_id = 6
The autogenerated or user specified identifier of this activity. Can be used to complete the activity via `RespondActivityTaskCompletedById`. May be re-used as long as the last usage has resolved, but unique IDs for every activity invocation is a good idea. Note that only a workflow activity ID may be autogenerated.
optional header = 7
Headers specified by the scheduling workflow. Commonly used to propagate contextual info from the workflow to its activities. For example, tracing contexts.
optional input = 8
Arguments to the activity invocation
optional heartbeat_details = 9
Details of the last heartbeat that was recorded for this activity as of the time this task was delivered.
optional scheduled_time = 10
When was this task first scheduled
optional current_attempt_scheduled_time = 11
When was this task attempt scheduled
optional started_time = 12
When was this task started (this attempt)
int32 attempt = 13
Starting at 1, the number of attempts to perform this activity
optional schedule_to_close_timeout = 14
First scheduled -> final result reported timeout (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)
optional start_to_close_timeout = 15
Current attempt start -> final result reported timeout (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)
optional heartbeat_timeout = 16
Window within which the activity must report a heartbeat, or be timed out.
optional retry_policy = 17
This is the retry policy the service uses which may be different from the one provided (or not) during activity scheduling. The service can override the provided one if some values are not specified or exceed configured system limits.
optional poller_scaling_decision = 18
Server-advised information the SDK may use to adjust its poller count.
optional priority = 19
Priority metadata
string activity_run_id = 20
The run ID of the activity execution, only set for standalone activities.
repeated poller_group_infos = 21
The weighted list of poller groups IDs that client should use for future polls to this task queue. Client is expected to: 1. Maintain minimum number of pollers no less than the number of groups. 2. Try to assign the next poll to a group without any pending polls, 3. If every group has some pending polls, assign the next poll to a group randomly according to the weights.
message
request_response.proto:305Used as response type in: WorkflowService.PollWorkflowTaskQueue
Used as field type in: ,
bytes task_token = 1
A unique identifier for this task
optional workflow_execution = 2
optional workflow_type = 3
int64 previous_started_event_id = 4
The last workflow task started event which was processed by some worker for this execution. Will be zero if no task has ever started.
int64 started_event_id = 5
The id of the most recent workflow task started event, which will have been generated as a result of this poll request being served. Will be zero if the task does not contain any events which would advance history (no new WFT started). Currently this can happen for queries.
int32 attempt = 6
Starting at 1, the number of attempts to complete this task by any worker.
int64 backlog_count_hint = 7
A hint that there are more tasks already present in this task queue partition. Can be used to prioritize draining a sticky queue. Specifically, the returned number is the number of tasks remaining in the in-memory buffer for this partition, which is currently capped at 1000. Because sticky queues only have one partition, this number is more useful when draining them. Normal queues, typically having more than one partition, will return a number representing only some portion of the overall backlog. Subsequent RPCs may not hit the same partition as this call.
optional history = 8
The history for this workflow, which will either be complete or partial. Partial histories are sent to workers who have signaled that they are using a sticky queue when completing a workflow task.
bytes next_page_token = 9
Will be set if there are more history events than were included in this response. Such events should be fetched via `GetWorkflowExecutionHistory`.
optional query = 10
Legacy queries appear in this field. The query must be responded to via `RespondQueryTaskCompleted`. If the workflow is already closed (queries are permitted on closed workflows) then the `history` field will be populated with the entire history. It may also be populated if this task originates on a non-sticky queue.
optional workflow_execution_task_queue = 11
The task queue this task originated from, which will always be the original non-sticky name for the queue, even if this response came from polling a sticky queue.
optional scheduled_time = 12
When this task was scheduled by the server
optional started_time = 13
When the current workflow task started event was generated, meaning the current attempt.
map<string, > queries = 14
Queries that should be executed after applying the history in this task. Responses should be attached to `RespondWorkflowTaskCompletedRequest::query_results`
repeated messages = 15
Protocol messages piggybacking on a WFT as a transport
optional poller_scaling_decision = 16
Server-advised information the SDK may use to adjust its poller count.
string poller_group_id = 17
This poller group ID identifies the owner of the workflow task awaiting for query response. Corresponding RespondQueryTaskCompleted should pass this value for proper routing.
repeated poller_group_infos = 18
The weighted list of poller groups IDs that client should use for future polls to this task queue. Client is expected to: 1. Maintain minimum number of pollers no less than the number of groups. 2. Try to assign the next poll to a group without any pending polls, 3. If every group has some pending polls, assign the next poll to a group randomly according to the weights.
message
request_response.proto:428SDK capability details.
Used in:
bool discard_speculative_workflow_task_with_events = 1
True if the SDK can handle speculative workflow task with command events. If true, the server may choose, at its discretion, to discard a speculative workflow task even if that speculative task included command events the SDK had not previously processed. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "with" used to describe the workflow task. --)
message
request_response.proto:140Used as request type in: WorkflowService.StartWorkflowExecution
Used as field type in:
string namespace = 1
string workflow_id = 2
optional workflow_type = 3
optional task_queue = 4
optional input = 5
Serialized arguments to the workflow. These are passed as arguments to the workflow function.
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.
string identity = 9
The identity of the client who initiated this request
string request_id = 10
A unique identifier for this start request. Typically UUIDv4.
enums.v1.WorkflowIdReusePolicy workflow_id_reuse_policy = 11
Defines whether to allow re-using the workflow id from a previously *closed* workflow. The default policy is WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE. See `workflow_id_conflict_policy` for handling a workflow id duplication with a *running* workflow.
enums.v1.WorkflowIdConflictPolicy workflow_id_conflict_policy = 22
Defines how to resolve a workflow id conflict with a *running* workflow. The default policy is WORKFLOW_ID_CONFLICT_POLICY_FAIL. See `workflow_id_reuse_policy` for handling a workflow id duplication with a *closed* workflow.
optional retry_policy = 12
The retry policy for the workflow. Will never exceed `workflow_execution_timeout`.
string cron_schedule = 13
See https://docs.temporal.io/docs/content/what-is-a-temporal-cron-job/
optional memo = 14
optional search_attributes = 15
optional header = 16
bool request_eager_execution = 17
Request to get the first workflow task inline in the response bypassing matching service and worker polling. If set to `true` the caller is expected to have a worker available and capable of processing the task. The returned task will be marked as started and is expected to be completed by the specified `workflow_task_timeout`.
optional continued_failure = 18
These values will be available as ContinuedFailure and LastCompletionResult in the WorkflowExecutionStarted event and through SDKs. The are currently only used by the server itself (for the schedules feature) and are not intended to be exposed in StartWorkflowExecution.
optional last_completion_result = 19
optional workflow_start_delay = 20
Time to wait before dispatching the first workflow task. Cannot be used with `cron_schedule`. If the workflow gets a signal before the delay, a workflow task will be dispatched and the rest of the delay will be ignored.
repeated completion_callbacks = 21
Callbacks to be called by the server when this workflow reaches a terminal state. If the workflow continues-as-new, these callbacks will be carried over to the new execution. Callback addresses must be whitelisted in the server's dynamic configuration.
optional user_metadata = 23
Metadata on the workflow if it is started. This is carried over to the WorkflowExecutionInfo for use by user interfaces to display the fixed as-of-start summary and details of the workflow.
repeated links = 24
Links to be associated with the workflow.
optional versioning_override = 25
If set, takes precedence over the Versioning Behavior sent by the SDK on Workflow Task completion. To unset the override after the workflow is running, use UpdateWorkflowExecutionOptions.
optional on_conflict_options = 26
Defines actions to be done to the existing running workflow when the conflict policy WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING is used. If not set (ie., nil value) or set to a empty object (ie., all options with default value), it won't do anything to the existing running workflow. If set, it will add a history event to the running workflow.
optional priority = 27
Priority metadata
optional eager_worker_deployment_options = 28
Deployment Options of the worker who will process the eager task. Passed when `request_eager_execution=true`.
optional time_skipping_config = 29
Time-skipping configuration. If not set, time skipping is disabled.
message
request_response.proto:216Used as response type in: WorkflowService.StartWorkflowExecution
Used as field type in:
string run_id = 1
The run id of the workflow that was started - or used (via WorkflowIdConflictPolicy USE_EXISTING).
bool started = 3
If true, a new workflow was started.
enums.v1.WorkflowExecutionStatus status = 5
Current execution status of the workflow. Typically remains WORKFLOW_EXECUTION_STATUS_RUNNING unless a de-dupe occurs or in specific scenarios handled within the ExecuteMultiOperation (refer to its docs).
optional eager_workflow_task = 2
When `request_eager_execution` is set on the `StartWorkflowExecutionRequest`, the server - if supported - will return the first workflow task to be eagerly executed. The caller is expected to have a worker available to process the task.
optional link = 4
Link to the workflow event.
message
request_response.proto:2969Used in:
optional rate_limit = 1
Rate Limit to be updated
string reason = 2
Reason for why the rate limit was set.
message
request_response.proto:1526Used in:
string new_build_id = 1
A new id to be added to an existing compatible set.
string existing_compatible_build_id = 2
A build id which must already exist in the version sets known by the task queue. The new id will be stored in the set containing this id, marking it as compatible with the versions within.
bool make_set_default = 3
When set, establishes the compatible set being targeted as the overall default for the queue. If a different set was the current default, the targeted set will replace it as the new default.
message
request_response.proto:1539Used in:
string primary_set_build_id = 1
A build ID in the set whose default will become the merged set default
string secondary_set_build_id = 2
A build ID in the set which will be merged into the primary set
message
request_response.proto:1649Adds the rule to the list of redirect rules for this Task Queue. There can be at most one redirect rule for each distinct Source Build ID.
Used in:
optional rule = 1
message
request_response.proto:1671This command is intended to be used to complete the rollout of a Build ID and cleanup unnecessary rules possibly created during a gradual rollout. Specifically, this command will make the following changes atomically: 1. Adds an assignment rule (with full ramp) for the target Build ID at the end of the list. 2. Removes all previously added assignment rules to the given target Build ID (if any). 3. Removes any fully-ramped assignment rule for other Build IDs.
Used in:
string target_build_id = 1
bool force = 2
To prevent committing invalid Build IDs, we reject the request if no pollers has been seen recently for this Build ID. Use the `force` option to disable this validation.
message
request_response.proto:1636Used in:
int32 rule_index = 1
bool force = 2
By default presence of one unconditional rule is enforced, otherwise the delete operation will be rejected. Set `force` to true to bypass this validation. An unconditional assignment rule: - Has no hint filter - Has no ramp
message
request_response.proto:1658Used in:
string source_build_id = 1
message
request_response.proto:1614Inserts the rule to the list of assignment rules for this Task Queue. The rules are evaluated in order, starting from index 0. The first applicable rule will be applied and the rest will be ignored.
Used in:
int32 rule_index = 1
Use this option to insert the rule in a particular index. By default, the new rule is inserted at the beginning of the list (index 0). If the given index is too larger the rule will be inserted at the end of the list.
optional rule = 2
message
request_response.proto:1624Replaces the assignment rule at a given index.
Used in:
int32 rule_index = 1
optional rule = 2
bool force = 3
By default presence of one unconditional rule is enforced, otherwise the replace operation will be rejected. Set `force` to true to bypass this validation. An unconditional assignment rule: - Has no hint filter - Has no ramp
message
request_response.proto:1654Replaces the routing rule with the given source Build ID.
Used in:
optional rule = 1
message
request_response.proto:1772(-- api-linter: core::0134=disabled aip.dev/not-precedent: Update RPCs don't follow Google API format. --)
Used as request type in: WorkflowService.UpdateWorkflowExecution
Used as field type in:
string namespace = 1
The namespace name of the target Workflow.
optional workflow_execution = 2
The target Workflow Id and (optionally) a specific Run Id thereof. (-- api-linter: core::0203::optional=disabled aip.dev/not-precedent: false positive triggered by the word "optional" --)
string first_execution_run_id = 3
If set, this call will error if the most recent (if no Run Id is set on `workflow_execution`), or specified (if it is) Workflow Execution is not part of the same execution chain as this Id.
optional wait_policy = 4
Specifies client's intent to wait for Update results. NOTE: This field works together with API call timeout which is limited by server timeout (maximum wait time). If server timeout is expired before user specified timeout, API call returns even if specified stage is not reached. Actual reached stage will be included in the response.
optional request = 5
The request information that will be delivered all the way down to the Workflow Execution.
message
request_response.proto:1796Used as response type in: WorkflowService.UpdateWorkflowExecution
Used as field type in:
optional update_ref = 1
Enough information for subsequent poll calls if needed. Never null.
optional outcome = 2
The outcome of the Update if and only if the Workflow Update has completed. If this response is being returned before the Update has completed then this field will not be set.
enums.v1.UpdateWorkflowExecutionLifecycleStage stage = 3
The most advanced lifecycle stage that the Update is known to have reached, where lifecycle stages are ordered UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_UNSPECIFIED < UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ADMITTED < UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ACCEPTED < UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_COMPLETED. UNSPECIFIED will be returned if and only if the server's maximum wait time was reached before the Update reached the stage specified in the request WaitPolicy, and before the context deadline expired; clients may may then retry the call as needed.
optional link = 4
Link to the update event. May be null if the update has not yet been accepted.