Namespace Temporalio.Api.Common.V1

Classes

ActivityType: Represents the identifier used by a activity author to define the activity. Typically, the name of a function. This is sometimes referred to as the activity's "name"

Callback: Callback to attach to various events in the system, e.g. workflow run completion.

Callback.Types: Container for nested types declared in the Callback message type.

Callback.Types.Internal: Callbacks to be delivered internally within the system. This variant is not settable in the API and will be rejected by the service with an INVALID_ARGUMENT error. The only reason that this is exposed is because callbacks are replicated across clusters via the WorkflowExecutionStarted event, which is defined in the public API.

Callback.Types.Nexus

DataBlob

GrpcStatus: From https://github.com/grpc/grpc/blob/master/src/proto/grpc/status/status.proto since we don't import grpc but still need the status info

GrpcStatusReflection: Holder for reflection information generated from grpc_status.proto

Header: Contains metadata that can be attached to a variety of requests, like starting a workflow, and can be propagated between, for example, workflows and activities.

Link: Link can be associated with history events. It might contain information about an external entity related to the history event. For example, workflow A makes a Nexus call that starts workflow B: in this case, a history event in workflow A could contain a Link to the workflow started event in workflow B, and vice-versa.

Link.Types: Container for nested types declared in the Link message type.

Link.Types.BatchJob: A link to a built-in batch job. Batch jobs can be used to perform operations on a set of workflows (e.g. terminate, signal, cancel, etc). This link can be put on workflow history events generated by actions taken by a batch job.

Link.Types.WorkflowEvent

Link.Types.WorkflowEvent.Types: Container for nested types declared in the WorkflowEvent message type.

Link.Types.WorkflowEvent.Types.EventReference: EventReference is a direct reference to a history event through the event ID.

Link.Types.WorkflowEvent.Types.RequestIdReference: RequestIdReference is a indirect reference to a history event through the request ID.

Memo: A user-defined set of unindexed fields that are exposed when listing/searching workflows

MessageReflection: Holder for reflection information generated from temporal/api/common/v1/message.proto

MeteringMetadata: Metadata relevant for metering purposes

Payload: Represents some binary (byte array) data (ex: activity input parameters or workflow result) with metadata which describes this binary data (format, encoding, encryption, etc). Serialization of the data may be user-defined.

Payloads: See Payload

Priority

Priority contains metadata that controls relative ordering of task processing when tasks are backed up in a queue. Initially, Priority will be used in matching (workflow and activity) task queues. Later it may be used in history task queues and in rate limiting decisions.

Priority is attached to workflows and activities. By default, activities inherit Priority from the workflow that created them, but may override fields when an activity is started or modified.

Despite being named "Priority", this message also contains fields that control "fairness" mechanisms.

For all fields, the field not present or equal to zero/empty string means to inherit the value from the calling workflow, or if there is no calling workflow, then use the default value.

For all fields other than fairness_key, the zero value isn't meaningful so there's no confusion between inherit/default and a meaningful value. For fairness_key, the empty string will be interpreted as "inherit". This means that if a workflow has a non-empty fairness key, you can't override the fairness key of its activity to the empty string.

The overall semantics of Priority are:

First, consider "priority": higher priority (lower number) goes first.
Then, consider fairness: try to dispatch tasks for different fairness keys in proportion to their weight.

Applications may use any subset of mechanisms that are useful to them and leave the other fields to use default values.

Not all queues in the system may support the "full" semantics of all priority fields. (Currently only support in matching task queues is planned.)

ResetOptions: Describes where and how to reset a workflow, used for batch reset currently and may be used for single-workflow reset later.

RetryPolicy: How retries ought to be handled, usable by both workflows and activities

SearchAttributes: A user-defined set of indexed fields that are used/exposed when listing/searching workflows. The payload is not serialized in a user-defined way.

WorkerSelector: This is used to send commands to a specific worker or a group of workers. Right now, it is used to send commands to a specific worker instance. Will be extended to be able to send command to multiple workers.

WorkerVersionCapabilities: Identifies the version that a worker is compatible with when polling or identifying itself, and whether or not this worker is opting into the build-id based versioning feature. This is used by matching to determine which workers ought to receive what tasks. Deprecated. Use WorkerDeploymentOptions instead.

WorkerVersionStamp: Deprecated. This message is replaced with Deployment and VersioningBehavior. Identifies the version(s) of a worker that processed a task

WorkflowExecution: Identifies a specific workflow within a namespace. Practically speaking, because run_id is a uuid, a workflow execution is globally unique. Note that many commands allow specifying an empty run id as a way of saying "target the latest run of the workflow".

WorkflowType: Represents the identifier used by a workflow author to define the workflow. Typically, the name of a function. This is sometimes referred to as the workflow's "name"

Enums

Callback.VariantOneofCase: Enum of possible cases for the "variant" oneof.

Link.Types.WorkflowEvent.ReferenceOneofCase: Enum of possible cases for the "reference" oneof.

Link.VariantOneofCase: Enum of possible cases for the "variant" oneof.

ResetOptions.TargetOneofCase: Enum of possible cases for the "target" oneof.

WorkerSelector.SelectorOneofCase: Enum of possible cases for the "selector" oneof.

Table of Contents

Namespace Temporalio.Api.Common.V1

Classes

Enums