common

package
v0.0.0-...-d1e98ca Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 16, 2024 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_temporal_api_common_v1_message_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type ActivityType 

type ActivityType struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

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"

func (*ActivityType) Descriptor deprecated 

func (*ActivityType) Descriptor() ([]byte, []int)

Deprecated: Use ActivityType.ProtoReflect.Descriptor instead.

func (*ActivityType) GetName 

func (x *ActivityType) GetName() string

func (*ActivityType) ProtoMessage 

func (*ActivityType) ProtoMessage()

func (*ActivityType) ProtoReflect 

func (x *ActivityType) ProtoReflect() protoreflect.Message

func (*ActivityType) Reset 

func (x *ActivityType) Reset()

func (*ActivityType) String 

func (x *ActivityType) String() string

type DataBlob 

type DataBlob struct {
	EncodingType v1.EncodingType `` /* 138-byte string literal not displayed */
	Data         []byte          `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*DataBlob) Descriptor deprecated 

func (*DataBlob) Descriptor() ([]byte, []int)

Deprecated: Use DataBlob.ProtoReflect.Descriptor instead.

func (*DataBlob) GetData 

func (x *DataBlob) GetData() []byte

func (*DataBlob) GetEncodingType 

func (x *DataBlob) GetEncodingType() v1.EncodingType

func (*DataBlob) ProtoMessage 

func (*DataBlob) ProtoMessage()

func (*DataBlob) ProtoReflect 

func (x *DataBlob) ProtoReflect() protoreflect.Message

func (*DataBlob) Reset 

func (x *DataBlob) Reset()

func (*DataBlob) String 

func (x *DataBlob) String() string
type Header struct {
	Fields map[string]*Payload `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

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.

func (*Header) Descriptor deprecated 

func (*Header) Descriptor() ([]byte, []int)

Deprecated: Use Header.ProtoReflect.Descriptor instead.

func (*Header) GetFields 

func (x *Header) GetFields() map[string]*Payload

func (*Header) ProtoMessage 

func (*Header) ProtoMessage()

func (*Header) ProtoReflect 

func (x *Header) ProtoReflect() protoreflect.Message

func (*Header) Reset 

func (x *Header) Reset()

func (*Header) String 

func (x *Header) String() string

type Memo 

type Memo struct {
	Fields map[string]*Payload `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

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

func (*Memo) Descriptor deprecated 

func (*Memo) Descriptor() ([]byte, []int)

Deprecated: Use Memo.ProtoReflect.Descriptor instead.

func (*Memo) GetFields 

func (x *Memo) GetFields() map[string]*Payload

func (*Memo) ProtoMessage 

func (*Memo) ProtoMessage()

func (*Memo) ProtoReflect 

func (x *Memo) ProtoReflect() protoreflect.Message

func (*Memo) Reset 

func (x *Memo) Reset()

func (*Memo) String 

func (x *Memo) String() string

type MeteringMetadata 

type MeteringMetadata struct {

	// Count of local activities which have begun an execution attempt during this workflow task,
	// and whose first attempt occurred in some previous task. This is used for metering
	// purposes, and does not affect workflow state.
	//
	// (-- api-linter: core::0141::forbidden-types=disabled
	//
	//	aip.dev/not-precedent: Negative values make no sense to represent. --)
	NonfirstLocalActivityExecutionAttempts uint32 `` /* 183-byte string literal not displayed */
	// contains filtered or unexported fields
}

Metadata relevant for metering purposes

func (*MeteringMetadata) Descriptor deprecated 

func (*MeteringMetadata) Descriptor() ([]byte, []int)

Deprecated: Use MeteringMetadata.ProtoReflect.Descriptor instead.

func (*MeteringMetadata) GetNonfirstLocalActivityExecutionAttempts 

func (x *MeteringMetadata) GetNonfirstLocalActivityExecutionAttempts() uint32

func (*MeteringMetadata) ProtoMessage 

func (*MeteringMetadata) ProtoMessage()

func (*MeteringMetadata) ProtoReflect 

func (x *MeteringMetadata) ProtoReflect() protoreflect.Message

func (*MeteringMetadata) Reset 

func (x *MeteringMetadata) Reset()

func (*MeteringMetadata) String 

func (x *MeteringMetadata) String() string

type Payload 

type Payload struct {
	Metadata map[string][]byte `` /* 157-byte string literal not displayed */
	Data     []byte            `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*Payload) Descriptor deprecated 

func (*Payload) Descriptor() ([]byte, []int)

Deprecated: Use Payload.ProtoReflect.Descriptor instead.

func (*Payload) GetData 

func (x *Payload) GetData() []byte

func (*Payload) GetMetadata 

func (x *Payload) GetMetadata() map[string][]byte

func (*Payload) ProtoMessage 

func (*Payload) ProtoMessage()

func (*Payload) ProtoReflect 

func (x *Payload) ProtoReflect() protoreflect.Message

func (*Payload) Reset 

func (x *Payload) Reset()

func (*Payload) String 

func (x *Payload) String() string

type Payloads 

type Payloads struct {
	Payloads []*Payload `protobuf:"bytes,1,rep,name=payloads,proto3" json:"payloads,omitempty"`
	// contains filtered or unexported fields
}

See `Payload`

func (*Payloads) Descriptor deprecated 

func (*Payloads) Descriptor() ([]byte, []int)

Deprecated: Use Payloads.ProtoReflect.Descriptor instead.

func (*Payloads) GetPayloads 

func (x *Payloads) GetPayloads() []*Payload

func (*Payloads) ProtoMessage 

func (*Payloads) ProtoMessage()

func (*Payloads) ProtoReflect 

func (x *Payloads) ProtoReflect() protoreflect.Message

func (*Payloads) Reset 

func (x *Payloads) Reset()

func (*Payloads) String 

func (x *Payloads) String() string

type RetryPolicy 

type RetryPolicy struct {

	// Interval of the first retry. If retryBackoffCoefficient is 1.0 then it is used for all retries.
	InitialInterval *durationpb.Duration `protobuf:"bytes,1,opt,name=initial_interval,json=initialInterval,proto3" json:"initial_interval,omitempty"`
	// Coefficient used to calculate the next retry interval.
	// The next retry interval is previous interval multiplied by the coefficient.
	// Must be 1 or larger.
	BackoffCoefficient float64 `protobuf:"fixed64,2,opt,name=backoff_coefficient,json=backoffCoefficient,proto3" json:"backoff_coefficient,omitempty"`
	// Maximum interval between retries. Exponential backoff leads to interval increase.
	// This value is the cap of the increase. Default is 100x of the initial interval.
	MaximumInterval *durationpb.Duration `protobuf:"bytes,3,opt,name=maximum_interval,json=maximumInterval,proto3" json:"maximum_interval,omitempty"`
	// Maximum number of attempts. When exceeded the retries stop even if not expired yet.
	// 1 disables retries. 0 means unlimited (up to the timeouts)
	MaximumAttempts int32 `protobuf:"varint,4,opt,name=maximum_attempts,json=maximumAttempts,proto3" json:"maximum_attempts,omitempty"`
	// Non-Retryable errors types. Will stop retrying if the error type matches this list. Note that
	// this is not a substring match, the error *type* (not message) must match exactly.
	NonRetryableErrorTypes []string `` /* 131-byte string literal not displayed */
	// contains filtered or unexported fields
}

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

func (*RetryPolicy) Descriptor deprecated 

func (*RetryPolicy) Descriptor() ([]byte, []int)

Deprecated: Use RetryPolicy.ProtoReflect.Descriptor instead.

func (*RetryPolicy) GetBackoffCoefficient 

func (x *RetryPolicy) GetBackoffCoefficient() float64

func (*RetryPolicy) GetInitialInterval 

func (x *RetryPolicy) GetInitialInterval() *durationpb.Duration

func (*RetryPolicy) GetMaximumAttempts 

func (x *RetryPolicy) GetMaximumAttempts() int32

func (*RetryPolicy) GetMaximumInterval 

func (x *RetryPolicy) GetMaximumInterval() *durationpb.Duration

func (*RetryPolicy) GetNonRetryableErrorTypes 

func (x *RetryPolicy) GetNonRetryableErrorTypes() []string

func (*RetryPolicy) ProtoMessage 

func (*RetryPolicy) ProtoMessage()

func (*RetryPolicy) ProtoReflect 

func (x *RetryPolicy) ProtoReflect() protoreflect.Message

func (*RetryPolicy) Reset 

func (x *RetryPolicy) Reset()

func (*RetryPolicy) String 

func (x *RetryPolicy) String() string

type SearchAttributes 

type SearchAttributes struct {
	IndexedFields map[string]*Payload `` /* 188-byte string literal not displayed */
	// contains filtered or unexported fields
}

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.

func (*SearchAttributes) Descriptor deprecated 

func (*SearchAttributes) Descriptor() ([]byte, []int)

Deprecated: Use SearchAttributes.ProtoReflect.Descriptor instead.

func (*SearchAttributes) GetIndexedFields 

func (x *SearchAttributes) GetIndexedFields() map[string]*Payload

func (*SearchAttributes) ProtoMessage 

func (*SearchAttributes) ProtoMessage()

func (*SearchAttributes) ProtoReflect 

func (x *SearchAttributes) ProtoReflect() protoreflect.Message

func (*SearchAttributes) Reset 

func (x *SearchAttributes) Reset()

func (*SearchAttributes) String 

func (x *SearchAttributes) String() string

type WorkerVersionCapabilities 

type WorkerVersionCapabilities struct {

	// An opaque whole-worker identifier
	BuildId string `protobuf:"bytes,1,opt,name=build_id,json=buildId,proto3" json:"build_id,omitempty"`
	// If set, the worker is opting in to worker versioning, and wishes to only receive appropriate
	// tasks.
	UseVersioning bool `protobuf:"varint,2,opt,name=use_versioning,json=useVersioning,proto3" json:"use_versioning,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*WorkerVersionCapabilities) Descriptor deprecated 

func (*WorkerVersionCapabilities) Descriptor() ([]byte, []int)

Deprecated: Use WorkerVersionCapabilities.ProtoReflect.Descriptor instead.

func (*WorkerVersionCapabilities) GetBuildId 

func (x *WorkerVersionCapabilities) GetBuildId() string

func (*WorkerVersionCapabilities) GetUseVersioning 

func (x *WorkerVersionCapabilities) GetUseVersioning() bool

func (*WorkerVersionCapabilities) ProtoMessage 

func (*WorkerVersionCapabilities) ProtoMessage()

func (*WorkerVersionCapabilities) ProtoReflect 

func (x *WorkerVersionCapabilities) ProtoReflect() protoreflect.Message

func (*WorkerVersionCapabilities) Reset 

func (x *WorkerVersionCapabilities) Reset()

func (*WorkerVersionCapabilities) String 

func (x *WorkerVersionCapabilities) String() string

type WorkerVersionStamp 

type WorkerVersionStamp struct {

	// An opaque whole-worker identifier. Replaces the deprecated `binary_checksum` field when this
	// message is included in requests which previously used that.
	BuildId string `protobuf:"bytes,1,opt,name=build_id,json=buildId,proto3" json:"build_id,omitempty"`
	// Set if the worker used a dynamically loadable bundle to process
	// the task. The bundle could be a WASM blob, JS bundle, etc.
	BundleId string `protobuf:"bytes,2,opt,name=bundle_id,json=bundleId,proto3" json:"bundle_id,omitempty"`
	// If set, the worker is opting in to worker versioning. Otherwise, this is used only as a
	// marker for workflow reset points and the BuildIDs search attribute.
	UseVersioning bool `protobuf:"varint,3,opt,name=use_versioning,json=useVersioning,proto3" json:"use_versioning,omitempty"`
	// contains filtered or unexported fields
}

Identifies the version(s) of a worker that processed a task

func (*WorkerVersionStamp) Descriptor deprecated 

func (*WorkerVersionStamp) Descriptor() ([]byte, []int)

Deprecated: Use WorkerVersionStamp.ProtoReflect.Descriptor instead.

func (*WorkerVersionStamp) GetBuildId 

func (x *WorkerVersionStamp) GetBuildId() string

func (*WorkerVersionStamp) GetBundleId 

func (x *WorkerVersionStamp) GetBundleId() string

func (*WorkerVersionStamp) GetUseVersioning 

func (x *WorkerVersionStamp) GetUseVersioning() bool

func (*WorkerVersionStamp) ProtoMessage 

func (*WorkerVersionStamp) ProtoMessage()

func (*WorkerVersionStamp) ProtoReflect 

func (x *WorkerVersionStamp) ProtoReflect() protoreflect.Message

func (*WorkerVersionStamp) Reset 

func (x *WorkerVersionStamp) Reset()

func (*WorkerVersionStamp) String 

func (x *WorkerVersionStamp) String() string

type WorkflowExecution 

type WorkflowExecution struct {
	WorkflowId string `protobuf:"bytes,1,opt,name=workflow_id,json=workflowId,proto3" json:"workflow_id,omitempty"`
	RunId      string `protobuf:"bytes,2,opt,name=run_id,json=runId,proto3" json:"run_id,omitempty"`
	// contains filtered or unexported fields
}

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

func (*WorkflowExecution) Descriptor deprecated 

func (*WorkflowExecution) Descriptor() ([]byte, []int)

Deprecated: Use WorkflowExecution.ProtoReflect.Descriptor instead.

func (*WorkflowExecution) GetRunId 

func (x *WorkflowExecution) GetRunId() string

func (*WorkflowExecution) GetWorkflowId 

func (x *WorkflowExecution) GetWorkflowId() string

func (*WorkflowExecution) ProtoMessage 

func (*WorkflowExecution) ProtoMessage()

func (*WorkflowExecution) ProtoReflect 

func (x *WorkflowExecution) ProtoReflect() protoreflect.Message

func (*WorkflowExecution) Reset 

func (x *WorkflowExecution) Reset()

func (*WorkflowExecution) String 

func (x *WorkflowExecution) String() string

type WorkflowType 

type WorkflowType struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

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"

func (*WorkflowType) Descriptor deprecated 

func (*WorkflowType) Descriptor() ([]byte, []int)

Deprecated: Use WorkflowType.ProtoReflect.Descriptor instead.

func (*WorkflowType) GetName 

func (x *WorkflowType) GetName() string

func (*WorkflowType) ProtoMessage 

func (*WorkflowType) ProtoMessage()

func (*WorkflowType) ProtoReflect 

func (x *WorkflowType) ProtoReflect() protoreflect.Message

func (*WorkflowType) Reset 

func (x *WorkflowType) Reset()

func (*WorkflowType) String 

func (x *WorkflowType) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.