milo

package
v0.0.0-...-678bb0e Latest Latest
Warning

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

 Go to latest Published: Aug 8, 2017 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package milo is a generated protocol buffer package.

It is generated from these files: 

github.com/luci/luci-go/common/proto/milo/annotations.proto

It has these top-level messages: 

FailureDetails
Step
Link
LogdogStream
IsolateObject
DMLink

Package milo contains Milo protobuf definitions.

The package name here must match the protobuf package name, as the generated files will reside in the same directory.

Index

Constants

View Source 
const ContentTypeAnnotations = "text/x-chrome-infra-annotations; version=2"

ContentTypeAnnotations is a stream content type for annotation streams.

Variables

View Source 
var FailureDetails_Type_name = map[int32]string{
	0: "GENERAL",
	1: "EXCEPTION",
	2: "INFRA",
	3: "DM_DEPENDENCY_FAILED",
	4: "CANCELLED",
	5: "EXPIRED",
}
View Source 
var FailureDetails_Type_value = map[string]int32{
	"GENERAL":              0,
	"EXCEPTION":            1,
	"INFRA":                2,
	"DM_DEPENDENCY_FAILED": 3,
	"CANCELLED":            4,
	"EXPIRED":              5,
}
View Source 
var Status_name = map[int32]string{
	0: "RUNNING",
	1: "SUCCESS",
	2: "FAILURE",
	3: "PENDING",
}
View Source 
var Status_value = map[string]int32{
	"RUNNING": 0,
	"SUCCESS": 1,
	"FAILURE": 2,
	"PENDING": 3,
}

Functions

This section is empty.

Types 

type DMLink struct {
	// The Dungeon Master server. If empty, this is the default Isolate server
	// specified by the project's LUCI config.
	Server string `protobuf:"bytes,1,opt,name=server" json:"server,omitempty"`
	// The quest name.
	Quest string `protobuf:"bytes,2,opt,name=quest" json:"quest,omitempty"`
	// The attempt number.
	Attempt int64 `protobuf:"varint,3,opt,name=attempt" json:"attempt,omitempty"`
	// The execution number.
	Execution int64 `protobuf:"varint,4,opt,name=execution" json:"execution,omitempty"`
}

DMLink is a Dungeon Master execution specification.

func (*DMLink) Descriptor 

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

func (*DMLink) GetAttempt 

func (m *DMLink) GetAttempt() int64

func (*DMLink) GetExecution 

func (m *DMLink) GetExecution() int64

func (*DMLink) GetQuest 

func (m *DMLink) GetQuest() string

func (*DMLink) GetServer 

func (m *DMLink) GetServer() string

func (*DMLink) ProtoMessage 

func (*DMLink) ProtoMessage()

func (*DMLink) Reset 

func (m *DMLink) Reset()

func (*DMLink) String 

func (m *DMLink) String() string

type FailureDetails 

type FailureDetails struct {
	Type FailureDetails_Type `protobuf:"varint,1,opt,name=type,enum=milo.FailureDetails_Type" json:"type,omitempty"`
	// An optional string describing the failure.
	Text string `protobuf:"bytes,2,opt,name=text" json:"text,omitempty"`
	// If the failure type is DEPENDENCY_FAILED, the failed dependencies should be
	// listed here.
	FailedDmDependency []*DMLink `protobuf:"bytes,3,rep,name=failed_dm_dependency,json=failedDmDependency" json:"failed_dm_dependency,omitempty"`
}

FailureType provides more details on the nature of the Status.

func (*FailureDetails) Descriptor 

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

func (*FailureDetails) GetFailedDmDependency 

func (m *FailureDetails) GetFailedDmDependency() []*DMLink

func (*FailureDetails) GetText 

func (m *FailureDetails) GetText() string

func (*FailureDetails) GetType 

func (m *FailureDetails) GetType() FailureDetails_Type

func (*FailureDetails) ProtoMessage 

func (*FailureDetails) ProtoMessage()

