package temporal.api.worker.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Cancel an activity if it is still running. Otherwise, do nothing.

Used in: WorkerCommand

• bytes task_token = 1

Result of a CancelActivityCommand. Treat both successful cancellation and no-op (activity is no longer running) as success.

Used in: WorkerCommandResult

(message has no fields)

Used in: WorkerHeartbeat, WorkerListInfo

• string name = 1

  The name of the plugin, required.

• string version = 2

  The version of the plugin, may be empty.

Used in: WorkerHeartbeat, WorkerListInfo

• string type = 1

  The type of the driver, required.

A command sent from the server to a worker.

Used in: nexusservices.workerservice.v1.ExecuteCommandsRequest

• oneof type

  • CancelActivityCommand cancel_activity = 1

The result of executing a WorkerCommand.

Used in: nexusservices.workerservice.v1.ExecuteCommandsResponse

• oneof type

  • CancelActivityResult cancel_activity = 1

Worker info message, contains information about the worker and its current state. All information is provided by the worker itself. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: Removing those words make names less clear. --)

Used in: WorkerInfo, workflowservice.v1.PollNexusTaskQueueRequest, workflowservice.v1.RecordWorkerHeartbeatRequest, workflowservice.v1.ShutdownWorkerRequest

• string worker_instance_key = 1

  Worker identifier, should be unique for the namespace. It is distinct from worker identity, which is not necessarily namespace-unique.

• string worker_identity = 2

  Worker identity, set by the client, may not be unique. Usually host_name+(user group name)+process_id, but can be overwritten by the user.

• optional WorkerHostInfo host_info = 3

  Worker host information.

• string task_queue = 4

  Task queue this worker is polling for tasks.

• optional deployment.v1.WorkerDeploymentVersion deployment_version = 5

• string sdk_name = 6

• string sdk_version = 7

• enums.v1.WorkerStatus status = 8

  Worker status. Defined by SDK.

• optional google.protobuf.Timestamp start_time = 9

  Worker start time. It can be used to determine worker uptime. (current time - start time)

• optional google.protobuf.Timestamp heartbeat_time = 10

  Timestamp of this heartbeat, coming from the worker. Worker should set it to "now". Note that this timestamp comes directly from the worker and is subject to workers' clock skew.

• optional google.protobuf.Duration elapsed_since_last_heartbeat = 11

  Elapsed time since the last heartbeat from the worker.

• optional WorkerSlotsInfo workflow_task_slots_info = 12

• optional WorkerSlotsInfo activity_task_slots_info = 13

• optional WorkerSlotsInfo nexus_task_slots_info = 14

• optional WorkerSlotsInfo local_activity_slots_info = 15

• optional WorkerPollerInfo workflow_poller_info = 16

• optional WorkerPollerInfo workflow_sticky_poller_info = 17

• optional WorkerPollerInfo activity_poller_info = 18

• optional WorkerPollerInfo nexus_poller_info = 19

• int32 total_sticky_cache_hit = 20

  A Workflow Task found a cached Workflow Execution to run against.

• int32 total_sticky_cache_miss = 21

  A Workflow Task did not find a cached Workflow execution to run against.

• int32 current_sticky_cache_size = 22

  Current cache size, expressed in number of Workflow Executions.

• repeated PluginInfo plugins = 23

  Plugins currently in use by this SDK.

• repeated StorageDriverInfo drivers = 24

  Storage drivers in use by this SDK.

Holds everything needed to identify the worker host/process context

Used in: WorkerHeartbeat

• string host_name = 1

  Worker host identifier.

• string worker_grouping_key = 5

  Worker grouping identifier. A key to group workers that share the same client+namespace+process. This will be used to build the worker command nexus task queue name: "temporal-sys/worker-commands/{worker_grouping_key}"

• string process_id = 2

  Worker process identifier. This id only needs to be unique within one host (so using e.g. a unix pid would be appropriate).

• float current_host_cpu_usage = 3

  System used CPU as a float in the range [0.0, 1.0] where 1.0 is defined as all cores on the host pegged.

• float current_host_mem_usage = 4

  System used memory as a float in the range [0.0, 1.0] where 1.0 is defined as all available memory on the host is used.

Detailed worker information.

Used in: workflowservice.v1.DescribeWorkerResponse, workflowservice.v1.ListWorkersResponse

• optional WorkerHeartbeat worker_heartbeat = 1

Limited worker information returned in the list response. When adding fields here, ensure that it is also added to WorkerInfo (as it carries the full worker information).

Used in: workflowservice.v1.ListWorkersResponse

• string worker_instance_key = 1

  Worker identifier, should be unique for the namespace. It is distinct from worker identity, which is not necessarily namespace-unique.

• string worker_identity = 2

  Worker identity, set by the client, may not be unique. Usually host_name+(user group name)+process_id, but can be overwritten by the user.

• string task_queue = 3

  Task queue this worker is polling for tasks.

• optional deployment.v1.WorkerDeploymentVersion deployment_version = 4

• string sdk_name = 5

• string sdk_version = 6

• enums.v1.WorkerStatus status = 7

  Worker status. Defined by SDK.

• optional google.protobuf.Timestamp start_time = 8

  Worker start time. It can be used to determine worker uptime. (current time - start time)

• string host_name = 9

  Worker host identifier.

• string worker_grouping_key = 10

  Worker grouping identifier. A key to group workers that share the same client+namespace+process. This will be used to build the worker command nexus task queue name: "temporal-sys/worker-commands/{worker_grouping_key}"

• string process_id = 11

  Worker process identifier. This id only needs to be unique within one host (so using e.g. a unix pid would be appropriate).

• repeated PluginInfo plugins = 12

  Plugins currently in use by this SDK.

• repeated StorageDriverInfo drivers = 13

  Storage drivers in use by this SDK.

Used in: WorkerHeartbeat

• int32 current_pollers = 1

  Number of polling RPCs that are currently in flight.

• optional google.protobuf.Timestamp last_successful_poll_time = 2

• bool is_autoscaling = 3

  Set true if the number of concurrent pollers is auto-scaled

Used in: WorkerHeartbeat

• int32 current_available_slots = 1

  Number of slots available for the worker to specific tasks. May be -1 if the upper bound is not known.

• int32 current_used_slots = 2

  Number of slots used by the worker for specific tasks.

• string slot_supplier_kind = 3

  Kind of the slot supplier, which is used to determine how the slots are allocated. Possible values: "Fixed | ResourceBased | Custom String"

• int32 total_processed_tasks = 4

  Total number of tasks processed (completed both successfully and unsuccesfully, or any other way) by the worker since the worker started. This is a cumulative counter.

• int32 total_failed_tasks = 5

  Total number of failed tasks processed by the worker so far.

• int32 last_interval_processed_tasks = 6

  Number of tasks processed in since the last heartbeat from the worker. This is a cumulative counter, and it is reset to 0 each time the worker sends a heartbeat. Contains both successful and failed tasks.

• int32 last_interval_failure_tasks = 7

  Number of failed tasks processed since the last heartbeat from the worker.