Table of Contents

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.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.

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

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.

WorkerVersionCapabilities

Identifies the version(s) 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.

WorkerVersionStamp

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.

ResetOptions.TargetOneofCase

Enum of possible cases for the "target" oneof.