commonspb

package
v1.36.0 Latest Latest
Warning

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

 Go to latest Published: Apr 23, 2026 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

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

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

Index

Constants

This section is empty.

Variables

View Source 
var (
	ApiCategory_name = map[int32]string{
		0: "API_CATEGORY_UNSPECIFIED",
		1: "API_CATEGORY_STANDARD",
		2: "API_CATEGORY_LONG_POLL",
		3: "API_CATEGORY_SYSTEM",
	}
	ApiCategory_value = map[string]int32{
		"API_CATEGORY_UNSPECIFIED": 0,
		"API_CATEGORY_STANDARD":    1,
		"API_CATEGORY_LONG_POLL":   2,
		"API_CATEGORY_SYSTEM":      3,
	}
)

Enum value maps for ApiCategory.

View Source 
var (
	ApiCategory_shorthandValue = map[string]int32{
		"Unspecified": 0,
		"Standard":    1,
		"LongPoll":    2,
		"System":      3,
	}
)
View Source 
var (
	// optional temporal.server.api.common.v1.ApiCategoryOptions api_category = 50001;
	E_ApiCategory = &file_temporal_server_api_common_v1_api_category_proto_extTypes[0]
)

Extension fields to descriptorpb.MethodOptions.

View Source 
var File_temporal_server_api_common_v1_api_category_proto protoreflect.FileDescriptor
View Source 
var File_temporal_server_api_common_v1_dlq_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type ApiCategory 

type ApiCategory int32
const (
	// Unspecified API category. Treated as standard API.
	API_CATEGORY_UNSPECIFIED ApiCategory = 0
	// Standard API with typical request/response patterns.
	API_CATEGORY_STANDARD ApiCategory = 1
	// Long-polling API that intentionally waits for state changes or external events.
	// These APIs should be excluded from health signal tracking because their latency
	// reflects client wait times and event availability rather than server health.
	// Including them in health metrics would skew the data and could cause healthy
	// nodes to appear unhealthy.
	//
	// Examples: PollMutableState, PollWorkflowExecutionUpdate, QueryWorkflow
	API_CATEGORY_LONG_POLL ApiCategory = 2
	API_CATEGORY_SYSTEM    ApiCategory = 3
)

func ApiCategoryFromString 

func ApiCategoryFromString(s string) (ApiCategory, error)

ApiCategoryFromString parses a ApiCategory value from either the protojson canonical SCREAMING_CASE enum or the traditional temporal PascalCase enum to ApiCategory

func (ApiCategory) Descriptor 

func (ApiCategory) Descriptor() protoreflect.EnumDescriptor

func (ApiCategory) Enum 

func (x ApiCategory) Enum() *ApiCategory

func (ApiCategory) EnumDescriptor deprecated 

func (ApiCategory) EnumDescriptor() ([]byte, []int)

Deprecated: Use ApiCategory.Descriptor instead.

func (ApiCategory) Number 

func (x ApiCategory) Number() protoreflect.EnumNumber

func (ApiCategory) String 

func (x ApiCategory) String() string

func (ApiCategory) Type 

func (ApiCategory) Type() protoreflect.EnumType

type ApiCategoryOptions 

type ApiCategoryOptions struct {

	// The category of this API for health and observability purposes.
	Category ApiCategory `protobuf:"varint,1,opt,name=category,proto3,enum=temporal.server.api.common.v1.ApiCategory" json:"category,omitempty"`
	// contains filtered or unexported fields
}

func (*ApiCategoryOptions) Descriptor deprecated 

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

Deprecated: Use ApiCategoryOptions.ProtoReflect.Descriptor instead.

func (*ApiCategoryOptions) Equal 

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

Equal returns whether two ApiCategoryOptions 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 (*ApiCategoryOptions) GetCategory 

func (x *ApiCategoryOptions) GetCategory() ApiCategory

func (*ApiCategoryOptions) Marshal 

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

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

func (*ApiCategoryOptions) ProtoMessage 

func (*ApiCategoryOptions) ProtoMessage()

func (*ApiCategoryOptions) ProtoReflect 

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

func (*ApiCategoryOptions) Reset 

func (x *ApiCategoryOptions) Reset()

func (*ApiCategoryOptions) Size 

func (val *ApiCategoryOptions) Size() int

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

func (*ApiCategoryOptions) String 

func (x *ApiCategoryOptions) String() string

func (*ApiCategoryOptions) Unmarshal 

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

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

type HistoryDLQKey 

type HistoryDLQKey struct {

	// task_category is the category of the task. The default values are defined in the TaskCategory enum. However, there
	// may also be other categories registered at runtime with the history/tasks package. As a result, the category here
	// is an integer instead of an enum to support both the default values and custom values.
	TaskCategory int32 `protobuf:"varint,1,opt,name=task_category,json=taskCategory,proto3" json:"task_category,omitempty"`
	// source_cluster and target_cluster must both be non-empty. For non-cross DC tasks, i.e. non-replication tasks,
	// they should be the same. The reason for this is that we may support wildcard clusters in the future, and we want
	// to differentiate between queues which go from one cluster to all other clusters, and queues which don't leave the
	// current cluster.
	SourceCluster string `protobuf:"bytes,2,opt,name=source_cluster,json=sourceCluster,proto3" json:"source_cluster,omitempty"`
	TargetCluster string `protobuf:"bytes,3,opt,name=target_cluster,json=targetCluster,proto3" json:"target_cluster,omitempty"`
	// contains filtered or unexported fields
}

HistoryDLQKey is a compound key that identifies a history DLQ.

