Back to

Package tqpb

Latest Go to latest

The latest major version is .

Published: Aug 13, 2020 | License: Apache-2.0 | Module:



var File_go_chromium_org_luci_server_tq_internal_tqpb_extra_proto protoreflect.FileDescriptor
var File_go_chromium_org_luci_server_tq_internal_tqpb_tasks_proto protoreflect.FileDescriptor

type Extra

type Extra struct {
	TaskClass           string               `protobuf:"bytes,1,opt,name=task_class,json=taskClass,proto3" json:"task_class,omitempty"`                                  // corresponding TaskClass.ID
	Created             *timestamp.Timestamp `protobuf:"bytes,2,opt,name=created,proto3" json:"created,omitempty"`                                                       // when AddTask was called
	SpanContext         string               `protobuf:"bytes,3,opt,name=span_context,json=spanContext,proto3" json:"span_context,omitempty"`                            // where AddTask was called
	InheritTraceContext bool                 `protobuf:"varint,4,opt,name=inherit_trace_context,json=inheritTraceContext,proto3" json:"inherit_trace_context,omitempty"` // see TaskClass.InheritTraceContext
	// contains filtered or unexported fields

Extra is additional data attached to CreateTask requests.

It is prepared by the dispatcher and consumed by the sweeper and submitters. Used for monitoring and tracing.

func (*Extra) Descriptor

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

Deprecated: Use Extra.ProtoReflect.Descriptor instead.

func (*Extra) GetCreated

func (x *Extra) GetCreated() *timestamp.Timestamp

func (*Extra) GetInheritTraceContext

func (x *Extra) GetInheritTraceContext() bool

func (*Extra) GetSpanContext

func (x *Extra) GetSpanContext() string

func (*Extra) GetTaskClass

func (x *Extra) GetTaskClass() string

func (*Extra) ProtoMessage

func (*Extra) ProtoMessage()

func (*Extra) ProtoReflect

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

func (*Extra) Reset

func (x *Extra) Reset()

func (*Extra) String

func (x *Extra) String() string

type SweepTask

type SweepTask struct {

	// DB is an identifier of the database used for reminders.
	// It must be registered in the process that does the sweeping.
	Db string `protobuf:"bytes,1,opt,name=db,proto3" json:"db,omitempty"`
	// Partition specifies the range of keys to scan as [Low..High).
	// It is a string of the form "<hex-low>_<hex-high>".
	Partition string `protobuf:"bytes,2,opt,name=partition,proto3" json:"partition,omitempty"`
	// Identifies a registered Lessor implementation to grab leases through.
	LessorId string `protobuf:"bytes,3,opt,name=lessor_id,json=lessorId,proto3" json:"lessor_id,omitempty"`
	// Identifier of a lease section ID to grab leases on sub-partitions through.
	LeaseSectionId string `protobuf:"bytes,4,opt,name=lease_section_id,json=leaseSectionId,proto3" json:"lease_section_id,omitempty"`
	// Total number of shards used when this task was generated.
	// Used FYI only in logs.
	ShardCount int32 `protobuf:"varint,5,opt,name=shard_count,json=shardCount,proto3" json:"shard_count,omitempty"`
	// Shard number in the range of [0 .. Shards).
	// Used FYI only in logs.
	ShardIndex int32 `protobuf:"varint,6,opt,name=shard_index,json=shardIndex,proto3" json:"shard_index,omitempty"`
	// Level counts recursion level for monitoring/debugging purposes.
	// The root sweeper triggers tasks at level=0. If there is a big backlog,
	// level=0 task will offload some work to level=1 tasks. level > 1 should not
	// normally happen and indicates either a bug or a very overloaded system.
	// level > 2 won't be executed at all.
	Level int32 `protobuf:"varint,7,opt,name=level,proto3" json:"level,omitempty"`
	// Length of the reminder keys in the partition.
	// Used to figure out the upper bound of the scan. Usually 16.
	KeySpaceBytes int32 `protobuf:"varint,8,opt,name=key_space_bytes,json=keySpaceBytes,proto3" json:"key_space_bytes,omitempty"`
	// Caps maximum number of reminders to process.
	// Usually in hundreds.
	TasksPerScan int32 `protobuf:"varint,9,opt,name=tasks_per_scan,json=tasksPerScan,proto3" json:"tasks_per_scan,omitempty"`
	// Caps the number of follow-up scans.
	// Usually 16.
	SecondaryScanShards int32 `protobuf:"varint,10,opt,name=secondary_scan_shards,json=secondaryScanShards,proto3" json:"secondary_scan_shards,omitempty"`
	// contains filtered or unexported fields

SweepTask is used to distribute sweeping work items and options when doing distributed sweeps.

All fields are required.

func (*SweepTask) Descriptor

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

Deprecated: Use SweepTask.ProtoReflect.Descriptor instead.

func (*SweepTask) GetDb

func (x *SweepTask) GetDb() string

func (*SweepTask) GetKeySpaceBytes

func (x *SweepTask) GetKeySpaceBytes() int32

func (*SweepTask) GetLeaseSectionId

func (x *SweepTask) GetLeaseSectionId() string

func (*SweepTask) GetLessorId

func (x *SweepTask) GetLessorId() string

func (*SweepTask) GetLevel

func (x *SweepTask) GetLevel() int32

func (*SweepTask) GetPartition

func (x *SweepTask) GetPartition() string

func (*SweepTask) GetSecondaryScanShards

func (x *SweepTask) GetSecondaryScanShards() int32

func (*SweepTask) GetShardCount

func (x *SweepTask) GetShardCount() int32

func (*SweepTask) GetShardIndex

func (x *SweepTask) GetShardIndex() int32

func (*SweepTask) GetTasksPerScan

func (x *SweepTask) GetTasksPerScan() int32

func (*SweepTask) ProtoMessage

func (*SweepTask) ProtoMessage()

func (*SweepTask) ProtoReflect

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

func (*SweepTask) Reset

func (x *SweepTask) Reset()

func (*SweepTask) String

func (x *SweepTask) String() string

Package Files

Documentation was rendered with GOOS=linux and GOARCH=amd64.

Jump to identifier

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to identifier