func (*FailureDetails) Reset 

func (m *FailureDetails) Reset()

func (*FailureDetails) String 

func (m *FailureDetails) String() string

type FailureDetails_Type 

type FailureDetails_Type int32

Type is the type of failure. 

const (
	// The failure is a general failure.
	FailureDetails_GENERAL FailureDetails_Type = 0
	// An unhandled exception occured during execution.
	FailureDetails_EXCEPTION FailureDetails_Type = 1
	// The failure is related to a failed infrastructure component, not an error
	// with the Step itself.
	FailureDetails_INFRA FailureDetails_Type = 2
	// The failure is due to a failed Dungeon Master dependency. This should be
	// used if a Step's external depdendency fails and the Step cannot recover
	// or proceed without it.
	FailureDetails_DM_DEPENDENCY_FAILED FailureDetails_Type = 3
	// The step was cancelled.
	FailureDetails_CANCELLED FailureDetails_Type = 4
	// The failure was due to an resource exhausion. The step was scheduled
	// but never ran, and never will run.
	FailureDetails_EXPIRED FailureDetails_Type = 5
)

func (FailureDetails_Type) EnumDescriptor 

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

func (FailureDetails_Type) String 

func (x FailureDetails_Type) String() string

type IsolateObject 

type IsolateObject struct {
	// The Isolate server. If empty, this is the default Isolate server specified
	// by the project's LUCI config.
	Server string `protobuf:"bytes,1,opt,name=server" json:"server,omitempty"`
	// The isolate object hash.
	Hash string `protobuf:"bytes,2,opt,name=hash" json:"hash,omitempty"`
}

IsolateObject is an Isolate service object specification.

func (*IsolateObject) Descriptor 

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

func (*IsolateObject) GetHash 

func (m *IsolateObject) GetHash() string

func (*IsolateObject) GetServer 

func (m *IsolateObject) GetServer() string

func (*IsolateObject) ProtoMessage 

func (*IsolateObject) ProtoMessage()

func (*IsolateObject) Reset 

func (m *IsolateObject) Reset()

func (*IsolateObject) String 

func (m *IsolateObject) String() string
type Link struct {
	// An optional display label for the link.
	Label string `protobuf:"bytes,1,opt,name=label" json:"label,omitempty"`
	// If present, this link is an alias for another link with this name, and
	// should be rendered in relation to that link.
	AliasLabel string `protobuf:"bytes,2,opt,name=alias_label,json=aliasLabel" json:"alias_label,omitempty"`
	// Types that are valid to be assigned to Value:
	//	*Link_Url
	//	*Link_LogdogStream
	//	*Link_IsolateObject
	//	*Link_DmLink
	Value isLink_Value `protobuf_oneof:"value"`
}

A Link is an optional label followed by a typed link to an external resource.

func (*Link) Descriptor 

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

func (*Link) GetAliasLabel 

func (m *Link) GetAliasLabel() string
func (m *Link) GetDmLink() *DMLink

func (*Link) GetIsolateObject 

func (m *Link) GetIsolateObject() *IsolateObject

func (*Link) GetLabel 

func (m *Link) GetLabel() string

func (*Link) GetLogdogStream 

func (m *Link) GetLogdogStream() *LogdogStream

func (*Link) GetUrl 

func (m *Link) GetUrl() string

func (*Link) GetValue 

func (m *Link) GetValue() isLink_Value

func (*Link) ProtoMessage 

func (*Link) ProtoMessage()

func (*Link) Reset 

func (m *Link) Reset()

func (*Link) String 

func (m *Link) String() string

func (*Link) XXX_OneofFuncs 

func (*Link) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package. 

type Link_DmLink struct {
	DmLink *DMLink `protobuf:"bytes,6,opt,name=dm_link,json=dmLink,oneof"`
}
type Link_IsolateObject struct {
	IsolateObject *IsolateObject `protobuf:"bytes,5,opt,name=isolate_object,json=isolateObject,oneof"`
}
type Link_LogdogStream struct {
	LogdogStream *LogdogStream `protobuf:"bytes,4,opt,name=logdog_stream,json=logdogStream,oneof"`
}
type Link_Url struct {
	Url string `protobuf:"bytes,3,opt,name=url,oneof"`
}

type LogdogStream 

type LogdogStream struct {
	// The stream's server. If omitted, the server is the same server that this
	// annotation stream is homed on.
	Server string `protobuf:"bytes,1,opt,name=server" json:"server,omitempty"`
	// The log Prefix. If empty, the prefix is the same prefix as this annotation
	// stream.
	Prefix string `protobuf:"bytes,2,opt,name=prefix" json:"prefix,omitempty"`
	// The log name.
	Name string `protobuf:"bytes,3,opt,name=name" json:"name,omitempty"`
}

LogdogStream is a LogDog stream link.

func (*LogdogStream) Descriptor 

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

func (*LogdogStream) GetName 

func (m *LogdogStream) GetName() string

func (*LogdogStream) GetPrefix 

func (m *LogdogStream) GetPrefix() string

func (*LogdogStream) GetServer 

func (m *LogdogStream) GetServer() string

func (*LogdogStream) ProtoMessage 

func (*LogdogStream) ProtoMessage()

func (*LogdogStream) Reset 

func (m *LogdogStream) Reset()

func (*LogdogStream) String 

func (m *LogdogStream) String() string

type Status 

type Status int32

Status is the expressed root step of this step or substep. 

const (
	// The step is still running.
	Status_RUNNING Status = 0
	// The step has finished successfully.
	Status_SUCCESS Status = 1
	// The step has finished unsuccessfully.
	Status_FAILURE Status = 2
	// The step has been scheduled, but not yet started.
	Status_PENDING Status = 3
)

func (Status) EnumDescriptor 

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

func (Status) String 

func (x Status) String() string

type Step 

type Step struct {
	// The display name of the Component.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// The command-line invocation of the step, expressed as an argument vector.
	Command *Step_Command `protobuf:"bytes,2,opt,name=command" json:"command,omitempty"`
	// The current running status of the Step.
	Status Status `protobuf:"varint,3,opt,name=status,enum=milo.Status" json:"status,omitempty"`
	// Optional information detailing the failure. This may be populated if the
	// Step's top-level command Status is set to FAILURE.
	FailureDetails *FailureDetails `protobuf:"bytes,4,opt,name=failure_details,json=failureDetails" json:"failure_details,omitempty"`
	// Substeps that this Step is composed of.
	Substep []*Step_Substep `protobuf:"bytes,5,rep,name=substep" json:"substep,omitempty"`
	// A link to this Step's STDOUT stream, if present.
	StdoutStream *LogdogStream `protobuf:"bytes,6,opt,name=stdout_stream,json=stdoutStream" json:"stdout_stream,omitempty"`
	// A link to this Step's STDERR stream, if present.
	StderrStream *LogdogStream `protobuf:"bytes,7,opt,name=stderr_stream,json=stderrStream" json:"stderr_stream,omitempty"`
	// When the step started, expressed as an RFC3339 string using Z (UTC)
	// timezone.
	Started *google_protobuf.Timestamp `protobuf:"bytes,8,opt,name=started" json:"started,omitempty"`
	// When the step ended, expressed as an RFC3339 string using Z (UTC) timezone.
	Ended *google_protobuf.Timestamp `protobuf:"bytes,9,opt,name=ended" json:"ended,omitempty"`
	// Arbitrary lines of component text. Each string here is a consecutive line,
	// and should not contain newlines.
	Text []string `protobuf:"bytes,20,rep,name=text" json:"text,omitempty"`
	// The Component's progress.
	Progress *Step_Progress `protobuf:"bytes,21,opt,name=progress" json:"progress,omitempty"`
	// The primary link for this Component. This is the link that interaction
	// with the Component will use.
	Link *Link `protobuf:"bytes,22,opt,name=link" json:"link,omitempty"`
	// Additional links related to the Component. These will be rendered alongside
	// the component.
	OtherLinks []*Link          `protobuf:"bytes,23,rep,name=other_links,json=otherLinks" json:"other_links,omitempty"`
	Property   []*Step_Property `protobuf:"bytes,24,rep,name=property" json:"property,omitempty"`
	// Maps the name of the Manifest, e.g. UNPATCHED, INFRA, etc. to the
	// ManifestLink. This name will be used in the milo console definition to
	// indicate which manifest data to sort the console view by.
	SourceManifests map[string]*Step_ManifestLink `` /* 174-byte string literal not displayed */
}

