cvpb

package

v0.0.0-...-2cc3bea Latest Latest Go to latest Published: May 4, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

chromium.googlesource.com/infra/luci/luci-go

Links

Open Source Insights

Documentation ¶

Overview ¶

Package cvpb contains v1 version of CV API.

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	Run_Status_name = map[int32]string{
		0:  "STATUS_UNSPECIFIED",
		1:  "PENDING",
		2:  "RUNNING",
		4:  "WAITING_FOR_SUBMISSION",
		5:  "SUBMITTING",
		64: "ENDED_MASK",
		65: "SUCCEEDED",
		66: "FAILED",
		67: "CANCELLED",
	}
	Run_Status_value = map[string]int32{
		"STATUS_UNSPECIFIED":     0,
		"PENDING":                1,
		"RUNNING":                2,
		"WAITING_FOR_SUBMISSION": 4,
		"SUBMITTING":             5,
		"ENDED_MASK":             64,
		"SUCCEEDED":              65,
		"FAILED":                 66,
		"CANCELLED":              67,
	}
)

Enum value maps for Run_Status.

View Source

var File_go_chromium_org_luci_cv_api_v1_pubsub_proto protoreflect.FileDescriptor

View Source

var File_go_chromium_org_luci_cv_api_v1_run_proto protoreflect.FileDescriptor

Functions ¶

This section is empty.

Types ¶

type PubSubRun ¶

type PubSubRun struct {

	// The unique ID of the Run.
	//
	// The format of an ID is "projects/$luci-project/runs/$id", where
	// - luci-project is the name of the LUCI project the Run belongs to
	// - id is an opaque key unique in the LUCI project.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The Run status, e.g. pending, running, cancelled, etc.
	Status Run_Status `protobuf:"varint,2,opt,name=status,proto3,enum=cv.v1.Run_Status" json:"status,omitempty"`
	// eversion is the entity version, which is monotonically increasing.
	Eversion int64 `protobuf:"varint,3,opt,name=eversion,proto3" json:"eversion,omitempty"`
	// The hostname of the CV service that published the message.
	Hostname string `protobuf:"bytes,4,opt,name=hostname,proto3" json:"hostname,omitempty"`
	// contains filtered or unexported fields
}

PubSubRun includes the high-level information about the CV Run sent via PubSub.

This includes a subset of the fields defined in Run message. Use "runs.GetRun" rpc to retrieve the full field set of Runs.

func (*PubSubRun) Descriptor deprecated

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

Deprecated: Use PubSubRun.ProtoReflect.Descriptor instead.

func (*PubSubRun) GetEversion ¶

func (x *PubSubRun) GetEversion() int64

func (*PubSubRun) GetHostname ¶

func (x *PubSubRun) GetHostname() string

func (*PubSubRun) GetId ¶

func (x *PubSubRun) GetId() string

func (*PubSubRun) GetStatus ¶

func (x *PubSubRun) GetStatus() Run_Status

func (*PubSubRun) ProtoMessage ¶

func (*PubSubRun) ProtoMessage()

func (*PubSubRun) ProtoReflect ¶

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

func (*PubSubRun) Reset ¶

func (x *PubSubRun) Reset()

func (*PubSubRun) String ¶

func (x *PubSubRun) String() string

type Run ¶

type Run struct {

	// ID of the Run.
	//
	// The format of an ID is "projects/$luci-project/runs/$id", where
	// - luci-project is the name of the LUCI project the Run belongs to
	// - id is an opaque key unique in the LUCI project.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Status of the Run.
	Status Run_Status `protobuf:"varint,2,opt,name=status,proto3,enum=cv.v1.Run_Status" json:"status,omitempty"`
	// eversion is the entity version, which is monotonically increasing.
	Eversion int64 `protobuf:"varint,3,opt,name=eversion,proto3" json:"eversion,omitempty"`
	// contains filtered or unexported fields
}

Run includes the high-level information about a CV Run.

func (*Run) Descriptor deprecated

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

Deprecated: Use Run.ProtoReflect.Descriptor instead.

func (*Run) GetEversion ¶

func (x *Run) GetEversion() int64

func (*Run) GetId ¶

func (x *Run) GetId() string

func (*Run) GetStatus ¶

func (x *Run) GetStatus() Run_Status

func (*Run) ProtoMessage ¶

func (*Run) ProtoMessage()

func (*Run) ProtoReflect ¶

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

func (*Run) Reset ¶

func (x *Run) Reset()

func (*Run) String ¶

func (x *Run) String() string

type Run_Status ¶

type Run_Status int32

Status describes the status of a CV Run.

const (
	// Unspecified status.
	Run_STATUS_UNSPECIFIED Run_Status = 0
	// Run has not started yet.
	//
	// It is either because Run Manager hasn't processed the StartEvent yet or
	// the RunOwner has exhausted all the quota and waiting for new quota to be
	// available.
	Run_PENDING Run_Status = 1
	// Run is running.
	Run_RUNNING Run_Status = 2
	// Run is waiting for submission.
	//
	// Run is in this status if one of the following scenarios is true:
	//  1. Tree is closed at the time Run attempts to submit.
	//  2. There is another Run in the same LUCI Project that is currently
	//     submitting.
	//  3. The submission is rate-limited according to the submit option in
	//     Project Config.
	//
	// This status is cancellable.
	Run_WAITING_FOR_SUBMISSION Run_Status = 4
	// Run is submitting.
	//
	// A Run can't be cancelled while submitting. A Run may transition from
	// this status to either `WAITING_FOR_SUBMISSION` status or a non-cancelled
	// terminal status.
	Run_SUBMITTING Run_Status = 5
	// ENDED_MASK can be used as a bitmask to check if a Run has ended.
	// This MUST NOT be used as the status of a Run.
	Run_ENDED_MASK Run_Status = 64
	// Run ends successfully.
	Run_SUCCEEDED Run_Status = 65
	// Run ends unsuccessfully.
	Run_FAILED Run_Status = 66
	// Run is cancelled.
	Run_CANCELLED Run_Status = 67
)

func (Run_Status) Descriptor ¶

func (Run_Status) Descriptor() protoreflect.EnumDescriptor

func (Run_Status) Enum ¶

func (x Run_Status) Enum() *Run_Status

func (Run_Status) EnumDescriptor deprecated

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

Deprecated: Use Run_Status.Descriptor instead.

func (Run_Status) Number ¶

func (x Run_Status) Number() protoreflect.EnumNumber

func (Run_Status) String ¶

func (x Run_Status) String() string

func (Run_Status) Type ¶

func (Run_Status) Type() protoreflect.EnumType

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL