Documentation ¶
Overview ¶
Code generated by protoc-gen-go-helpers. DO NOT EDIT.
Index ¶
- Variables
- type BuildIdAssignmentRule
- func (*BuildIdAssignmentRule) Descriptor() ([]byte, []int)deprecated
- func (this *BuildIdAssignmentRule) Equal(that interface{}) bool
- func (x *BuildIdAssignmentRule) GetPercentageRamp() *RampByPercentage
- func (m *BuildIdAssignmentRule) GetRamp() isBuildIdAssignmentRule_Ramp
- func (x *BuildIdAssignmentRule) GetTargetBuildId() string
- func (val *BuildIdAssignmentRule) Marshal() ([]byte, error)
- func (*BuildIdAssignmentRule) ProtoMessage()
- func (x *BuildIdAssignmentRule) ProtoReflect() protoreflect.Message
- func (x *BuildIdAssignmentRule) Reset()
- func (val *BuildIdAssignmentRule) Size() int
- func (x *BuildIdAssignmentRule) String() string
- func (val *BuildIdAssignmentRule) Unmarshal(buf []byte) error
- type BuildIdAssignmentRule_PercentageRamp
- type BuildIdReachability
- func (*BuildIdReachability) Descriptor() ([]byte, []int)deprecated
- func (this *BuildIdReachability) Equal(that interface{}) bool
- func (x *BuildIdReachability) GetBuildId() string
- func (x *BuildIdReachability) GetTaskQueueReachability() []*TaskQueueReachability
- func (val *BuildIdReachability) Marshal() ([]byte, error)
- func (*BuildIdReachability) ProtoMessage()
- func (x *BuildIdReachability) ProtoReflect() protoreflect.Message
- func (x *BuildIdReachability) Reset()
- func (val *BuildIdReachability) Size() int
- func (x *BuildIdReachability) String() string
- func (val *BuildIdReachability) Unmarshal(buf []byte) error
- type CompatibleBuildIdRedirectRule
- func (*CompatibleBuildIdRedirectRule) Descriptor() ([]byte, []int)deprecated
- func (this *CompatibleBuildIdRedirectRule) Equal(that interface{}) bool
- func (x *CompatibleBuildIdRedirectRule) GetSourceBuildId() string
- func (x *CompatibleBuildIdRedirectRule) GetTargetBuildId() string
- func (val *CompatibleBuildIdRedirectRule) Marshal() ([]byte, error)
- func (*CompatibleBuildIdRedirectRule) ProtoMessage()
- func (x *CompatibleBuildIdRedirectRule) ProtoReflect() protoreflect.Message
- func (x *CompatibleBuildIdRedirectRule) Reset()
- func (val *CompatibleBuildIdRedirectRule) Size() int
- func (x *CompatibleBuildIdRedirectRule) String() string
- func (val *CompatibleBuildIdRedirectRule) Unmarshal(buf []byte) error
- type CompatibleVersionSet
- func (*CompatibleVersionSet) Descriptor() ([]byte, []int)deprecated
- func (this *CompatibleVersionSet) Equal(that interface{}) bool
- func (x *CompatibleVersionSet) GetBuildIds() []string
- func (val *CompatibleVersionSet) Marshal() ([]byte, error)
- func (*CompatibleVersionSet) ProtoMessage()
- func (x *CompatibleVersionSet) ProtoReflect() protoreflect.Message
- func (x *CompatibleVersionSet) Reset()
- func (val *CompatibleVersionSet) Size() int
- func (x *CompatibleVersionSet) String() string
- func (val *CompatibleVersionSet) Unmarshal(buf []byte) error
- type PollerInfo
- func (*PollerInfo) Descriptor() ([]byte, []int)deprecated
- func (this *PollerInfo) Equal(that interface{}) bool
- func (x *PollerInfo) GetIdentity() string
- func (x *PollerInfo) GetLastAccessTime() *timestamppb.Timestamp
- func (x *PollerInfo) GetRatePerSecond() float64
- func (x *PollerInfo) GetWorkerVersionCapabilities() *v11.WorkerVersionCapabilities
- func (val *PollerInfo) Marshal() ([]byte, error)
- func (*PollerInfo) ProtoMessage()
- func (x *PollerInfo) ProtoReflect() protoreflect.Message
- func (x *PollerInfo) Reset()
- func (val *PollerInfo) Size() int
- func (x *PollerInfo) String() string
- func (val *PollerInfo) Unmarshal(buf []byte) error
- type RampByPercentage
- func (*RampByPercentage) Descriptor() ([]byte, []int)deprecated
- func (this *RampByPercentage) Equal(that interface{}) bool
- func (x *RampByPercentage) GetRampPercentage() float32
- func (val *RampByPercentage) Marshal() ([]byte, error)
- func (*RampByPercentage) ProtoMessage()
- func (x *RampByPercentage) ProtoReflect() protoreflect.Message
- func (x *RampByPercentage) Reset()
- func (val *RampByPercentage) Size() int
- func (x *RampByPercentage) String() string
- func (val *RampByPercentage) Unmarshal(buf []byte) error
- type StickyExecutionAttributes
- func (*StickyExecutionAttributes) Descriptor() ([]byte, []int)deprecated
- func (this *StickyExecutionAttributes) Equal(that interface{}) bool
- func (x *StickyExecutionAttributes) GetScheduleToStartTimeout() *durationpb.Duration
- func (x *StickyExecutionAttributes) GetWorkerTaskQueue() *TaskQueue
- func (val *StickyExecutionAttributes) Marshal() ([]byte, error)
- func (*StickyExecutionAttributes) ProtoMessage()
- func (x *StickyExecutionAttributes) ProtoReflect() protoreflect.Message
- func (x *StickyExecutionAttributes) Reset()
- func (val *StickyExecutionAttributes) Size() int
- func (x *StickyExecutionAttributes) String() string
- func (val *StickyExecutionAttributes) Unmarshal(buf []byte) error
- type TaskIdBlock
- func (*TaskIdBlock) Descriptor() ([]byte, []int)deprecated
- func (this *TaskIdBlock) Equal(that interface{}) bool
- func (x *TaskIdBlock) GetEndId() int64
- func (x *TaskIdBlock) GetStartId() int64
- func (val *TaskIdBlock) Marshal() ([]byte, error)
- func (*TaskIdBlock) ProtoMessage()
- func (x *TaskIdBlock) ProtoReflect() protoreflect.Message
- func (x *TaskIdBlock) Reset()
- func (val *TaskIdBlock) Size() int
- func (x *TaskIdBlock) String() string
- func (val *TaskIdBlock) Unmarshal(buf []byte) error
- type TaskQueue
- func (*TaskQueue) Descriptor() ([]byte, []int)deprecated
- func (this *TaskQueue) Equal(that interface{}) bool
- func (x *TaskQueue) GetKind() v1.TaskQueueKind
- func (x *TaskQueue) GetName() string
- func (x *TaskQueue) GetNormalName() string
- func (val *TaskQueue) Marshal() ([]byte, error)
- func (*TaskQueue) ProtoMessage()
- func (x *TaskQueue) ProtoReflect() protoreflect.Message
- func (x *TaskQueue) Reset()
- func (val *TaskQueue) Size() int
- func (x *TaskQueue) String() string
- func (val *TaskQueue) Unmarshal(buf []byte) error
- type TaskQueueMetadata
- func (*TaskQueueMetadata) Descriptor() ([]byte, []int)deprecated
- func (this *TaskQueueMetadata) Equal(that interface{}) bool
- func (x *TaskQueueMetadata) GetMaxTasksPerSecond() *wrapperspb.DoubleValue
- func (val *TaskQueueMetadata) Marshal() ([]byte, error)
- func (*TaskQueueMetadata) ProtoMessage()
- func (x *TaskQueueMetadata) ProtoReflect() protoreflect.Message
- func (x *TaskQueueMetadata) Reset()
- func (val *TaskQueueMetadata) Size() int
- func (x *TaskQueueMetadata) String() string
- func (val *TaskQueueMetadata) Unmarshal(buf []byte) error
- type TaskQueuePartitionMetadata
- func (*TaskQueuePartitionMetadata) Descriptor() ([]byte, []int)deprecated
- func (this *TaskQueuePartitionMetadata) Equal(that interface{}) bool
- func (x *TaskQueuePartitionMetadata) GetKey() string
- func (x *TaskQueuePartitionMetadata) GetOwnerHostName() string
- func (val *TaskQueuePartitionMetadata) Marshal() ([]byte, error)
- func (*TaskQueuePartitionMetadata) ProtoMessage()
- func (x *TaskQueuePartitionMetadata) ProtoReflect() protoreflect.Message
- func (x *TaskQueuePartitionMetadata) Reset()
- func (val *TaskQueuePartitionMetadata) Size() int
- func (x *TaskQueuePartitionMetadata) String() string
- func (val *TaskQueuePartitionMetadata) Unmarshal(buf []byte) error
- type TaskQueueReachability
- func (*TaskQueueReachability) Descriptor() ([]byte, []int)deprecated
- func (this *TaskQueueReachability) Equal(that interface{}) bool
- func (x *TaskQueueReachability) GetReachability() []v1.TaskReachability
- func (x *TaskQueueReachability) GetTaskQueue() string
- func (val *TaskQueueReachability) Marshal() ([]byte, error)
- func (*TaskQueueReachability) ProtoMessage()
- func (x *TaskQueueReachability) ProtoReflect() protoreflect.Message
- func (x *TaskQueueReachability) Reset()
- func (val *TaskQueueReachability) Size() int
- func (x *TaskQueueReachability) String() string
- func (val *TaskQueueReachability) Unmarshal(buf []byte) error
- type TaskQueueStats
- func (*TaskQueueStats) Descriptor() ([]byte, []int)deprecated
- func (this *TaskQueueStats) Equal(that interface{}) bool
- func (x *TaskQueueStats) GetApproximateBacklogAge() *durationpb.Duration
- func (x *TaskQueueStats) GetApproximateBacklogCount() int64
- func (x *TaskQueueStats) GetTasksAddRate() float32
- func (x *TaskQueueStats) GetTasksDispatchRate() float32
- func (val *TaskQueueStats) Marshal() ([]byte, error)
- func (*TaskQueueStats) ProtoMessage()
- func (x *TaskQueueStats) ProtoReflect() protoreflect.Message
- func (x *TaskQueueStats) Reset()
- func (val *TaskQueueStats) Size() int
- func (x *TaskQueueStats) String() string
- func (val *TaskQueueStats) Unmarshal(buf []byte) error
- type TaskQueueStatus
- func (*TaskQueueStatus) Descriptor() ([]byte, []int)deprecated
- func (this *TaskQueueStatus) Equal(that interface{}) bool
- func (x *TaskQueueStatus) GetAckLevel() int64
- func (x *TaskQueueStatus) GetBacklogCountHint() int64
- func (x *TaskQueueStatus) GetRatePerSecond() float64
- func (x *TaskQueueStatus) GetReadLevel() int64
- func (x *TaskQueueStatus) GetTaskIdBlock() *TaskIdBlock
- func (val *TaskQueueStatus) Marshal() ([]byte, error)
- func (*TaskQueueStatus) ProtoMessage()
- func (x *TaskQueueStatus) ProtoReflect() protoreflect.Message
- func (x *TaskQueueStatus) Reset()
- func (val *TaskQueueStatus) Size() int
- func (x *TaskQueueStatus) String() string
- func (val *TaskQueueStatus) Unmarshal(buf []byte) error
- type TaskQueueTypeInfo
- func (*TaskQueueTypeInfo) Descriptor() ([]byte, []int)deprecated
- func (this *TaskQueueTypeInfo) Equal(that interface{}) bool
- func (x *TaskQueueTypeInfo) GetPollers() []*PollerInfo
- func (x *TaskQueueTypeInfo) GetStats() *TaskQueueStats
- func (val *TaskQueueTypeInfo) Marshal() ([]byte, error)
- func (*TaskQueueTypeInfo) ProtoMessage()
- func (x *TaskQueueTypeInfo) ProtoReflect() protoreflect.Message
- func (x *TaskQueueTypeInfo) Reset()
- func (val *TaskQueueTypeInfo) Size() int
- func (x *TaskQueueTypeInfo) String() string
- func (val *TaskQueueTypeInfo) Unmarshal(buf []byte) error
- type TaskQueueVersionInfo
- func (*TaskQueueVersionInfo) Descriptor() ([]byte, []int)deprecated
- func (this *TaskQueueVersionInfo) Equal(that interface{}) bool
- func (x *TaskQueueVersionInfo) GetTaskReachability() v1.BuildIdTaskReachability
- func (x *TaskQueueVersionInfo) GetTypesInfo() map[int32]*TaskQueueTypeInfo
- func (val *TaskQueueVersionInfo) Marshal() ([]byte, error)
- func (*TaskQueueVersionInfo) ProtoMessage()
- func (x *TaskQueueVersionInfo) ProtoReflect() protoreflect.Message
- func (x *TaskQueueVersionInfo) Reset()
- func (val *TaskQueueVersionInfo) Size() int
- func (x *TaskQueueVersionInfo) String() string
- func (val *TaskQueueVersionInfo) Unmarshal(buf []byte) error
- type TaskQueueVersionSelection
- func (*TaskQueueVersionSelection) Descriptor() ([]byte, []int)deprecated
- func (this *TaskQueueVersionSelection) Equal(that interface{}) bool
- func (x *TaskQueueVersionSelection) GetAllActive() bool
- func (x *TaskQueueVersionSelection) GetBuildIds() []string
- func (x *TaskQueueVersionSelection) GetUnversioned() bool
- func (val *TaskQueueVersionSelection) Marshal() ([]byte, error)
- func (*TaskQueueVersionSelection) ProtoMessage()
- func (x *TaskQueueVersionSelection) ProtoReflect() protoreflect.Message
- func (x *TaskQueueVersionSelection) Reset()
- func (val *TaskQueueVersionSelection) Size() int
- func (x *TaskQueueVersionSelection) String() string
- func (val *TaskQueueVersionSelection) Unmarshal(buf []byte) error
- type TimestampedBuildIdAssignmentRule
- func (*TimestampedBuildIdAssignmentRule) Descriptor() ([]byte, []int)deprecated
- func (this *TimestampedBuildIdAssignmentRule) Equal(that interface{}) bool
- func (x *TimestampedBuildIdAssignmentRule) GetCreateTime() *timestamppb.Timestamp
- func (x *TimestampedBuildIdAssignmentRule) GetRule() *BuildIdAssignmentRule
- func (val *TimestampedBuildIdAssignmentRule) Marshal() ([]byte, error)
- func (*TimestampedBuildIdAssignmentRule) ProtoMessage()
- func (x *TimestampedBuildIdAssignmentRule) ProtoReflect() protoreflect.Message
- func (x *TimestampedBuildIdAssignmentRule) Reset()
- func (val *TimestampedBuildIdAssignmentRule) Size() int
- func (x *TimestampedBuildIdAssignmentRule) String() string
- func (val *TimestampedBuildIdAssignmentRule) Unmarshal(buf []byte) error
- type TimestampedCompatibleBuildIdRedirectRule
- func (*TimestampedCompatibleBuildIdRedirectRule) Descriptor() ([]byte, []int)deprecated
- func (this *TimestampedCompatibleBuildIdRedirectRule) Equal(that interface{}) bool
- func (x *TimestampedCompatibleBuildIdRedirectRule) GetCreateTime() *timestamppb.Timestamp
- func (x *TimestampedCompatibleBuildIdRedirectRule) GetRule() *CompatibleBuildIdRedirectRule
- func (val *TimestampedCompatibleBuildIdRedirectRule) Marshal() ([]byte, error)
- func (*TimestampedCompatibleBuildIdRedirectRule) ProtoMessage()
- func (x *TimestampedCompatibleBuildIdRedirectRule) ProtoReflect() protoreflect.Message
- func (x *TimestampedCompatibleBuildIdRedirectRule) Reset()
- func (val *TimestampedCompatibleBuildIdRedirectRule) Size() int
- func (x *TimestampedCompatibleBuildIdRedirectRule) String() string
- func (val *TimestampedCompatibleBuildIdRedirectRule) Unmarshal(buf []byte) error
Constants ¶
This section is empty.
Variables ¶
var File_temporal_api_taskqueue_v1_message_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type BuildIdAssignmentRule ¶ added in v1.32.0
type BuildIdAssignmentRule struct { TargetBuildId string `protobuf:"bytes,1,opt,name=target_build_id,json=targetBuildId,proto3" json:"target_build_id,omitempty"` // If a ramp is provided, this rule will be applied only to a sample of // tasks according to the provided percentage. // This option can be used only on "terminal" Build IDs (the ones not used // as source in any redirect rules). // // Types that are assignable to Ramp: // // *BuildIdAssignmentRule_PercentageRamp Ramp isBuildIdAssignmentRule_Ramp `protobuf_oneof:"ramp"` // contains filtered or unexported fields }
Assignment rules are applied to *new* Workflow and Activity executions at schedule time to assign them to a Build ID.
Assignment rules will not be used in the following cases:
- Child Workflows or Continue-As-New Executions who inherit their parent/previous Workflow's assigned Build ID (by setting the `inherit_build_id` flag - default behavior in SDKs when the same Task Queue is used.)
- An Activity that inherits the assigned Build ID of its Workflow (by setting the `use_workflow_build_id` flag - default behavior in SDKs when the same Task Queue is used.)
In absence of (applicable) redirect rules (`CompatibleBuildIdRedirectRule`s) the task will be dispatched to Workers of the Build ID determined by the assignment rules (or inherited). Otherwise, the final Build ID will be determined by the redirect rules.
Once a Workflow completes its first Workflow Task in a particular Build ID it stays in that Build ID regardless of changes to assignment rules. Redirect rules can be used to move the workflow to another compatible Build ID.
When using Worker Versioning on a Task Queue, in the steady state, there should typically be a single assignment rule to send all new executions to the latest Build ID. Existence of at least one such "unconditional" rule at all times is enforces by the system, unless the `force` flag is used by the user when replacing/deleting these rules (for exceptional cases).
During a deployment, one or more additional rules can be added to assign a subset of the tasks to a new Build ID based on a "ramp percentage".
When there are multiple assignment rules for a Task Queue, the rules are evaluated in order, starting from index 0. The first applicable rule will be applied and the rest will be ignored.
In the event that no assignment rule is applicable on a task (or the Task Queue is simply not versioned), the tasks will be dispatched to an unversioned Worker.
func (*BuildIdAssignmentRule) Descriptor
deprecated
added in
v1.32.0
func (*BuildIdAssignmentRule) Descriptor() ([]byte, []int)
Deprecated: Use BuildIdAssignmentRule.ProtoReflect.Descriptor instead.
func (*BuildIdAssignmentRule) Equal ¶ added in v1.32.0
func (this *BuildIdAssignmentRule) Equal(that interface{}) bool
Equal returns whether two BuildIdAssignmentRule 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 (*BuildIdAssignmentRule) GetPercentageRamp ¶ added in v1.32.0
func (x *BuildIdAssignmentRule) GetPercentageRamp() *RampByPercentage
func (*BuildIdAssignmentRule) GetRamp ¶ added in v1.32.0
func (m *BuildIdAssignmentRule) GetRamp() isBuildIdAssignmentRule_Ramp
func (*BuildIdAssignmentRule) GetTargetBuildId ¶ added in v1.32.0
func (x *BuildIdAssignmentRule) GetTargetBuildId() string
func (*BuildIdAssignmentRule) Marshal ¶ added in v1.32.0
func (val *BuildIdAssignmentRule) Marshal() ([]byte, error)
Marshal an object of type BuildIdAssignmentRule to the protobuf v3 wire format
func (*BuildIdAssignmentRule) ProtoMessage ¶ added in v1.32.0
func (*BuildIdAssignmentRule) ProtoMessage()
func (*BuildIdAssignmentRule) ProtoReflect ¶ added in v1.32.0
func (x *BuildIdAssignmentRule) ProtoReflect() protoreflect.Message
func (*BuildIdAssignmentRule) Reset ¶ added in v1.32.0
func (x *BuildIdAssignmentRule) Reset()
func (*BuildIdAssignmentRule) Size ¶ added in v1.32.0
func (val *BuildIdAssignmentRule) Size() int
Size returns the size of the object, in bytes, once serialized
func (*BuildIdAssignmentRule) String ¶ added in v1.32.0
func (x *BuildIdAssignmentRule) String() string
func (*BuildIdAssignmentRule) Unmarshal ¶ added in v1.32.0
func (val *BuildIdAssignmentRule) Unmarshal(buf []byte) error
Unmarshal an object of type BuildIdAssignmentRule from the protobuf v3 wire format
type BuildIdAssignmentRule_PercentageRamp ¶ added in v1.32.0
type BuildIdAssignmentRule_PercentageRamp struct { // This ramp is useful for gradual Blue/Green deployments (and similar) // where you want to send a certain portion of the traffic to the target // Build ID. PercentageRamp *RampByPercentage `protobuf:"bytes,3,opt,name=percentage_ramp,json=percentageRamp,proto3,oneof"` }
type BuildIdReachability ¶ added in v1.21.0
type BuildIdReachability struct { // A build id or empty if unversioned. BuildId string `protobuf:"bytes,1,opt,name=build_id,json=buildId,proto3" json:"build_id,omitempty"` // Reachability per task queue. TaskQueueReachability []*TaskQueueReachability `` /* 126-byte string literal not displayed */ // contains filtered or unexported fields }
Reachability of tasks for a worker by build id, in one or more task queues.
func (*BuildIdReachability) Descriptor
deprecated
added in
v1.21.0
func (*BuildIdReachability) Descriptor() ([]byte, []int)
Deprecated: Use BuildIdReachability.ProtoReflect.Descriptor instead.
func (*BuildIdReachability) Equal ¶ added in v1.21.0
func (this *BuildIdReachability) Equal(that interface{}) bool
Equal returns whether two BuildIdReachability 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 (*BuildIdReachability) GetBuildId ¶ added in v1.21.0
func (x *BuildIdReachability) GetBuildId() string
func (*BuildIdReachability) GetTaskQueueReachability ¶ added in v1.21.0
func (x *BuildIdReachability) GetTaskQueueReachability() []*TaskQueueReachability
func (*BuildIdReachability) Marshal ¶ added in v1.21.0
func (val *BuildIdReachability) Marshal() ([]byte, error)
Marshal an object of type BuildIdReachability to the protobuf v3 wire format
func (*BuildIdReachability) ProtoMessage ¶ added in v1.21.0
func (*BuildIdReachability) ProtoMessage()
func (*BuildIdReachability) ProtoReflect ¶ added in v1.26.1
func (x *BuildIdReachability) ProtoReflect() protoreflect.Message
func (*BuildIdReachability) Reset ¶ added in v1.21.0
func (x *BuildIdReachability) Reset()
func (*BuildIdReachability) Size ¶ added in v1.21.0
func (val *BuildIdReachability) Size() int
Size returns the size of the object, in bytes, once serialized
func (*BuildIdReachability) String ¶ added in v1.21.0
func (x *BuildIdReachability) String() string
func (*BuildIdReachability) Unmarshal ¶ added in v1.21.0
func (val *BuildIdReachability) Unmarshal(buf []byte) error
Unmarshal an object of type BuildIdReachability from the protobuf v3 wire format
type CompatibleBuildIdRedirectRule ¶ added in v1.32.0
type CompatibleBuildIdRedirectRule struct { SourceBuildId string `protobuf:"bytes,1,opt,name=source_build_id,json=sourceBuildId,proto3" json:"source_build_id,omitempty"` // Target Build ID must be compatible with the Source Build ID; that is it // must be able to process event histories made by the Source Build ID by // using [Patching](https://docs.temporal.io/workflows#patching) or other // means. TargetBuildId string `protobuf:"bytes,2,opt,name=target_build_id,json=targetBuildId,proto3" json:"target_build_id,omitempty"` // contains filtered or unexported fields }
These rules apply to tasks assigned to a particular Build ID (`source_build_id`) to redirect them to another *compatible* Build ID (`target_build_id`).
It is user's responsibility to ensure that the target Build ID is compatible with the source Build ID (e.g. by using the Patching API).
Most deployments are not expected to need these rules, however following situations can greatly benefit from redirects:
- Need to move long-running Workflow Executions from an old Build ID to a newer one.
- Need to hotfix some broken or stuck Workflow Executions.
In steady state, redirect rules are beneficial when dealing with old Executions ran on now-decommissioned Build IDs:
- To redirecting the Workflow Queries to the current (compatible) Build ID.
- To be able to Reset an old Execution so it can run on the current (compatible) Build ID.
Redirect rules can be chained.
func (*CompatibleBuildIdRedirectRule) Descriptor
deprecated
added in
v1.32.0
func (*CompatibleBuildIdRedirectRule) Descriptor() ([]byte, []int)
Deprecated: Use CompatibleBuildIdRedirectRule.ProtoReflect.Descriptor instead.
func (*CompatibleBuildIdRedirectRule) Equal ¶ added in v1.32.0
func (this *CompatibleBuildIdRedirectRule) Equal(that interface{}) bool
Equal returns whether two CompatibleBuildIdRedirectRule 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 (*CompatibleBuildIdRedirectRule) GetSourceBuildId ¶ added in v1.32.0
func (x *CompatibleBuildIdRedirectRule) GetSourceBuildId() string
func (*CompatibleBuildIdRedirectRule) GetTargetBuildId ¶ added in v1.32.0
func (x *CompatibleBuildIdRedirectRule) GetTargetBuildId() string
func (*CompatibleBuildIdRedirectRule) Marshal ¶ added in v1.32.0
func (val *CompatibleBuildIdRedirectRule) Marshal() ([]byte, error)
Marshal an object of type CompatibleBuildIdRedirectRule to the protobuf v3 wire format
func (*CompatibleBuildIdRedirectRule) ProtoMessage ¶ added in v1.32.0
func (*CompatibleBuildIdRedirectRule) ProtoMessage()
func (*CompatibleBuildIdRedirectRule) ProtoReflect ¶ added in v1.32.0
func (x *CompatibleBuildIdRedirectRule) ProtoReflect() protoreflect.Message
func (*CompatibleBuildIdRedirectRule) Reset ¶ added in v1.32.0
func (x *CompatibleBuildIdRedirectRule) Reset()
func (*CompatibleBuildIdRedirectRule) Size ¶ added in v1.32.0
func (val *CompatibleBuildIdRedirectRule) Size() int
Size returns the size of the object, in bytes, once serialized
func (*CompatibleBuildIdRedirectRule) String ¶ added in v1.32.0
func (x *CompatibleBuildIdRedirectRule) String() string
func (*CompatibleBuildIdRedirectRule) Unmarshal ¶ added in v1.32.0
func (val *CompatibleBuildIdRedirectRule) Unmarshal(buf []byte) error
Unmarshal an object of type CompatibleBuildIdRedirectRule from the protobuf v3 wire format
type CompatibleVersionSet ¶ added in v1.19.0
type CompatibleVersionSet struct { // All the compatible versions, unordered, except for the last element, which is considered the set "default". BuildIds []string `protobuf:"bytes,1,rep,name=build_ids,json=buildIds,proto3" json:"build_ids,omitempty"` // contains filtered or unexported fields }
Used by the worker versioning APIs, represents an unordered set of one or more versions which are considered to be compatible with each other. Currently the versions are always worker build IDs.
func (*CompatibleVersionSet) Descriptor
deprecated
added in
v1.19.0
func (*CompatibleVersionSet) Descriptor() ([]byte, []int)
Deprecated: Use CompatibleVersionSet.ProtoReflect.Descriptor instead.
func (*CompatibleVersionSet) Equal ¶ added in v1.19.0
func (this *CompatibleVersionSet) Equal(that interface{}) bool
Equal returns whether two CompatibleVersionSet 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 (*CompatibleVersionSet) GetBuildIds ¶ added in v1.19.0
func (x *CompatibleVersionSet) GetBuildIds() []string
func (*CompatibleVersionSet) Marshal ¶ added in v1.19.0
func (val *CompatibleVersionSet) Marshal() ([]byte, error)
Marshal an object of type CompatibleVersionSet to the protobuf v3 wire format
func (*CompatibleVersionSet) ProtoMessage ¶ added in v1.19.0
func (*CompatibleVersionSet) ProtoMessage()
func (*CompatibleVersionSet) ProtoReflect ¶ added in v1.26.1
func (x *CompatibleVersionSet) ProtoReflect() protoreflect.Message
func (*CompatibleVersionSet) Reset ¶ added in v1.19.0
func (x *CompatibleVersionSet) Reset()
func (*CompatibleVersionSet) Size ¶ added in v1.19.0
func (val *CompatibleVersionSet) Size() int
Size returns the size of the object, in bytes, once serialized
func (*CompatibleVersionSet) String ¶ added in v1.19.0
func (x *CompatibleVersionSet) String() string
func (*CompatibleVersionSet) Unmarshal ¶ added in v1.19.0
func (val *CompatibleVersionSet) Unmarshal(buf []byte) error
Unmarshal an object of type CompatibleVersionSet from the protobuf v3 wire format
type PollerInfo ¶
type PollerInfo struct { LastAccessTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=last_access_time,json=lastAccessTime,proto3" json:"last_access_time,omitempty"` Identity string `protobuf:"bytes,2,opt,name=identity,proto3" json:"identity,omitempty"` RatePerSecond float64 `protobuf:"fixed64,3,opt,name=rate_per_second,json=ratePerSecond,proto3" json:"rate_per_second,omitempty"` // If a worker has opted into the worker versioning feature while polling, its capabilities will // appear here. WorkerVersionCapabilities *v11.WorkerVersionCapabilities `` /* 138-byte string literal not displayed */ // contains filtered or unexported fields }
func (*PollerInfo) Descriptor
deprecated
func (*PollerInfo) Descriptor() ([]byte, []int)
Deprecated: Use PollerInfo.ProtoReflect.Descriptor instead.
func (*PollerInfo) Equal ¶
func (this *PollerInfo) Equal(that interface{}) bool
Equal returns whether two PollerInfo 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 (*PollerInfo) GetIdentity ¶
func (x *PollerInfo) GetIdentity() string
func (*PollerInfo) GetLastAccessTime ¶
func (x *PollerInfo) GetLastAccessTime() *timestamppb.Timestamp
func (*PollerInfo) GetRatePerSecond ¶
func (x *PollerInfo) GetRatePerSecond() float64
func (*PollerInfo) GetWorkerVersionCapabilities ¶ added in v1.19.0
func (x *PollerInfo) GetWorkerVersionCapabilities() *v11.WorkerVersionCapabilities
func (*PollerInfo) Marshal ¶
func (val *PollerInfo) Marshal() ([]byte, error)
Marshal an object of type PollerInfo to the protobuf v3 wire format
func (*PollerInfo) ProtoMessage ¶
func (*PollerInfo) ProtoMessage()
func (*PollerInfo) ProtoReflect ¶ added in v1.26.1
func (x *PollerInfo) ProtoReflect() protoreflect.Message
func (*PollerInfo) Reset ¶
func (x *PollerInfo) Reset()
func (*PollerInfo) Size ¶
func (val *PollerInfo) Size() int
Size returns the size of the object, in bytes, once serialized
func (*PollerInfo) String ¶
func (x *PollerInfo) String() string
func (*PollerInfo) Unmarshal ¶
func (val *PollerInfo) Unmarshal(buf []byte) error
Unmarshal an object of type PollerInfo from the protobuf v3 wire format
type RampByPercentage ¶ added in v1.32.0
type RampByPercentage struct { // Acceptable range is [0,100). RampPercentage float32 `protobuf:"fixed32,1,opt,name=ramp_percentage,json=rampPercentage,proto3" json:"ramp_percentage,omitempty"` // contains filtered or unexported fields }
func (*RampByPercentage) Descriptor
deprecated
added in
v1.32.0
func (*RampByPercentage) Descriptor() ([]byte, []int)
Deprecated: Use RampByPercentage.ProtoReflect.Descriptor instead.
func (*RampByPercentage) Equal ¶ added in v1.32.0
func (this *RampByPercentage) Equal(that interface{}) bool
Equal returns whether two RampByPercentage 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 (*RampByPercentage) GetRampPercentage ¶ added in v1.32.0
func (x *RampByPercentage) GetRampPercentage() float32
func (*RampByPercentage) Marshal ¶ added in v1.32.0
func (val *RampByPercentage) Marshal() ([]byte, error)
Marshal an object of type RampByPercentage to the protobuf v3 wire format
func (*RampByPercentage) ProtoMessage ¶ added in v1.32.0
func (*RampByPercentage) ProtoMessage()
func (*RampByPercentage) ProtoReflect ¶ added in v1.32.0
func (x *RampByPercentage) ProtoReflect() protoreflect.Message
func (*RampByPercentage) Reset ¶ added in v1.32.0
func (x *RampByPercentage) Reset()
func (*RampByPercentage) Size ¶ added in v1.32.0
func (val *RampByPercentage) Size() int
Size returns the size of the object, in bytes, once serialized
func (*RampByPercentage) String ¶ added in v1.32.0
func (x *RampByPercentage) String() string
func (*RampByPercentage) Unmarshal ¶ added in v1.32.0
func (val *RampByPercentage) Unmarshal(buf []byte) error
Unmarshal an object of type RampByPercentage from the protobuf v3 wire format
type StickyExecutionAttributes ¶
type StickyExecutionAttributes struct { WorkerTaskQueue *TaskQueue `protobuf:"bytes,1,opt,name=worker_task_queue,json=workerTaskQueue,proto3" json:"worker_task_queue,omitempty"` // (-- api-linter: core::0140::prepositions=disabled // // aip.dev/not-precedent: "to" is used to indicate interval. --) ScheduleToStartTimeout *durationpb.Duration `` /* 131-byte string literal not displayed */ // contains filtered or unexported fields }
func (*StickyExecutionAttributes) Descriptor
deprecated
func (*StickyExecutionAttributes) Descriptor() ([]byte, []int)
Deprecated: Use StickyExecutionAttributes.ProtoReflect.Descriptor instead.
func (*StickyExecutionAttributes) Equal ¶
func (this *StickyExecutionAttributes) Equal(that interface{}) bool
Equal returns whether two StickyExecutionAttributes 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 (*StickyExecutionAttributes) GetScheduleToStartTimeout ¶ added in v0.28.0
func (x *StickyExecutionAttributes) GetScheduleToStartTimeout() *durationpb.Duration
func (*StickyExecutionAttributes) GetWorkerTaskQueue ¶
func (x *StickyExecutionAttributes) GetWorkerTaskQueue() *TaskQueue
func (*StickyExecutionAttributes) Marshal ¶
func (val *StickyExecutionAttributes) Marshal() ([]byte, error)
Marshal an object of type StickyExecutionAttributes to the protobuf v3 wire format
func (*StickyExecutionAttributes) ProtoMessage ¶
func (*StickyExecutionAttributes) ProtoMessage()
func (*StickyExecutionAttributes) ProtoReflect ¶ added in v1.26.1
func (x *StickyExecutionAttributes) ProtoReflect() protoreflect.Message
func (*StickyExecutionAttributes) Reset ¶
func (x *StickyExecutionAttributes) Reset()
func (*StickyExecutionAttributes) Size ¶
func (val *StickyExecutionAttributes) Size() int
Size returns the size of the object, in bytes, once serialized
func (*StickyExecutionAttributes) String ¶
func (x *StickyExecutionAttributes) String() string
func (*StickyExecutionAttributes) Unmarshal ¶
func (val *StickyExecutionAttributes) Unmarshal(buf []byte) error
Unmarshal an object of type StickyExecutionAttributes from the protobuf v3 wire format
type TaskIdBlock ¶
type TaskIdBlock struct { StartId int64 `protobuf:"varint,1,opt,name=start_id,json=startId,proto3" json:"start_id,omitempty"` EndId int64 `protobuf:"varint,2,opt,name=end_id,json=endId,proto3" json:"end_id,omitempty"` // contains filtered or unexported fields }
func (*TaskIdBlock) Descriptor
deprecated
func (*TaskIdBlock) Descriptor() ([]byte, []int)
Deprecated: Use TaskIdBlock.ProtoReflect.Descriptor instead.
func (*TaskIdBlock) Equal ¶
func (this *TaskIdBlock) Equal(that interface{}) bool
Equal returns whether two TaskIdBlock 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 (*TaskIdBlock) GetEndId ¶
func (x *TaskIdBlock) GetEndId() int64
func (*TaskIdBlock) GetStartId ¶
func (x *TaskIdBlock) GetStartId() int64
func (*TaskIdBlock) Marshal ¶
func (val *TaskIdBlock) Marshal() ([]byte, error)
Marshal an object of type TaskIdBlock to the protobuf v3 wire format
func (*TaskIdBlock) ProtoMessage ¶
func (*TaskIdBlock) ProtoMessage()
func (*TaskIdBlock) ProtoReflect ¶ added in v1.26.1
func (x *TaskIdBlock) ProtoReflect() protoreflect.Message
func (*TaskIdBlock) Reset ¶
func (x *TaskIdBlock) Reset()
func (*TaskIdBlock) Size ¶
func (val *TaskIdBlock) Size() int
Size returns the size of the object, in bytes, once serialized
func (*TaskIdBlock) String ¶
func (x *TaskIdBlock) String() string
func (*TaskIdBlock) Unmarshal ¶
func (val *TaskIdBlock) Unmarshal(buf []byte) error
Unmarshal an object of type TaskIdBlock from the protobuf v3 wire format
type TaskQueue ¶
type TaskQueue struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Default: TASK_QUEUE_KIND_NORMAL. Kind v1.TaskQueueKind `protobuf:"varint,2,opt,name=kind,proto3,enum=temporal.api.enums.v1.TaskQueueKind" json:"kind,omitempty"` // Iff kind == TASK_QUEUE_KIND_STICKY, then this field contains the name of // the normal task queue that the sticky worker is running on. NormalName string `protobuf:"bytes,3,opt,name=normal_name,json=normalName,proto3" json:"normal_name,omitempty"` // contains filtered or unexported fields }
See https://docs.temporal.io/docs/concepts/task-queues/
func (*TaskQueue) Descriptor
deprecated
func (*TaskQueue) Equal ¶
Equal returns whether two TaskQueue 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 (*TaskQueue) GetKind ¶
func (x *TaskQueue) GetKind() v1.TaskQueueKind
func (*TaskQueue) GetNormalName ¶ added in v1.21.0
func (*TaskQueue) ProtoMessage ¶
func (*TaskQueue) ProtoMessage()
func (*TaskQueue) ProtoReflect ¶ added in v1.26.1
func (x *TaskQueue) ProtoReflect() protoreflect.Message
type TaskQueueMetadata ¶
type TaskQueueMetadata struct { // Allows throttling dispatch of tasks from this queue MaxTasksPerSecond *wrapperspb.DoubleValue `protobuf:"bytes,1,opt,name=max_tasks_per_second,json=maxTasksPerSecond,proto3" json:"max_tasks_per_second,omitempty"` // contains filtered or unexported fields }
Only applies to activity task queues
func (*TaskQueueMetadata) Descriptor
deprecated
func (*TaskQueueMetadata) Descriptor() ([]byte, []int)
Deprecated: Use TaskQueueMetadata.ProtoReflect.Descriptor instead.
func (*TaskQueueMetadata) Equal ¶
func (this *TaskQueueMetadata) Equal(that interface{}) bool
Equal returns whether two TaskQueueMetadata 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 (*TaskQueueMetadata) GetMaxTasksPerSecond ¶
func (x *TaskQueueMetadata) GetMaxTasksPerSecond() *wrapperspb.DoubleValue
func (*TaskQueueMetadata) Marshal ¶
func (val *TaskQueueMetadata) Marshal() ([]byte, error)
Marshal an object of type TaskQueueMetadata to the protobuf v3 wire format
func (*TaskQueueMetadata) ProtoMessage ¶
func (*TaskQueueMetadata) ProtoMessage()
func (*TaskQueueMetadata) ProtoReflect ¶ added in v1.26.1
func (x *TaskQueueMetadata) ProtoReflect() protoreflect.Message
func (*TaskQueueMetadata) Reset ¶
func (x *TaskQueueMetadata) Reset()
func (*TaskQueueMetadata) Size ¶
func (val *TaskQueueMetadata) Size() int
Size returns the size of the object, in bytes, once serialized
func (*TaskQueueMetadata) String ¶
func (x *TaskQueueMetadata) String() string
func (*TaskQueueMetadata) Unmarshal ¶
func (val *TaskQueueMetadata) Unmarshal(buf []byte) error
Unmarshal an object of type TaskQueueMetadata from the protobuf v3 wire format
type TaskQueuePartitionMetadata ¶
type TaskQueuePartitionMetadata struct { Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"` OwnerHostName string `protobuf:"bytes,2,opt,name=owner_host_name,json=ownerHostName,proto3" json:"owner_host_name,omitempty"` // contains filtered or unexported fields }
func (*TaskQueuePartitionMetadata) Descriptor
deprecated
func (*TaskQueuePartitionMetadata) Descriptor() ([]byte, []int)
Deprecated: Use TaskQueuePartitionMetadata.ProtoReflect.Descriptor instead.
func (*TaskQueuePartitionMetadata) Equal ¶
func (this *TaskQueuePartitionMetadata) Equal(that interface{}) bool
Equal returns whether two TaskQueuePartitionMetadata 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 (*TaskQueuePartitionMetadata) GetKey ¶
func (x *TaskQueuePartitionMetadata) GetKey() string
func (*TaskQueuePartitionMetadata) GetOwnerHostName ¶
func (x *TaskQueuePartitionMetadata) GetOwnerHostName() string
func (*TaskQueuePartitionMetadata) Marshal ¶
func (val *TaskQueuePartitionMetadata) Marshal() ([]byte, error)
Marshal an object of type TaskQueuePartitionMetadata to the protobuf v3 wire format
func (*TaskQueuePartitionMetadata) ProtoMessage ¶
func (*TaskQueuePartitionMetadata) ProtoMessage()
func (*TaskQueuePartitionMetadata) ProtoReflect ¶ added in v1.26.1
func (x *TaskQueuePartitionMetadata) ProtoReflect() protoreflect.Message
func (*TaskQueuePartitionMetadata) Reset ¶
func (x *TaskQueuePartitionMetadata) Reset()
func (*TaskQueuePartitionMetadata) Size ¶
func (val *TaskQueuePartitionMetadata) Size() int
Size returns the size of the object, in bytes, once serialized
func (*TaskQueuePartitionMetadata) String ¶
func (x *TaskQueuePartitionMetadata) String() string
func (*TaskQueuePartitionMetadata) Unmarshal ¶
func (val *TaskQueuePartitionMetadata) Unmarshal(buf []byte) error
Unmarshal an object of type TaskQueuePartitionMetadata from the protobuf v3 wire format
type TaskQueueReachability ¶ added in v1.21.0
type TaskQueueReachability struct { TaskQueue string `protobuf:"bytes,1,opt,name=task_queue,json=taskQueue,proto3" json:"task_queue,omitempty"` // Task reachability for a worker in a single task queue. // See the TaskReachability docstring for information about each enum variant. // If reachability is empty, this worker is considered unreachable in this task queue. Reachability []v1.TaskReachability `` /* 129-byte string literal not displayed */ // contains filtered or unexported fields }
Reachability of tasks for a worker on a single task queue.
func (*TaskQueueReachability) Descriptor
deprecated
added in
v1.21.0
func (*TaskQueueReachability) Descriptor() ([]byte, []int)
Deprecated: Use TaskQueueReachability.ProtoReflect.Descriptor instead.
func (*TaskQueueReachability) Equal ¶ added in v1.21.0
func (this *TaskQueueReachability) Equal(that interface{}) bool
Equal returns whether two TaskQueueReachability 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 (*TaskQueueReachability) GetReachability ¶ added in v1.21.0
func (x *TaskQueueReachability) GetReachability() []v1.TaskReachability
func (*TaskQueueReachability) GetTaskQueue ¶ added in v1.21.0
func (x *TaskQueueReachability) GetTaskQueue() string
func (*TaskQueueReachability) Marshal ¶ added in v1.21.0
func (val *TaskQueueReachability) Marshal() ([]byte, error)
Marshal an object of type TaskQueueReachability to the protobuf v3 wire format
func (*TaskQueueReachability) ProtoMessage ¶ added in v1.21.0
func (*TaskQueueReachability) ProtoMessage()
func (*TaskQueueReachability) ProtoReflect ¶ added in v1.26.1
func (x *TaskQueueReachability) ProtoReflect() protoreflect.Message
func (*TaskQueueReachability) Reset ¶ added in v1.21.0
func (x *TaskQueueReachability) Reset()
func (*TaskQueueReachability) Size ¶ added in v1.21.0
func (val *TaskQueueReachability) Size() int
Size returns the size of the object, in bytes, once serialized
func (*TaskQueueReachability) String ¶ added in v1.21.0
func (x *TaskQueueReachability) String() string
func (*TaskQueueReachability) Unmarshal ¶ added in v1.21.0
func (val *TaskQueueReachability) Unmarshal(buf []byte) error
Unmarshal an object of type TaskQueueReachability from the protobuf v3 wire format
type TaskQueueStats ¶ added in v1.35.0
type TaskQueueStats struct { // The approximate number of tasks backlogged in this task queue. May count expired tasks but eventually // converges to the right value. Can be relied upon for scaling decisions. // // Special note for workflow task queue type: this metric does not count sticky queue tasks. However, because // those tasks only remain valid for a few seconds, the inaccuracy becomes less significant as the backlog size // grows. ApproximateBacklogCount int64 `` /* 133-byte string literal not displayed */ // Approximate age of the oldest task in the backlog based on the creation time of the task at the head of // the queue. Can be relied upon for scaling decisions. // // Special note for workflow task queue type: this metric does not count sticky queue tasks. However, because // those tasks only remain valid for a few seconds, they should not affect the result when backlog is older than // few seconds. ApproximateBacklogAge *durationpb.Duration `` /* 126-byte string literal not displayed */ // The approximate tasks per second added to the task queue, averaging the last 30 seconds. These includes tasks // whether or not they were added to/dispatched from the backlog or they were dispatched immediately without going // to the backlog (sync-matched). // // The difference between `tasks_add_rate` and `tasks_dispatch_rate` is a reliable metric for the rate at which // backlog grows/shrinks. // // Note: the actual tasks delivered to the workers may significantly be higher than the numbers reported by // tasks_add_rate, because: // - Tasks can be sent to workers without going to the task queue. This is called Eager dispatch. Eager dispatch is // enable for activities by default in the latest SDKs. // - Tasks going to Sticky queue are not accounted for. Note that, typically, only the first workflow task of each // workflow goes to a normal queue, and the rest workflow tasks go to the Sticky queue associated with a specific // worker instance. TasksAddRate float32 `protobuf:"fixed32,3,opt,name=tasks_add_rate,json=tasksAddRate,proto3" json:"tasks_add_rate,omitempty"` // The approximate tasks per second dispatched from the task queue, averaging the last 30 seconds. These includes // tasks whether or not they were added to/dispatched from the backlog or they were dispatched immediately without // going to the backlog (sync-matched). // // The difference between `tasks_add_rate` and `tasks_dispatch_rate` is a reliable metric for the rate at which // backlog grows/shrinks. // // Note: the actual tasks delivered to the workers may significantly be higher than the numbers reported by // tasks_dispatch_rate, because: // - Tasks can be sent to workers without going to the task queue. This is called Eager dispatch. Eager dispatch is // enable for activities by default in the latest SDKs. // - Tasks going to Sticky queue are not accounted for. Note that, typically, only the first workflow task of each // workflow goes to a normal queue, and the rest workflow tasks go to the Sticky queue associated with a specific // worker instance. TasksDispatchRate float32 `protobuf:"fixed32,4,opt,name=tasks_dispatch_rate,json=tasksDispatchRate,proto3" json:"tasks_dispatch_rate,omitempty"` // contains filtered or unexported fields }
TaskQueueStats contains statistics about task queue backlog and activity.
For workflow task queue type, this result is partial because tasks sent to sticky queues are not included. Read comments above each metric to understand the impact of sticky queue exclusion on that metric accuracy.
func (*TaskQueueStats) Descriptor
deprecated
added in
v1.35.0
func (*TaskQueueStats) Descriptor() ([]byte, []int)
Deprecated: Use TaskQueueStats.ProtoReflect.Descriptor instead.
func (*TaskQueueStats) Equal ¶ added in v1.35.0
func (this *TaskQueueStats) Equal(that interface{}) bool
Equal returns whether two TaskQueueStats 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 (*TaskQueueStats) GetApproximateBacklogAge ¶ added in v1.35.0
func (x *TaskQueueStats) GetApproximateBacklogAge() *durationpb.Duration
func (*TaskQueueStats) GetApproximateBacklogCount ¶ added in v1.35.0
func (x *TaskQueueStats) GetApproximateBacklogCount() int64
func (*TaskQueueStats) GetTasksAddRate ¶ added in v1.35.0
func (x *TaskQueueStats) GetTasksAddRate() float32
func (*TaskQueueStats) GetTasksDispatchRate ¶ added in v1.35.0
func (x *TaskQueueStats) GetTasksDispatchRate() float32
func (*TaskQueueStats) Marshal ¶ added in v1.35.0
func (val *TaskQueueStats) Marshal() ([]byte, error)
Marshal an object of type TaskQueueStats to the protobuf v3 wire format
func (*TaskQueueStats) ProtoMessage ¶ added in v1.35.0
func (*TaskQueueStats) ProtoMessage()
func (*TaskQueueStats) ProtoReflect ¶ added in v1.35.0
func (x *TaskQueueStats) ProtoReflect() protoreflect.Message
func (*TaskQueueStats) Reset ¶ added in v1.35.0
func (x *TaskQueueStats) Reset()
func (*TaskQueueStats) Size ¶ added in v1.35.0
func (val *TaskQueueStats) Size() int
Size returns the size of the object, in bytes, once serialized
func (*TaskQueueStats) String ¶ added in v1.35.0
func (x *TaskQueueStats) String() string
func (*TaskQueueStats) Unmarshal ¶ added in v1.35.0
func (val *TaskQueueStats) Unmarshal(buf []byte) error
Unmarshal an object of type TaskQueueStats from the protobuf v3 wire format
type TaskQueueStatus ¶
type TaskQueueStatus struct { BacklogCountHint int64 `protobuf:"varint,1,opt,name=backlog_count_hint,json=backlogCountHint,proto3" json:"backlog_count_hint,omitempty"` ReadLevel int64 `protobuf:"varint,2,opt,name=read_level,json=readLevel,proto3" json:"read_level,omitempty"` AckLevel int64 `protobuf:"varint,3,opt,name=ack_level,json=ackLevel,proto3" json:"ack_level,omitempty"` RatePerSecond float64 `protobuf:"fixed64,4,opt,name=rate_per_second,json=ratePerSecond,proto3" json:"rate_per_second,omitempty"` TaskIdBlock *TaskIdBlock `protobuf:"bytes,5,opt,name=task_id_block,json=taskIdBlock,proto3" json:"task_id_block,omitempty"` // contains filtered or unexported fields }
Deprecated. Use `InternalTaskQueueStatus`. This is kept until `DescribeTaskQueue` supports legacy behavior.
func (*TaskQueueStatus) Descriptor
deprecated
func (*TaskQueueStatus) Descriptor() ([]byte, []int)
Deprecated: Use TaskQueueStatus.ProtoReflect.Descriptor instead.
func (*TaskQueueStatus) Equal ¶
func (this *TaskQueueStatus) Equal(that interface{}) bool
Equal returns whether two TaskQueueStatus 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 (*TaskQueueStatus) GetAckLevel ¶
func (x *TaskQueueStatus) GetAckLevel() int64
func (*TaskQueueStatus) GetBacklogCountHint ¶
func (x *TaskQueueStatus) GetBacklogCountHint() int64
func (*TaskQueueStatus) GetRatePerSecond ¶
func (x *TaskQueueStatus) GetRatePerSecond() float64
func (*TaskQueueStatus) GetReadLevel ¶
func (x *TaskQueueStatus) GetReadLevel() int64
func (*TaskQueueStatus) GetTaskIdBlock ¶
func (x *TaskQueueStatus) GetTaskIdBlock() *TaskIdBlock
func (*TaskQueueStatus) Marshal ¶
func (val *TaskQueueStatus) Marshal() ([]byte, error)
Marshal an object of type TaskQueueStatus to the protobuf v3 wire format
func (*TaskQueueStatus) ProtoMessage ¶
func (*TaskQueueStatus) ProtoMessage()
func (*TaskQueueStatus) ProtoReflect ¶ added in v1.26.1
func (x *TaskQueueStatus) ProtoReflect() protoreflect.Message
func (*TaskQueueStatus) Reset ¶
func (x *TaskQueueStatus) Reset()
func (*TaskQueueStatus) Size ¶
func (val *TaskQueueStatus) Size() int
Size returns the size of the object, in bytes, once serialized
func (*TaskQueueStatus) String ¶
func (x *TaskQueueStatus) String() string
func (*TaskQueueStatus) Unmarshal ¶
func (val *TaskQueueStatus) Unmarshal(buf []byte) error
Unmarshal an object of type TaskQueueStatus from the protobuf v3 wire format
type TaskQueueTypeInfo ¶ added in v1.32.0
type TaskQueueTypeInfo struct { // Unversioned workers (with `useVersioning=false`) are reported in unversioned result even if they set a Build ID. Pollers []*PollerInfo `protobuf:"bytes,1,rep,name=pollers,proto3" json:"pollers,omitempty"` Stats *TaskQueueStats `protobuf:"bytes,2,opt,name=stats,proto3" json:"stats,omitempty"` // contains filtered or unexported fields }
func (*TaskQueueTypeInfo) Descriptor
deprecated
added in
v1.32.0
func (*TaskQueueTypeInfo) Descriptor() ([]byte, []int)
Deprecated: Use TaskQueueTypeInfo.ProtoReflect.Descriptor instead.
func (*TaskQueueTypeInfo) Equal ¶ added in v1.32.0
func (this *TaskQueueTypeInfo) Equal(that interface{}) bool
Equal returns whether two TaskQueueTypeInfo 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 (*TaskQueueTypeInfo) GetPollers ¶ added in v1.32.0
func (x *TaskQueueTypeInfo) GetPollers() []*PollerInfo
func (*TaskQueueTypeInfo) GetStats ¶ added in v1.35.0
func (x *TaskQueueTypeInfo) GetStats() *TaskQueueStats
func (*TaskQueueTypeInfo) Marshal ¶ added in v1.32.0
func (val *TaskQueueTypeInfo) Marshal() ([]byte, error)
Marshal an object of type TaskQueueTypeInfo to the protobuf v3 wire format
func (*TaskQueueTypeInfo) ProtoMessage ¶ added in v1.32.0
func (*TaskQueueTypeInfo) ProtoMessage()
func (*TaskQueueTypeInfo) ProtoReflect ¶ added in v1.32.0
func (x *TaskQueueTypeInfo) ProtoReflect() protoreflect.Message
func (*TaskQueueTypeInfo) Reset ¶ added in v1.32.0
func (x *TaskQueueTypeInfo) Reset()
func (*TaskQueueTypeInfo) Size ¶ added in v1.32.0
func (val *TaskQueueTypeInfo) Size() int
Size returns the size of the object, in bytes, once serialized
func (*TaskQueueTypeInfo) String ¶ added in v1.32.0
func (x *TaskQueueTypeInfo) String() string
func (*TaskQueueTypeInfo) Unmarshal ¶ added in v1.32.0
func (val *TaskQueueTypeInfo) Unmarshal(buf []byte) error
Unmarshal an object of type TaskQueueTypeInfo from the protobuf v3 wire format
type TaskQueueVersionInfo ¶ added in v1.32.0
type TaskQueueVersionInfo struct { // Task Queue info per Task Type. Key is the numerical value of the temporal.api.enums.v1.TaskQueueType enum. TypesInfo map[int32]*TaskQueueTypeInfo `` /* 177-byte string literal not displayed */ // Task Reachability is eventually consistent; there may be a delay until it converges to the most // accurate value but it is designed in a way to take the more conservative side until it converges. // For example REACHABLE is more conservative than CLOSED_WORKFLOWS_ONLY. // // Note: future activities who inherit their workflow's Build ID but not its Task Queue will not be // accounted for reachability as server cannot know if they'll happen as they do not use // assignment rules of their Task Queue. Same goes for Child Workflows or Continue-As-New Workflows // who inherit the parent/previous workflow's Build ID but not its Task Queue. In those cases, make // sure to query reachability for the parent/previous workflow's Task Queue as well. TaskReachability v1.BuildIdTaskReachability `` /* 161-byte string literal not displayed */ // contains filtered or unexported fields }
func (*TaskQueueVersionInfo) Descriptor
deprecated
added in
v1.32.0
func (*TaskQueueVersionInfo) Descriptor() ([]byte, []int)
Deprecated: Use TaskQueueVersionInfo.ProtoReflect.Descriptor instead.
func (*TaskQueueVersionInfo) Equal ¶ added in v1.32.0
func (this *TaskQueueVersionInfo) Equal(that interface{}) bool
Equal returns whether two TaskQueueVersionInfo 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 (*TaskQueueVersionInfo) GetTaskReachability ¶ added in v1.32.0
func (x *TaskQueueVersionInfo) GetTaskReachability() v1.BuildIdTaskReachability
func (*TaskQueueVersionInfo) GetTypesInfo ¶ added in v1.32.0
func (x *TaskQueueVersionInfo) GetTypesInfo() map[int32]*TaskQueueTypeInfo
func (*TaskQueueVersionInfo) Marshal ¶ added in v1.32.0
func (val *TaskQueueVersionInfo) Marshal() ([]byte, error)
Marshal an object of type TaskQueueVersionInfo to the protobuf v3 wire format
func (*TaskQueueVersionInfo) ProtoMessage ¶ added in v1.32.0
func (*TaskQueueVersionInfo) ProtoMessage()
func (*TaskQueueVersionInfo) ProtoReflect ¶ added in v1.32.0
func (x *TaskQueueVersionInfo) ProtoReflect() protoreflect.Message
func (*TaskQueueVersionInfo) Reset ¶ added in v1.32.0
func (x *TaskQueueVersionInfo) Reset()
func (*TaskQueueVersionInfo) Size ¶ added in v1.32.0
func (val *TaskQueueVersionInfo) Size() int
Size returns the size of the object, in bytes, once serialized
func (*TaskQueueVersionInfo) String ¶ added in v1.32.0
func (x *TaskQueueVersionInfo) String() string
func (*TaskQueueVersionInfo) Unmarshal ¶ added in v1.32.0
func (val *TaskQueueVersionInfo) Unmarshal(buf []byte) error
Unmarshal an object of type TaskQueueVersionInfo from the protobuf v3 wire format
type TaskQueueVersionSelection ¶ added in v1.32.0
type TaskQueueVersionSelection struct { // Include specific Build IDs. BuildIds []string `protobuf:"bytes,1,rep,name=build_ids,json=buildIds,proto3" json:"build_ids,omitempty"` // Include the unversioned queue. Unversioned bool `protobuf:"varint,2,opt,name=unversioned,proto3" json:"unversioned,omitempty"` // Include all active versions. A version is considered active if, in the last few minutes, // it has had new tasks or polls, or it has been the subject of certain task queue API calls. AllActive bool `protobuf:"varint,3,opt,name=all_active,json=allActive,proto3" json:"all_active,omitempty"` // contains filtered or unexported fields }
Used for specifying versions the caller is interested in.
func (*TaskQueueVersionSelection) Descriptor
deprecated
added in
v1.32.0
func (*TaskQueueVersionSelection) Descriptor() ([]byte, []int)
Deprecated: Use TaskQueueVersionSelection.ProtoReflect.Descriptor instead.
func (*TaskQueueVersionSelection) Equal ¶ added in v1.32.0
func (this *TaskQueueVersionSelection) Equal(that interface{}) bool
Equal returns whether two TaskQueueVersionSelection 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 (*TaskQueueVersionSelection) GetAllActive ¶ added in v1.32.0
func (x *TaskQueueVersionSelection) GetAllActive() bool
func (*TaskQueueVersionSelection) GetBuildIds ¶ added in v1.32.0
func (x *TaskQueueVersionSelection) GetBuildIds() []string
func (*TaskQueueVersionSelection) GetUnversioned ¶ added in v1.32.0
func (x *TaskQueueVersionSelection) GetUnversioned() bool
func (*TaskQueueVersionSelection) Marshal ¶ added in v1.32.0
func (val *TaskQueueVersionSelection) Marshal() ([]byte, error)
Marshal an object of type TaskQueueVersionSelection to the protobuf v3 wire format
func (*TaskQueueVersionSelection) ProtoMessage ¶ added in v1.32.0
func (*TaskQueueVersionSelection) ProtoMessage()
func (*TaskQueueVersionSelection) ProtoReflect ¶ added in v1.32.0
func (x *TaskQueueVersionSelection) ProtoReflect() protoreflect.Message
func (*TaskQueueVersionSelection) Reset ¶ added in v1.32.0
func (x *TaskQueueVersionSelection) Reset()
func (*TaskQueueVersionSelection) Size ¶ added in v1.32.0
func (val *TaskQueueVersionSelection) Size() int
Size returns the size of the object, in bytes, once serialized
func (*TaskQueueVersionSelection) String ¶ added in v1.32.0
func (x *TaskQueueVersionSelection) String() string
func (*TaskQueueVersionSelection) Unmarshal ¶ added in v1.32.0
func (val *TaskQueueVersionSelection) Unmarshal(buf []byte) error
Unmarshal an object of type TaskQueueVersionSelection from the protobuf v3 wire format
type TimestampedBuildIdAssignmentRule ¶ added in v1.32.0
type TimestampedBuildIdAssignmentRule struct { Rule *BuildIdAssignmentRule `protobuf:"bytes,1,opt,name=rule,proto3" json:"rule,omitempty"` CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"` // contains filtered or unexported fields }
func (*TimestampedBuildIdAssignmentRule) Descriptor
deprecated
added in
v1.32.0
func (*TimestampedBuildIdAssignmentRule) Descriptor() ([]byte, []int)
Deprecated: Use TimestampedBuildIdAssignmentRule.ProtoReflect.Descriptor instead.
func (*TimestampedBuildIdAssignmentRule) Equal ¶ added in v1.32.0
func (this *TimestampedBuildIdAssignmentRule) Equal(that interface{}) bool
Equal returns whether two TimestampedBuildIdAssignmentRule 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 (*TimestampedBuildIdAssignmentRule) GetCreateTime ¶ added in v1.32.0
func (x *TimestampedBuildIdAssignmentRule) GetCreateTime() *timestamppb.Timestamp
func (*TimestampedBuildIdAssignmentRule) GetRule ¶ added in v1.32.0
func (x *TimestampedBuildIdAssignmentRule) GetRule() *BuildIdAssignmentRule
func (*TimestampedBuildIdAssignmentRule) Marshal ¶ added in v1.32.0
func (val *TimestampedBuildIdAssignmentRule) Marshal() ([]byte, error)
Marshal an object of type TimestampedBuildIdAssignmentRule to the protobuf v3 wire format
func (*TimestampedBuildIdAssignmentRule) ProtoMessage ¶ added in v1.32.0
func (*TimestampedBuildIdAssignmentRule) ProtoMessage()
func (*TimestampedBuildIdAssignmentRule) ProtoReflect ¶ added in v1.32.0
func (x *TimestampedBuildIdAssignmentRule) ProtoReflect() protoreflect.Message
func (*TimestampedBuildIdAssignmentRule) Reset ¶ added in v1.32.0
func (x *TimestampedBuildIdAssignmentRule) Reset()
func (*TimestampedBuildIdAssignmentRule) Size ¶ added in v1.32.0
func (val *TimestampedBuildIdAssignmentRule) Size() int
Size returns the size of the object, in bytes, once serialized
func (*TimestampedBuildIdAssignmentRule) String ¶ added in v1.32.0
func (x *TimestampedBuildIdAssignmentRule) String() string
func (*TimestampedBuildIdAssignmentRule) Unmarshal ¶ added in v1.32.0
func (val *TimestampedBuildIdAssignmentRule) Unmarshal(buf []byte) error
Unmarshal an object of type TimestampedBuildIdAssignmentRule from the protobuf v3 wire format
type TimestampedCompatibleBuildIdRedirectRule ¶ added in v1.32.0
type TimestampedCompatibleBuildIdRedirectRule struct { Rule *CompatibleBuildIdRedirectRule `protobuf:"bytes,1,opt,name=rule,proto3" json:"rule,omitempty"` CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"` // contains filtered or unexported fields }
func (*TimestampedCompatibleBuildIdRedirectRule) Descriptor
deprecated
added in
v1.32.0
func (*TimestampedCompatibleBuildIdRedirectRule) Descriptor() ([]byte, []int)
Deprecated: Use TimestampedCompatibleBuildIdRedirectRule.ProtoReflect.Descriptor instead.
func (*TimestampedCompatibleBuildIdRedirectRule) Equal ¶ added in v1.32.0
func (this *TimestampedCompatibleBuildIdRedirectRule) Equal(that interface{}) bool
Equal returns whether two TimestampedCompatibleBuildIdRedirectRule 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 (*TimestampedCompatibleBuildIdRedirectRule) GetCreateTime ¶ added in v1.32.0
func (x *TimestampedCompatibleBuildIdRedirectRule) GetCreateTime() *timestamppb.Timestamp
func (*TimestampedCompatibleBuildIdRedirectRule) GetRule ¶ added in v1.32.0
func (x *TimestampedCompatibleBuildIdRedirectRule) GetRule() *CompatibleBuildIdRedirectRule
func (*TimestampedCompatibleBuildIdRedirectRule) Marshal ¶ added in v1.32.0
func (val *TimestampedCompatibleBuildIdRedirectRule) Marshal() ([]byte, error)
Marshal an object of type TimestampedCompatibleBuildIdRedirectRule to the protobuf v3 wire format
func (*TimestampedCompatibleBuildIdRedirectRule) ProtoMessage ¶ added in v1.32.0
func (*TimestampedCompatibleBuildIdRedirectRule) ProtoMessage()
func (*TimestampedCompatibleBuildIdRedirectRule) ProtoReflect ¶ added in v1.32.0
func (x *TimestampedCompatibleBuildIdRedirectRule) ProtoReflect() protoreflect.Message
func (*TimestampedCompatibleBuildIdRedirectRule) Reset ¶ added in v1.32.0
func (x *TimestampedCompatibleBuildIdRedirectRule) Reset()
func (*TimestampedCompatibleBuildIdRedirectRule) Size ¶ added in v1.32.0
func (val *TimestampedCompatibleBuildIdRedirectRule) Size() int
Size returns the size of the object, in bytes, once serialized
func (*TimestampedCompatibleBuildIdRedirectRule) String ¶ added in v1.32.0
func (x *TimestampedCompatibleBuildIdRedirectRule) String() string
func (*TimestampedCompatibleBuildIdRedirectRule) Unmarshal ¶ added in v1.32.0
func (val *TimestampedCompatibleBuildIdRedirectRule) Unmarshal(buf []byte) error
Unmarshal an object of type TimestampedCompatibleBuildIdRedirectRule from the protobuf v3 wire format