Generic step or substep state.

func (*Step) Descriptor 

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

func (*Step) GetCommand 

func (m *Step) GetCommand() *Step_Command

func (*Step) GetEnded 

func (m *Step) GetEnded() *google_protobuf.Timestamp

func (*Step) GetFailureDetails 

func (m *Step) GetFailureDetails() *FailureDetails
func (m *Step) GetLink() *Link

func (*Step) GetName 

func (m *Step) GetName() string
func (m *Step) GetOtherLinks() []*Link

func (*Step) GetProgress 

func (m *Step) GetProgress() *Step_Progress

func (*Step) GetProperty 

func (m *Step) GetProperty() []*Step_Property

func (*Step) GetSourceManifests 

func (m *Step) GetSourceManifests() map[string]*Step_ManifestLink

func (*Step) GetStarted 

func (m *Step) GetStarted() *google_protobuf.Timestamp

func (*Step) GetStatus 

func (m *Step) GetStatus() Status

func (*Step) GetStderrStream 

func (m *Step) GetStderrStream() *LogdogStream

func (*Step) GetStdoutStream 

func (m *Step) GetStdoutStream() *LogdogStream

func (*Step) GetSubstep 

func (m *Step) GetSubstep() []*Step_Substep

func (*Step) GetText 

func (m *Step) GetText() []string

func (*Step) ProtoMessage 

func (*Step) ProtoMessage()

func (*Step) Reset 

func (m *Step) Reset()

func (*Step) String 

func (m *Step) String() string

type Step_Command 

type Step_Command struct {
	// The command-line invocation, expressed as an argument vector.
	CommandLine []string `protobuf:"bytes,1,rep,name=command_line,json=commandLine" json:"command_line,omitempty"`
	// The current working directory.
	Cwd string `protobuf:"bytes,2,opt,name=cwd" json:"cwd,omitempty"`
	// Environment represents the state of a process' environment.
	Environ map[string]string `` /* 134-byte string literal not displayed */
}

Command contains information about a command-line invocation.

func (*Step_Command) Descriptor 

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

func (*Step_Command) GetCommandLine 

func (m *Step_Command) GetCommandLine() []string

func (*Step_Command) GetCwd 

func (m *Step_Command) GetCwd() string

func (*Step_Command) GetEnviron 

func (m *Step_Command) GetEnviron() map[string]string

func (*Step_Command) ProtoMessage 

func (*Step_Command) ProtoMessage()

func (*Step_Command) Reset 

func (m *Step_Command) Reset()

func (*Step_Command) String 

func (m *Step_Command) String() string
type Step_ManifestLink struct {
	// The fully qualified (logdog://) url of the Manifest proto. It's expected
	// that this is a binary logdog stream consisting of exactly one Manifest
	// proto.
	Url string `protobuf:"bytes,1,opt,name=url" json:"url,omitempty"`
	// The hash of the Manifest's raw binary form (i.e. the bytes at the end of
	// `url`, without any interpretation or decoding). Milo will use this as an
	// optimization; Manifests will be interned once into Milo's datastore.
	// Future hashes which match will not be loaded from the url, but will be
	// assumed to be identical. If the sha256 doesn't match the data at the URL,
	// Milo may render this build with the wrong manifest.
	//
	// This is the raw sha256, so it should be exactly 32 bytes.
	Sha256 []byte `protobuf:"bytes,2,opt,name=sha256,proto3" json:"sha256,omitempty"`
}

