Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "STARTING",
		2: "RUNNING",
		3: "ABORTING",
		4: "SUCCESS",
		5: "FAIL",
		6: "ABORTED",
	}
	State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"STARTING":          1,
		"RUNNING":           2,
		"ABORTING":          3,
		"SUCCESS":           4,
		"FAIL":              5,
		"ABORTED":           6,
	}
)

Enum value maps for State.

View Source
var File_go_chromium_org_luci_server_dsmapper_dsmapperpb_messages_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type JobInfo

type JobInfo struct {
	Id                int64                  `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`                                                        // unique job identifier
	State             State                  `protobuf:"varint,2,opt,name=state,proto3,enum=luci.server.dsmapper.State" json:"state,omitempty"`                  // overall state of the job
	Created           *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=created,proto3" json:"created,omitempty"`                                               // when it was created
	Updated           *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=updated,proto3" json:"updated,omitempty"`                                               // when it was updated last time
	Eta               *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=eta,proto3" json:"eta,omitempty"`                                                       // when it finishes (if tracking progress)
	ProcessedEntities int64                  `protobuf:"varint,6,opt,name=processed_entities,json=processedEntities,proto3" json:"processed_entities,omitempty"` // number of processed entities thus far
	TotalEntities     int64                  `protobuf:"varint,7,opt,name=total_entities,json=totalEntities,proto3" json:"total_entities,omitempty"`             // total number of entities or -1 if unknown
	EntitiesPerSec    float32                `protobuf:"fixed32,8,opt,name=entities_per_sec,json=entitiesPerSec,proto3" json:"entities_per_sec,omitempty"`       // rate of processing, entities per second
	Shards            []*ShardInfo           `protobuf:"bytes,20,rep,name=shards,proto3" json:"shards,omitempty"`                                                // state of all job's shards
	// contains filtered or unexported fields
}

Information about a job.

func (*JobInfo) Descriptor

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

Deprecated: Use JobInfo.ProtoReflect.Descriptor instead.

func (*JobInfo) GetCreated

func (x *JobInfo) GetCreated() *timestamppb.Timestamp

func (*JobInfo) GetEntitiesPerSec

func (x *JobInfo) GetEntitiesPerSec() float32

func (*JobInfo) GetEta

func (x *JobInfo) GetEta() *timestamppb.Timestamp

func (*JobInfo) GetId

func (x *JobInfo) GetId() int64

func (*JobInfo) GetProcessedEntities

func (x *JobInfo) GetProcessedEntities() int64

func (*JobInfo) GetShards

func (x *JobInfo) GetShards() []*ShardInfo

func (*JobInfo) GetState

func (x *JobInfo) GetState() State

func (*JobInfo) GetTotalEntities

func (x *JobInfo) GetTotalEntities() int64

func (*JobInfo) GetUpdated

func (x *JobInfo) GetUpdated() *timestamppb.Timestamp

func (*JobInfo) ProtoMessage

func (*JobInfo) ProtoMessage()

func (*JobInfo) ProtoReflect

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

func (*JobInfo) Reset

func (x *JobInfo) Reset()

func (*JobInfo) String

func (x *JobInfo) String() string

type ShardInfo

type ShardInfo struct {
	Index             int32                  `protobuf:"varint,1,opt,name=index,proto3" json:"index,omitempty"` // zero-based index of the shard
	State             State                  `protobuf:"varint,2,opt,name=state,proto3,enum=luci.server.dsmapper.State" json:"state,omitempty"`
	Error             string                 `protobuf:"bytes,3,opt,name=error,proto3" json:"error,omitempty"`                                                   // human readable error message, for failed shards only
	Created           *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=created,proto3" json:"created,omitempty"`                                               // when it was created
	Updated           *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=updated,proto3" json:"updated,omitempty"`                                               // when it was updated last time
	Eta               *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=eta,proto3" json:"eta,omitempty"`                                                       // when it finishes (if tracking progress)
	ProcessedEntities int64                  `protobuf:"varint,7,opt,name=processed_entities,json=processedEntities,proto3" json:"processed_entities,omitempty"` // number of processed entities thus far
	TotalEntities     int64                  `protobuf:"varint,8,opt,name=total_entities,json=totalEntities,proto3" json:"total_entities,omitempty"`             // total number of entities or -1 if unknown
	EntitiesPerSec    float32                `protobuf:"fixed32,9,opt,name=entities_per_sec,json=entitiesPerSec,proto3" json:"entities_per_sec,omitempty"`       // rate of processing, entities per second
	// contains filtered or unexported fields
}

Information about some single shard of a job.

func (*ShardInfo) Descriptor

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

Deprecated: Use ShardInfo.ProtoReflect.Descriptor instead.

func (*ShardInfo) GetCreated

func (x *ShardInfo) GetCreated() *timestamppb.Timestamp

func (*ShardInfo) GetEntitiesPerSec

func (x *ShardInfo) GetEntitiesPerSec() float32

func (*ShardInfo) GetError

func (x *ShardInfo) GetError() string

func (*ShardInfo) GetEta

func (x *ShardInfo) GetEta() *timestamppb.Timestamp

func (*ShardInfo) GetIndex

func (x *ShardInfo) GetIndex() int32

func (*ShardInfo) GetProcessedEntities

func (x *ShardInfo) GetProcessedEntities() int64

func (*ShardInfo) GetState

func (x *ShardInfo) GetState() State

func (*ShardInfo) GetTotalEntities

func (x *ShardInfo) GetTotalEntities() int64

func (*ShardInfo) GetUpdated

func (x *ShardInfo) GetUpdated() *timestamppb.Timestamp

func (*ShardInfo) ProtoMessage

func (*ShardInfo) ProtoMessage()

func (*ShardInfo) ProtoReflect

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

func (*ShardInfo) Reset

func (x *ShardInfo) Reset()

func (*ShardInfo) String

func (x *ShardInfo) String() string

type State

type State int32

State of a job or one of its shards.

const (
	State_STATE_UNSPECIFIED State = 0
	State_STARTING          State = 1
	State_RUNNING           State = 2
	State_ABORTING          State = 3
	State_SUCCESS           State = 4
	State_FAIL              State = 5
	State_ABORTED           State = 6
)

func (State) Descriptor

func (State) Descriptor() protoreflect.EnumDescriptor

func (State) Enum

func (x State) Enum() *State

func (State) EnumDescriptor

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

Deprecated: Use State.Descriptor instead.

func (State) Number

func (x State) Number() protoreflect.EnumNumber

func (State) String

func (x State) String() string

func (State) Type

func (State) Type() protoreflect.EnumType