common

package
v1.42.0 Latest Latest
Warning

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

 Go to latest Published: Nov 18, 2024 License: MIT Imports: 17 Imported by: 250

Documentation

Overview

Code generated by protoc-gen-go-helpers. DO NOT EDIT.

Index

Constants

View Source 
const EnablePayloadShorthandMetadataKey = "__temporal_enable_payload_shorthand"

Key on the marshaler metadata specifying whether shorthand is enabled.

WARNING: This is internal API and should not be called externally.

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) Equal 

func (this *ActivityType) Equal(that interface{}) bool

Equal returns whether two ActivityType values are equivalent by recursively comparing the message's fields. For more information see the documentation for https://pkg.go.dev/google.golang.org/protobuf/proto#Equal

func (*ActivityType) GetName 

func (x *ActivityType) GetName() string

func (*ActivityType) Marshal 

func (val *ActivityType) Marshal() ([]byte, error)

Marshal an object of type ActivityType to the protobuf v3 wire format

func (*ActivityType) ProtoMessage 

func (*ActivityType) ProtoMessage()

func (*ActivityType) ProtoReflect added in v1.26.1 

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

func (*ActivityType) Reset 

func (x *ActivityType) Reset()

func (*ActivityType) Size 

func (val *ActivityType) Size() int

Size returns the size of the object, in bytes, once serialized

func (*ActivityType) String 

func (x *ActivityType) String() string

func (*ActivityType) Unmarshal 

func (val *ActivityType) Unmarshal(buf []byte) error

Unmarshal an object of type ActivityType from the protobuf v3 wire format

type Callback added in v1.27.0 

type Callback struct {

	// Types that are assignable to Variant:
	//
	//	*Callback_Nexus_
	//	*Callback_Internal_
	Variant isCallback_Variant `protobuf_oneof:"variant"`
	// contains filtered or unexported fields
}

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

func (*Callback) Descriptor deprecated added in v1.27.0 

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

Deprecated: Use Callback.ProtoReflect.Descriptor instead.

func (*Callback) Equal added in v1.27.0 

func (this *Callback) Equal(that interface{}) bool

Equal returns whether two Callback values are equivalent by recursively comparing the message's fields. For more information see the documentation for https://pkg.go.dev/google.golang.org/protobuf/proto#Equal

func (*Callback) GetInternal added in v1.37.0 

func (x *Callback) GetInternal() *Callback_Internal

func (*Callback) GetNexus added in v1.27.0 

func (x *Callback) GetNexus() *Callback_Nexus

func (*Callback) GetVariant added in v1.27.0 

func (m *Callback) GetVariant() isCallback_Variant

func (*Callback) Marshal added in v1.27.0 

func (val *Callback) Marshal() ([]byte, error)

Marshal an object of type Callback to the protobuf v3 wire format

func (*Callback) ProtoMessage added in v1.27.0 

func (*Callback) ProtoMessage()

func (*Callback) ProtoReflect added in v1.27.0 

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

func (*Callback) Reset added in v1.27.0 

func (x *Callback) Reset()

func (*Callback) Size added in v1.27.0 

func (val *Callback) Size() int

Size returns the size of the object, in bytes, once serialized

func (*Callback) String added in v1.27.0 

func (x *Callback) String() string

func (*Callback) Unmarshal added in v1.27.0 

func (val *Callback) Unmarshal(buf []byte) error

Unmarshal an object of type Callback from the protobuf v3 wire format

type Callback_Internal added in v1.37.0 

type Callback_Internal struct {

	// Opaque internal data.
	Data []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*Callback_Internal) Descriptor deprecated added in v1.37.0 

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

Deprecated: Use Callback_Internal.ProtoReflect.Descriptor instead.

func (*Callback_Internal) GetData added in v1.37.0 

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

func (*Callback_Internal) ProtoMessage added in v1.37.0 

func (*Callback_Internal) ProtoMessage()

func (*Callback_Internal) ProtoReflect added in v1.37.0 

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

func (*Callback_Internal) Reset added in v1.37.0 

func (x *Callback_Internal) Reset()

func (*Callback_Internal) String added in v1.37.0 

func (x *Callback_Internal) String() string

type Callback_Internal_ added in v1.37.0 

type Callback_Internal_ struct {
	Internal *Callback_Internal `protobuf:"bytes,3,opt,name=internal,proto3,oneof"`
}

type Callback_Nexus added in v1.27.0 

type Callback_Nexus struct {

	// Callback URL.
	Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`
	// Header to attach to callback request.
	Header map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*Callback_Nexus) Descriptor deprecated added in v1.27.0 

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

Deprecated: Use Callback_Nexus.ProtoReflect.Descriptor instead.

func (*Callback_Nexus) GetHeader added in v1.32.1 

func (x *Callback_Nexus) GetHeader() map[string]string

func (*Callback_Nexus) GetUrl added in v1.27.0 

func (x *Callback_Nexus) GetUrl() string

func (*Callback_Nexus) ProtoMessage added in v1.27.0 

func (*Callback_Nexus) ProtoMessage()

func (*Callback_Nexus) ProtoReflect added in v1.27.0 

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

func (*Callback_Nexus) Reset added in v1.27.0 

func (x *Callback_Nexus) Reset()

func (*Callback_Nexus) String added in v1.27.0 

func (x *Callback_Nexus) String() string

type Callback_Nexus_ added in v1.27.0 

type Callback_Nexus_ struct {
	Nexus *Callback_Nexus `protobuf:"bytes,2,opt,name=nexus,proto3,oneof"`
}

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) Equal 

func (this *DataBlob) Equal(that interface{}) bool

Equal returns whether two DataBlob values are equivalent by recursively comparing the message's fields. For more information see the documentation for https://pkg.go.dev/google.golang.org/protobuf/proto#Equal

func (*DataBlob) GetData 

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

func (*DataBlob) GetEncodingType 

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

func (*DataBlob) Marshal 

func (val *DataBlob) Marshal() ([]byte, error)

Marshal an object of type DataBlob to the protobuf v3 wire format

func (*DataBlob) ProtoMessage 

func (*DataBlob) ProtoMessage()

func (*DataBlob) ProtoReflect added in v1.26.1 

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

func (*DataBlob) Reset 

func (x *DataBlob) Reset()

func (*DataBlob) Size 

func (val *DataBlob) Size() int

Size returns the size of the object, in bytes, once serialized

func (*DataBlob) String 

func (x *DataBlob) String() string

func (*DataBlob) Unmarshal 

func (val *DataBlob) Unmarshal(buf []byte) error

Unmarshal an object of type DataBlob from the protobuf v3 wire format 

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) Equal 

func (this *Header) Equal(that interface{}) bool

Equal returns whether two Header values are equivalent by recursively comparing the message's fields. For more information see the documentation for https://pkg.go.dev/google.golang.org/protobuf/proto#Equal

func (*Header) GetFields 

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

func (*Header) Marshal 

func (val *Header) Marshal() ([]byte, error)

Marshal an object of type Header to the protobuf v3 wire format

func (*Header) ProtoMessage 

func (*Header) ProtoMessage()

func (*Header) ProtoReflect added in v1.26.1 

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

func (*Header) Reset 

func (x *Header) Reset()

func (*Header) Size 

func (val *Header) Size() int

Size returns the size of the object, in bytes, once serialized

func (*Header) String 

func (x *Header) String() string

func (*Header) Unmarshal 

func (val *Header) Unmarshal(buf []byte) error

Unmarshal an object of type Header from the protobuf v3 wire format 

type Link struct {

	// Types that are assignable to Variant:
	//
	//	*Link_WorkflowEvent_
	//	*Link_BatchJob_
	Variant isLink_Variant `protobuf_oneof:"variant"`
	// contains filtered or unexported fields
}

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.

func (*Link) Descriptor deprecated added in v1.38.0 

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

Deprecated: Use Link.ProtoReflect.Descriptor instead.

func (*Link) Equal added in v1.38.0 

func (this *Link) Equal(that interface{}) bool

Equal returns whether two Link values are equivalent by recursively comparing the message's fields. For more information see the documentation for https://pkg.go.dev/google.golang.org/protobuf/proto#Equal

func (*Link) GetBatchJob added in v1.40.0 

func (x *Link) GetBatchJob() *Link_BatchJob

func (*Link) GetVariant added in v1.38.0 

func (m *Link) GetVariant() isLink_Variant

func (*Link) GetWorkflowEvent added in v1.38.0 

func (x *Link) GetWorkflowEvent() *Link_WorkflowEvent

func (*Link) Marshal added in v1.38.0 

func (val *Link) Marshal() ([]byte, error)

Marshal an object of type Link to the protobuf v3 wire format

func (*Link) ProtoMessage added in v1.38.0 

func (*Link) ProtoMessage()

func (*Link) ProtoReflect added in v1.38.0 

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

func (*Link) Reset added in v1.38.0 

func (x *Link) Reset()

func (*Link) Size added in v1.38.0 

func (val *Link) Size() int

Size returns the size of the object, in bytes, once serialized

func (*Link) String added in v1.38.0 

func (x *Link) String() string

func (*Link) Unmarshal added in v1.38.0 

func (val *Link) Unmarshal(buf []byte) error

Unmarshal an object of type Link from the protobuf v3 wire format 

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

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. 

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

Deprecated: Use Link_BatchJob.ProtoReflect.Descriptor instead. 

func (x *Link_BatchJob) GetJobId() string
func (*Link_BatchJob) ProtoMessage()
func (x *Link_BatchJob) ProtoReflect() protoreflect.Message
func (x *Link_BatchJob) Reset()
func (x *Link_BatchJob) String() string

type Link_BatchJob_ added in v1.40.0 

type Link_BatchJob_ struct {
	BatchJob *Link_BatchJob `protobuf:"bytes,2,opt,name=batch_job,json=batchJob,proto3,oneof"`
}
type Link_WorkflowEvent struct {
	Namespace  string `protobuf:"bytes,1,opt,name=namespace,proto3" json:"namespace,omitempty"`
	WorkflowId string `protobuf:"bytes,2,opt,name=workflow_id,json=workflowId,proto3" json:"workflow_id,omitempty"`
	RunId      string `protobuf:"bytes,3,opt,name=run_id,json=runId,proto3" json:"run_id,omitempty"`
	// Additional information about the workflow event.
	// Eg: the caller workflow can send the history event details that made the Nexus call.
	//
	// Types that are assignable to Reference:
	//
	//	*Link_WorkflowEvent_EventRef
	Reference isLink_WorkflowEvent_Reference `protobuf_oneof:"reference"`
	// contains filtered or unexported fields
}
func (*Link_WorkflowEvent) Descriptor() ([]byte, []int)

Deprecated: Use Link_WorkflowEvent.ProtoReflect.Descriptor instead. 

func (x *Link_WorkflowEvent) GetEventRef() *Link_WorkflowEvent_EventReference
func (x *Link_WorkflowEvent) GetNamespace() string
func (m *Link_WorkflowEvent) GetReference() isLink_WorkflowEvent_Reference
func (x *Link_WorkflowEvent) GetRunId() string
func (x *Link_WorkflowEvent) GetWorkflowId() string
func (*Link_WorkflowEvent) ProtoMessage()
func (x *Link_WorkflowEvent) ProtoReflect() protoreflect.Message
func (x *Link_WorkflowEvent) Reset()
func (x *Link_WorkflowEvent) String() string

type Link_WorkflowEvent_ added in v1.38.0 

type Link_WorkflowEvent_ struct {
	WorkflowEvent *Link_WorkflowEvent `protobuf:"bytes,1,opt,name=workflow_event,json=workflowEvent,proto3,oneof"`
}
type Link_WorkflowEvent_EventRef struct {
	EventRef *Link_WorkflowEvent_EventReference `protobuf:"bytes,100,opt,name=event_ref,json=eventRef,proto3,oneof"`
}
type Link_WorkflowEvent_EventReference struct {
	EventId   int64        `protobuf:"varint,1,opt,name=event_id,json=eventId,proto3" json:"event_id,omitempty"`
	EventType v1.EventType `` /* 126-byte string literal not displayed */
	// contains filtered or unexported fields
}
func (*Link_WorkflowEvent_EventReference) Descriptor() ([]byte, []int)

Deprecated: Use Link_WorkflowEvent_EventReference.ProtoReflect.Descriptor instead. 

func (x *Link_WorkflowEvent_EventReference) GetEventId() int64
func (x *Link_WorkflowEvent_EventReference) GetEventType() v1.EventType
func (*Link_WorkflowEvent_EventReference) ProtoMessage()
func (x *Link_WorkflowEvent_EventReference) ProtoReflect() protoreflect.Message
func (x *Link_WorkflowEvent_EventReference) Reset()
func (x *Link_WorkflowEvent_EventReference) 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) Equal 

func (this *Memo) Equal(that interface{}) bool

Equal returns whether two Memo values are equivalent by recursively comparing the message's fields. For more information see the documentation for https://pkg.go.dev/google.golang.org/protobuf/proto#Equal

func (*Memo) GetFields 

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

func (*Memo) Marshal 

func (val *Memo) Marshal() ([]byte, error)

Marshal an object of type Memo to the protobuf v3 wire format

func (*Memo) ProtoMessage 

func (*Memo) ProtoMessage()

func (*Memo) ProtoReflect added in v1.26.1 

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

func (*Memo) Reset 

func (x *Memo) Reset()

func (*Memo) Size 

func (val *Memo) Size() int

Size returns the size of the object, in bytes, once serialized

func (*Memo) String 

func (x *Memo) String() string

func (*Memo) Unmarshal 

func (val *Memo) Unmarshal(buf []byte) error

Unmarshal an object of type Memo from the protobuf v3 wire format

type MeteringMetadata added in v1.18.1 

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 added in v1.18.1 

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

Deprecated: Use MeteringMetadata.ProtoReflect.Descriptor instead.

func (*MeteringMetadata) Equal added in v1.18.1 

func (this *MeteringMetadata) Equal(that interface{}) bool

Equal returns whether two MeteringMetadata values are equivalent by recursively comparing the message's fields. For more information see the documentation for https://pkg.go.dev/google.golang.org/protobuf/proto#Equal

func (*MeteringMetadata) GetNonfirstLocalActivityExecutionAttempts added in v1.18.1 

func (x *MeteringMetadata) GetNonfirstLocalActivityExecutionAttempts() uint32

func (*MeteringMetadata) Marshal added in v1.18.1 

func (val *MeteringMetadata) Marshal() ([]byte, error)

Marshal an object of type MeteringMetadata to the protobuf v3 wire format

func (*MeteringMetadata) ProtoMessage added in v1.18.1 

func (*MeteringMetadata) ProtoMessage()

func (*MeteringMetadata) ProtoReflect added in v1.26.1 

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

func (*MeteringMetadata) Reset added in v1.18.1 

func (x *MeteringMetadata) Reset()

func (*MeteringMetadata) Size added in v1.18.1 

func (val *MeteringMetadata) Size() int

Size returns the size of the object, in bytes, once serialized

func (*MeteringMetadata) String added in v1.18.1 

func (x *MeteringMetadata) String() string

func (*MeteringMetadata) Unmarshal added in v1.18.1 

func (val *MeteringMetadata) Unmarshal(buf []byte) error

Unmarshal an object of type MeteringMetadata from the protobuf v3 wire format

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) Equal 

func (this *Payload) Equal(that interface{}) bool

Equal returns whether two Payload values are equivalent by recursively comparing the message's fields. For more information see the documentation for https://pkg.go.dev/google.golang.org/protobuf/proto#Equal

func (*Payload) GetData 

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

func (*Payload) GetMetadata 

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

func (*Payload) Marshal 

func (val *Payload) Marshal() ([]byte, error)

Marshal an object of type Payload to the protobuf v3 wire format

func (*Payload) MaybeMarshalProtoJSON added in v1.26.1 

func (p *Payload) MaybeMarshalProtoJSON(meta map[string]interface{}, enc *json.Encoder) (handled bool, err error)

MaybeMarshalProtoJSON implements go.temporal.io/api/internal/temporaljsonpb.ProtoJSONMaybeMarshaler.MaybeMarshalProtoJSON.

WARNING: This is internal API and should not be called externally.

func (*Payload) MaybeUnmarshalProtoJSON added in v1.26.1 

func (p *Payload) MaybeUnmarshalProtoJSON(meta map[string]interface{}, dec *json.Decoder) (handled bool, err error)

MaybeUnmarshalProtoJSON implements go.temporal.io/api/internal/temporaljsonpb.ProtoJSONMaybeUnmarshaler.MaybeUnmarshalProtoJSON.

WARNING: This is internal API and should not be called externally.

func (*Payload) ProtoMessage 

func (*Payload) ProtoMessage()

func (*Payload) ProtoReflect added in v1.26.1 

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

func (*Payload) Reset 

func (x *Payload) Reset()

func (*Payload) Size 

func (val *Payload) Size() int

Size returns the size of the object, in bytes, once serialized

func (*Payload) String 

func (x *Payload) String() string

func (*Payload) Unmarshal 

func (val *Payload) Unmarshal(buf []byte) error

Unmarshal an object of type Payload from the protobuf v3 wire format

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) Equal 

func (this *Payloads) Equal(that interface{}) bool

Equal returns whether two Payloads values are equivalent by recursively comparing the message's fields. For more information see the documentation for https://pkg.go.dev/google.golang.org/protobuf/proto#Equal

func (*Payloads) GetPayloads 

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

func (*Payloads) Marshal 

func (val *Payloads) Marshal() ([]byte, error)

Marshal an object of type Payloads to the protobuf v3 wire format

func (*Payloads) MaybeMarshalProtoJSON added in v1.26.1 

func (p *Payloads) MaybeMarshalProtoJSON(meta map[string]interface{}, enc *json.Encoder) (handled bool, err error)

MaybeMarshalProtoJSON implements go.temporal.io/api/internal/temporaljsonpb.ProtoJSONMaybeMarshaler.MaybeMarshalProtoJSON.

WARNING: This is internal API and should not be called externally.

func (*Payloads) MaybeUnmarshalProtoJSON added in v1.26.1 

func (p *Payloads) MaybeUnmarshalProtoJSON(meta map[string]interface{}, dec *json.Decoder) (handled bool, err error)

MaybeUnmarshalProtoJSON implements go.temporal.io/api/internal/temporaljsonpb.ProtoJSONMaybeUnmarshaler.MaybeUnmarshalProtoJSON.

WARNING: This is internal API and should not be called externally.

func (*Payloads) ProtoMessage 

func (*Payloads) ProtoMessage()

func (*Payloads) ProtoReflect added in v1.26.1 

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

func (*Payloads) Reset 

func (x *Payloads) Reset()

func (*Payloads) Size 

func (val *Payloads) Size() int

Size returns the size of the object, in bytes, once serialized

func (*Payloads) String 

func (x *Payloads) String() string

func (*Payloads) Unmarshal 

func (val *Payloads) Unmarshal(buf []byte) error

Unmarshal an object of type Payloads from the protobuf v3 wire format

type ResetOptions added in v1.26.2 

type ResetOptions struct {

	// Which workflow task to reset to.
	//
	// Types that are assignable to Target:
	//
	//	*ResetOptions_FirstWorkflowTask
	//	*ResetOptions_LastWorkflowTask
	//	*ResetOptions_WorkflowTaskId
	//	*ResetOptions_BuildId
	Target isResetOptions_Target `protobuf_oneof:"target"`
	// Event types to be reapplied (deprecated)
	// Default: RESET_REAPPLY_TYPE_SIGNAL
	ResetReapplyType v1.ResetReapplyType `` /* 157-byte string literal not displayed */
	// If true, limit the reset to only within the current run. (Applies to build_id targets and
	// possibly others in the future.)
	CurrentRunOnly bool `protobuf:"varint,11,opt,name=current_run_only,json=currentRunOnly,proto3" json:"current_run_only,omitempty"`
	// Event types not to be reapplied
	ResetReapplyExcludeTypes []v1.ResetReapplyExcludeType `` /* 197-byte string literal not displayed */
	// contains filtered or unexported fields
}

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

func (*ResetOptions) Descriptor deprecated added in v1.26.2 

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

Deprecated: Use ResetOptions.ProtoReflect.Descriptor instead.

func (*ResetOptions) Equal added in v1.26.2 

func (this *ResetOptions) Equal(that interface{}) bool

Equal returns whether two ResetOptions values are equivalent by recursively comparing the message's fields. For more information see the documentation for https://pkg.go.dev/google.golang.org/protobuf/proto#Equal

func (*ResetOptions) GetBuildId added in v1.26.2 

func (x *ResetOptions) GetBuildId() string

func (*ResetOptions) GetCurrentRunOnly added in v1.26.2 

func (x *ResetOptions) GetCurrentRunOnly() bool

func (*ResetOptions) GetFirstWorkflowTask added in v1.26.2 

func (x *ResetOptions) GetFirstWorkflowTask() *emptypb.Empty

func (*ResetOptions) GetLastWorkflowTask added in v1.26.2 

func (x *ResetOptions) GetLastWorkflowTask() *emptypb.Empty

func (*ResetOptions) GetResetReapplyExcludeTypes added in v1.32.1 

func (x *ResetOptions) GetResetReapplyExcludeTypes() []v1.ResetReapplyExcludeType

func (*ResetOptions) GetResetReapplyType added in v1.26.2 

func (x *ResetOptions) GetResetReapplyType() v1.ResetReapplyType

func (*ResetOptions) GetTarget added in v1.26.2 

func (m *ResetOptions) GetTarget() isResetOptions_Target

func (*ResetOptions) GetWorkflowTaskId added in v1.26.2 

func (x *ResetOptions) GetWorkflowTaskId() int64

func (*ResetOptions) Marshal added in v1.26.2 

func (val *ResetOptions) Marshal() ([]byte, error)

Marshal an object of type ResetOptions to the protobuf v3 wire format

func (*ResetOptions) ProtoMessage added in v1.26.2 

func (*ResetOptions) ProtoMessage()

func (*ResetOptions) ProtoReflect added in v1.26.2 

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

func (*ResetOptions) Reset added in v1.26.2 

func (x *ResetOptions) Reset()

func (*ResetOptions) Size added in v1.26.2 

func (val *ResetOptions) Size() int

Size returns the size of the object, in bytes, once serialized

func (*ResetOptions) String added in v1.26.2 

func (x *ResetOptions) String() string

func (*ResetOptions) Unmarshal added in v1.26.2 

func (val *ResetOptions) Unmarshal(buf []byte) error

Unmarshal an object of type ResetOptions from the protobuf v3 wire format

type ResetOptions_BuildId added in v1.26.2 

type ResetOptions_BuildId struct {
	// Resets to the first workflow task processed by this build id.
	// If the workflow was not processed by the build id, or the workflow task can't be
	// determined, no reset will be performed.
	// Note that by default, this reset is allowed to be to a prior run in a chain of
	// continue-as-new.
	BuildId string `protobuf:"bytes,4,opt,name=build_id,json=buildId,proto3,oneof"`
}

type ResetOptions_FirstWorkflowTask added in v1.26.2 

type ResetOptions_FirstWorkflowTask struct {
	// Resets to the first workflow task completed or started event.
	FirstWorkflowTask *emptypb.Empty `protobuf:"bytes,1,opt,name=first_workflow_task,json=firstWorkflowTask,proto3,oneof"`
}

type ResetOptions_LastWorkflowTask added in v1.26.2 

type ResetOptions_LastWorkflowTask struct {
	// Resets to the last workflow task completed or started event.
	LastWorkflowTask *emptypb.Empty `protobuf:"bytes,2,opt,name=last_workflow_task,json=lastWorkflowTask,proto3,oneof"`
}

type ResetOptions_WorkflowTaskId added in v1.26.2 

type ResetOptions_WorkflowTaskId struct {
	// The id of a specific `WORKFLOW_TASK_COMPLETED`,`WORKFLOW_TASK_TIMED_OUT`, `WORKFLOW_TASK_FAILED`, or
	// `WORKFLOW_TASK_STARTED` event to reset to.
	// Note that this option doesn't make sense when used as part of a batch request.
	WorkflowTaskId int64 `protobuf:"varint,3,opt,name=workflow_task_id,json=workflowTaskId,proto3,oneof"`
}

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) Equal 

func (this *RetryPolicy) Equal(that interface{}) bool

Equal returns whether two RetryPolicy values are equivalent by recursively comparing the message's fields. For more information see the documentation for https://pkg.go.dev/google.golang.org/protobuf/proto#Equal

func (*RetryPolicy) GetBackoffCoefficient 

func (x *RetryPolicy) GetBackoffCoefficient() float64

func (*RetryPolicy) GetInitialInterval added in v0.28.0 

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

func (*RetryPolicy) GetMaximumAttempts 

func (x *RetryPolicy) GetMaximumAttempts() int32

func (*RetryPolicy) GetMaximumInterval added in v0.28.0 

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

func (*RetryPolicy) GetNonRetryableErrorTypes 

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

func (*RetryPolicy) Marshal 

func (val *RetryPolicy) Marshal() ([]byte, error)

Marshal an object of type RetryPolicy to the protobuf v3 wire format

func (*RetryPolicy) ProtoMessage 

func (*RetryPolicy) ProtoMessage()

func (*RetryPolicy) ProtoReflect added in v1.26.1 

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

func (*RetryPolicy) Reset 

func (x *RetryPolicy) Reset()

func (*RetryPolicy) Size 

func (val *RetryPolicy) Size() int

Size returns the size of the object, in bytes, once serialized

func (*RetryPolicy) String 

func (x *RetryPolicy) String() string

func (*RetryPolicy) Unmarshal 

func (val *RetryPolicy) Unmarshal(buf []byte) error

Unmarshal an object of type RetryPolicy from the protobuf v3 wire format

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) Equal 

func (this *SearchAttributes) Equal(that interface{}) bool

Equal returns whether two SearchAttributes values are equivalent by recursively comparing the message's fields. For more information see the documentation for https://pkg.go.dev/google.golang.org/protobuf/proto#Equal

func (*SearchAttributes) GetIndexedFields 

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

func (*SearchAttributes) Marshal 

func (val *SearchAttributes) Marshal() ([]byte, error)

Marshal an object of type SearchAttributes to the protobuf v3 wire format

func (*SearchAttributes) ProtoMessage 

func (*SearchAttributes) ProtoMessage()

func (*SearchAttributes) ProtoReflect added in v1.26.1 

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

func (*SearchAttributes) Reset 

func (x *SearchAttributes) Reset()

func (*SearchAttributes) Size 

func (val *SearchAttributes) Size() int

Size returns the size of the object, in bytes, once serialized

func (*SearchAttributes) String 

func (x *SearchAttributes) String() string

func (*SearchAttributes) Unmarshal 

func (val *SearchAttributes) Unmarshal(buf []byte) error

Unmarshal an object of type SearchAttributes from the protobuf v3 wire format

type WorkerVersionCapabilities added in v1.19.0 

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 added in v1.19.0 

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

Deprecated: Use WorkerVersionCapabilities.ProtoReflect.Descriptor instead.

func (*WorkerVersionCapabilities) Equal added in v1.19.0 

func (this *WorkerVersionCapabilities) Equal(that interface{}) bool

Equal returns whether two WorkerVersionCapabilities values are equivalent by recursively comparing the message's fields. For more information see the documentation for https://pkg.go.dev/google.golang.org/protobuf/proto#Equal

func (*WorkerVersionCapabilities) GetBuildId added in v1.19.0 

func (x *WorkerVersionCapabilities) GetBuildId() string

func (*WorkerVersionCapabilities) GetUseVersioning added in v1.21.0 

func (x *WorkerVersionCapabilities) GetUseVersioning() bool

func (*WorkerVersionCapabilities) Marshal added in v1.19.0 

func (val *WorkerVersionCapabilities) Marshal() ([]byte, error)

Marshal an object of type WorkerVersionCapabilities to the protobuf v3 wire format

func (*WorkerVersionCapabilities) ProtoMessage added in v1.19.0 

func (*WorkerVersionCapabilities) ProtoMessage()

func (*WorkerVersionCapabilities) ProtoReflect added in v1.26.1 

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

func (*WorkerVersionCapabilities) Reset added in v1.19.0 

func (x *WorkerVersionCapabilities) Reset()

func (*WorkerVersionCapabilities) Size added in v1.19.0 

func (val *WorkerVersionCapabilities) Size() int

Size returns the size of the object, in bytes, once serialized

func (*WorkerVersionCapabilities) String added in v1.19.0 

func (x *WorkerVersionCapabilities) String() string

func (*WorkerVersionCapabilities) Unmarshal added in v1.19.0 

func (val *WorkerVersionCapabilities) Unmarshal(buf []byte) error

Unmarshal an object of type WorkerVersionCapabilities from the protobuf v3 wire format

type WorkerVersionStamp added in v1.19.0 

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"`
	// 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 added in v1.19.0 

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

Deprecated: Use WorkerVersionStamp.ProtoReflect.Descriptor instead.

func (*WorkerVersionStamp) Equal added in v1.19.0 

func (this *WorkerVersionStamp) Equal(that interface{}) bool

Equal returns whether two WorkerVersionStamp values are equivalent by recursively comparing the message's fields. For more information see the documentation for https://pkg.go.dev/google.golang.org/protobuf/proto#Equal

func (*WorkerVersionStamp) GetBuildId added in v1.19.0 

func (x *WorkerVersionStamp) GetBuildId() string

func (*WorkerVersionStamp) GetUseVersioning added in v1.21.0 

func (x *WorkerVersionStamp) GetUseVersioning() bool

func (*WorkerVersionStamp) Marshal added in v1.19.0 

func (val *WorkerVersionStamp) Marshal() ([]byte, error)

Marshal an object of type WorkerVersionStamp to the protobuf v3 wire format

func (*WorkerVersionStamp) ProtoMessage added in v1.19.0 

func (*WorkerVersionStamp) ProtoMessage()

func (*WorkerVersionStamp) ProtoReflect added in v1.26.1 

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

func (*WorkerVersionStamp) Reset added in v1.19.0 

func (x *WorkerVersionStamp) Reset()

func (*WorkerVersionStamp) Size added in v1.19.0 

func (val *WorkerVersionStamp) Size() int

Size returns the size of the object, in bytes, once serialized

func (*WorkerVersionStamp) String added in v1.19.0 

func (x *WorkerVersionStamp) String() string

func (*WorkerVersionStamp) Unmarshal added in v1.19.0 

func (val *WorkerVersionStamp) Unmarshal(buf []byte) error

Unmarshal an object of type WorkerVersionStamp from the protobuf v3 wire format

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) Equal 