Links to a recipe_engine.Manifest proto.

func (*Step_ManifestLink) Descriptor 

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

func (*Step_ManifestLink) GetSha256 

func (m *Step_ManifestLink) GetSha256() []byte

func (*Step_ManifestLink) GetUrl 

func (m *Step_ManifestLink) GetUrl() string

func (*Step_ManifestLink) ProtoMessage 

func (*Step_ManifestLink) ProtoMessage()

func (*Step_ManifestLink) Reset 

func (m *Step_ManifestLink) Reset()

func (*Step_ManifestLink) String 

func (m *Step_ManifestLink) String() string

type Step_Progress 

type Step_Progress struct {
	// The total number of progress units. If missing or zero, no progress is
	// expressed.
	Total int32 `protobuf:"varint,1,opt,name=total" json:"total,omitempty"`
	// The number of completed progress units. This must always be less than or
	// equal to `total`. If omitted, it is implied to be zero.
	Completed int32 `protobuf:"varint,2,opt,name=completed" json:"completed,omitempty"`
}

Progress expresses a Component's overall progress. It does this using arbitrary "progress units", wich are discrete units of work measured by the Component that are either completed or not completed.

A simple construction for "percentage complete" is to set `total` to 100 and `completed` to the percentage value.

func (*Step_Progress) Descriptor 

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

func (*Step_Progress) GetCompleted 

func (m *Step_Progress) GetCompleted() int32

func (*Step_Progress) GetTotal 

func (m *Step_Progress) GetTotal() int32

func (*Step_Progress) ProtoMessage 

func (*Step_Progress) ProtoMessage()

func (*Step_Progress) Reset 

func (m *Step_Progress) Reset()

func (*Step_Progress) String 

func (m *Step_Progress) String() string

type Step_Property 

type Step_Property struct {
	// name is the property name.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// value is the optional property value.
	Value string `protobuf:"bytes,2,opt,name=value" json:"value,omitempty"`
}

Property is an arbitrary key/value (build) property.

func (*Step_Property) Descriptor 

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

func (*Step_Property) GetName 

func (m *Step_Property) GetName() string

func (*Step_Property) GetValue 

func (m *Step_Property) GetValue() string

func (*Step_Property) ProtoMessage 

func (*Step_Property) ProtoMessage()

func (*Step_Property) Reset 

func (m *Step_Property) Reset()

func (*Step_Property) String 

func (m *Step_Property) String() string

type Step_Substep 

type Step_Substep struct {
	// The substep.
	//
	// Types that are valid to be assigned to Substep:
	//	*Step_Substep_Step
	//	*Step_Substep_AnnotationStream
	Substep isStep_Substep_Substep `protobuf_oneof:"substep"`
}

Sub-steps nested underneath of this step.

func (*Step_Substep) Descriptor 

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

func (*Step_Substep) GetAnnotationStream 

func (m *Step_Substep) GetAnnotationStream() *LogdogStream

func (*Step_Substep) GetStep 

func (m *Step_Substep) GetStep() *Step

func (*Step_Substep) GetSubstep 

func (m *Step_Substep) GetSubstep() isStep_Substep_Substep

func (*Step_Substep) ProtoMessage 

func (*Step_Substep) ProtoMessage()

func (*Step_Substep) Reset 

func (m *Step_Substep) Reset()

func (*Step_Substep) String 

func (m *Step_Substep) String() string

func (*Step_Substep) XXX_OneofFuncs 

func (*Step_Substep) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type Step_Substep_AnnotationStream 

type Step_Substep_AnnotationStream struct {
	AnnotationStream *LogdogStream `protobuf:"bytes,2,opt,name=annotation_stream,json=annotationStream,oneof"`
}

type Step_Substep_Step 

type Step_Substep_Step struct {
	Step *Step `protobuf:"bytes,1,opt,name=step,oneof"`
}

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.