func (*HistoryDLQKey) Descriptor deprecated 

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

Deprecated: Use HistoryDLQKey.ProtoReflect.Descriptor instead.

func (*HistoryDLQKey) Equal 

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

Equal returns whether two HistoryDLQKey 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 (*HistoryDLQKey) GetSourceCluster 

func (x *HistoryDLQKey) GetSourceCluster() string

func (*HistoryDLQKey) GetTargetCluster 

func (x *HistoryDLQKey) GetTargetCluster() string

func (*HistoryDLQKey) GetTaskCategory 

func (x *HistoryDLQKey) GetTaskCategory() int32

func (*HistoryDLQKey) Marshal 

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

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

func (*HistoryDLQKey) ProtoMessage 

func (*HistoryDLQKey) ProtoMessage()

func (*HistoryDLQKey) ProtoReflect 

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

func (*HistoryDLQKey) Reset 

func (x *HistoryDLQKey) Reset()

func (*HistoryDLQKey) Size 

func (val *HistoryDLQKey) Size() int

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

func (*HistoryDLQKey) String 

func (x *HistoryDLQKey) String() string

func (*HistoryDLQKey) Unmarshal 

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

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

type HistoryDLQTask 

type HistoryDLQTask struct {
	Metadata *HistoryDLQTaskMetadata `protobuf:"bytes,1,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// This is named payload to prevent stuttering (e.g. task.Task).
	Payload *HistoryTask `protobuf:"bytes,2,opt,name=payload,proto3" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

HistoryDLQTask is a history task that has been moved to the DLQ, so it also has a message ID (index within that queue).

func (*HistoryDLQTask) Descriptor deprecated 

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

Deprecated: Use HistoryDLQTask.ProtoReflect.Descriptor instead.

func (*HistoryDLQTask) Equal 

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

Equal returns whether two HistoryDLQTask 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 (*HistoryDLQTask) GetMetadata 

func (x *HistoryDLQTask) GetMetadata() *HistoryDLQTaskMetadata

func (*HistoryDLQTask) GetPayload 

func (x *HistoryDLQTask) GetPayload() *HistoryTask

func (*HistoryDLQTask) Marshal 

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

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

func (*HistoryDLQTask) ProtoMessage 

func (*HistoryDLQTask) ProtoMessage()

func (*HistoryDLQTask) ProtoReflect 

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

func (*HistoryDLQTask) Reset 

func (x *HistoryDLQTask) Reset()

func (*HistoryDLQTask) Size 

func (val *HistoryDLQTask) Size() int

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

func (*HistoryDLQTask) String 

func (x *HistoryDLQTask) String() string

func (*HistoryDLQTask) Unmarshal 

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

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

type HistoryDLQTaskMetadata 

type HistoryDLQTaskMetadata struct {

	// message_id is the zero-indexed sequence number of the message in the queue that contains this history task.
	MessageId int64 `protobuf:"varint,1,opt,name=message_id,json=messageId,proto3" json:"message_id,omitempty"`
	// contains filtered or unexported fields
}

func (*HistoryDLQTaskMetadata) Descriptor deprecated 

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

Deprecated: Use HistoryDLQTaskMetadata.ProtoReflect.Descriptor instead.

func (*HistoryDLQTaskMetadata) Equal 

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

Equal returns whether two HistoryDLQTaskMetadata 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 (*HistoryDLQTaskMetadata) GetMessageId 

func (x *HistoryDLQTaskMetadata) GetMessageId() int64

func (*HistoryDLQTaskMetadata) Marshal 

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

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

func (*HistoryDLQTaskMetadata) ProtoMessage 

func (*HistoryDLQTaskMetadata) ProtoMessage()

func (*HistoryDLQTaskMetadata) ProtoReflect 

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

func (*HistoryDLQTaskMetadata) Reset 

func (x *HistoryDLQTaskMetadata) Reset()

func (*HistoryDLQTaskMetadata) Size 

func (val *HistoryDLQTaskMetadata) Size() int

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

func (*HistoryDLQTaskMetadata) String 

func (x *HistoryDLQTaskMetadata) String() string

func (*HistoryDLQTaskMetadata) Unmarshal 

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

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

type HistoryTask 

type HistoryTask struct {

	// shard_id is included to avoid having to deserialize the task blob.
	ShardId int32        `protobuf:"varint,1,opt,name=shard_id,json=shardId,proto3" json:"shard_id,omitempty"`
	Blob    *v1.DataBlob `protobuf:"bytes,2,opt,name=blob,proto3" json:"blob,omitempty"`
	// contains filtered or unexported fields
}

func (*HistoryTask) Descriptor deprecated 

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

Deprecated: Use HistoryTask.ProtoReflect.Descriptor instead.

func (*HistoryTask) Equal 

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

Equal returns whether two HistoryTask 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 (*HistoryTask) GetBlob 

func (x *HistoryTask) GetBlob() *v1.DataBlob

func (*HistoryTask) GetShardId 

func (x *HistoryTask) GetShardId() int32

func (*HistoryTask) Marshal 

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

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

func (*HistoryTask) ProtoMessage 

func (*HistoryTask) ProtoMessage()

func (*HistoryTask) ProtoReflect 

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

func (*HistoryTask) Reset 

func (x *HistoryTask) Reset()

func (*HistoryTask) Size 

func (val *HistoryTask) Size() int

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

func (*HistoryTask) String 

func (x *HistoryTask) String() string

func (*HistoryTask) Unmarshal 

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

Unmarshal an object of type HistoryTask 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.