func (this *WorkflowExecution) Equal(that interface{}) bool

Equal returns whether two WorkflowExecution values are equivalent by recursively comparing the message's fields. For more information see the documentation for https://pkg.go.dev/google.golang.org/protobuf/proto#Equal

func (*WorkflowExecution) GetRunId 

func (x *WorkflowExecution) GetRunId() string

func (*WorkflowExecution) GetWorkflowId 

func (x *WorkflowExecution) GetWorkflowId() string

func (*WorkflowExecution) Marshal 

func (val *WorkflowExecution) Marshal() ([]byte, error)

Marshal an object of type WorkflowExecution to the protobuf v3 wire format

func (*WorkflowExecution) ProtoMessage 

func (*WorkflowExecution) ProtoMessage()

func (*WorkflowExecution) ProtoReflect added in v1.26.1 

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

func (*WorkflowExecution) Reset 

func (x *WorkflowExecution) Reset()

func (*WorkflowExecution) Size 

func (val *WorkflowExecution) Size() int

Size returns the size of the object, in bytes, once serialized

func (*WorkflowExecution) String 

func (x *WorkflowExecution) String() string

func (*WorkflowExecution) Unmarshal 

func (val *WorkflowExecution) Unmarshal(buf []byte) error

Unmarshal an object of type WorkflowExecution from the protobuf v3 wire format

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) Equal 

func (this *WorkflowType) Equal(that interface{}) bool

Equal returns whether two WorkflowType values are equivalent by recursively comparing the message's fields. For more information see the documentation for https://pkg.go.dev/google.golang.org/protobuf/proto#Equal

func (*WorkflowType) GetName 

func (x *WorkflowType) GetName() string

func (*WorkflowType) Marshal 

func (val *WorkflowType) Marshal() ([]byte, error)

Marshal an object of type WorkflowType to the protobuf v3 wire format

func (*WorkflowType) ProtoMessage 

func (*WorkflowType) ProtoMessage()

func (*WorkflowType) ProtoReflect added in v1.26.1 

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

func (*WorkflowType) Reset 

func (x *WorkflowType) Reset()

func (*WorkflowType) Size 

func (val *WorkflowType) Size() int

Size returns the size of the object, in bytes, once serialized

func (*WorkflowType) String 

func (x *WorkflowType) String() string

func (*WorkflowType) Unmarshal 

func (val *WorkflowType) Unmarshal(buf []byte) error

Unmarshal an object of type WorkflowType from the protobuf v3 wire format

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.