taskqueue

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 valid to be assigned to Ramp:
	//
	//	*BuildIdAssignmentRule_PercentageRamp
	Ramp isBuildIdAssignmentRule_Ramp `protobuf_oneof:"ramp"`
	// contains filtered or unexported fields
}

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

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
}

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
}

type ConfigMetadata struct {

	// Reason for why the config was set.
	Reason string `protobuf:"bytes,1,opt,name=reason,proto3" json:"reason,omitempty"`
	// Identity of the last updater.
	// Set by the request's identity field.
	UpdateIdentity string `protobuf:"bytes,2,opt,name=update_identity,json=updateIdentity,proto3" json:"update_identity,omitempty"`
	// Time of the last update.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// contains filtered or unexported fields
}

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.
	// Deprecated. Replaced by deployment_options.
	//
	// Deprecated: Marked as deprecated in temporal/api/taskqueue/v1/message.proto.
	WorkerVersionCapabilities *v12.WorkerVersionCapabilities `` /* 138-byte string literal not displayed */
	// Worker deployment options that SDK sent to server.
	DeploymentOptions *v11.WorkerDeploymentOptions `protobuf:"bytes,5,opt,name=deployment_options,json=deploymentOptions,proto3" json:"deployment_options,omitempty"`
	// contains filtered or unexported fields
}

type PollerScalingDecision struct {

	// How many poll requests to suggest should be added or removed, if any. As of now, server only
	// scales up or down by 1. However, SDKs should allow for other values (while staying within
	// defined min/max).
	//
	// The SDK is free to ignore this suggestion, EX: making more polls would not make sense because
	// all slots are already occupied.
	PollRequestDeltaSuggestion int32 `` /* 144-byte string literal not displayed */
	// contains filtered or unexported fields
}

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
}

type RateLimit struct {

	// Zero is a valid rate limit.
	RequestsPerSecond float32 `protobuf:"fixed32,1,opt,name=requests_per_second,json=requestsPerSecond,proto3" json:"requests_per_second,omitempty"`
	// contains filtered or unexported fields
}

type RateLimitConfig struct {
	RateLimit *RateLimit      `protobuf:"bytes,1,opt,name=rate_limit,json=rateLimit,proto3" json:"rate_limit,omitempty"`
	Metadata  *ConfigMetadata `protobuf:"bytes,2,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

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
}

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
}

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
}

type TaskQueueConfig struct {

	// Unless modified, this is the system-defined rate limit.
	QueueRateLimit *RateLimitConfig `protobuf:"bytes,1,opt,name=queue_rate_limit,json=queueRateLimit,proto3" json:"queue_rate_limit,omitempty"`
	// If set, each individual fairness key will be limited to this rate, scaled by the weight of the fairness key.
	FairnessKeysRateLimitDefault *RateLimitConfig `` /* 151-byte string literal not displayed */
	// contains filtered or unexported fields
}

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
}

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
}

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
}

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
}

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
}

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
}

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 `` /* 163-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
}

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
}

type TaskQueueVersioningInfo struct {

	// Specifies which Deployment Version should receive new workflow executions and tasks of
	// existing unversioned or AutoUpgrade workflows.
	// Nil value represents all the unversioned workers (those with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)
	// Note: Current Version is overridden by the Ramping Version for a portion of traffic when ramp percentage
	// is non-zero (see `ramping_deployment_version` and `ramping_version_percentage`).
	CurrentDeploymentVersion *v11.WorkerDeploymentVersion `` /* 135-byte string literal not displayed */
	// Deprecated. Use `current_deployment_version`.
	//
	// Deprecated: Marked as deprecated in temporal/api/taskqueue/v1/message.proto.
	CurrentVersion string `protobuf:"bytes,1,opt,name=current_version,json=currentVersion,proto3" json:"current_version,omitempty"`
	// When ramp percentage is non-zero, that portion of traffic is shifted from the Current Version to the Ramping Version.
	// Must always be different from `current_deployment_version` unless both are nil.
	// Nil value represents all the unversioned workers (those with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)
	// Note that it is possible to ramp from one Version to another Version, or from unversioned
	// workers to a particular Version, or from a particular Version to unversioned workers.
	RampingDeploymentVersion *v11.WorkerDeploymentVersion `` /* 135-byte string literal not displayed */
	// Deprecated. Use `ramping_deployment_version`.
	//
	// Deprecated: Marked as deprecated in temporal/api/taskqueue/v1/message.proto.
	RampingVersion string `protobuf:"bytes,2,opt,name=ramping_version,json=rampingVersion,proto3" json:"ramping_version,omitempty"`
	// Percentage of tasks that are routed to the Ramping Version instead of the Current Version.
	// Valid range: [0, 100]. A 100% value means the Ramping Version is receiving full traffic but
	// not yet "promoted" to be the Current Version, likely due to pending validations.
	// A 0% value means the Ramping Version is receiving no traffic.
	RampingVersionPercentage float32 `` /* 137-byte string literal not displayed */
	// Last time versioning information of this Task Queue changed.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// contains filtered or unexported fields
}

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
}

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
}