build

package
v0.0.0-...-6b3ec00 Latest Latest
Warning

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

Go to latest
Published: Dec 19, 2024 License: Apache-2.0 Imports: 14 Imported by: 18

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	ConsoleOutputStream_name = map[int32]string{
		0: "UNKNOWN",
		1: "STDOUT",
		2: "STDERR",
	}
	ConsoleOutputStream_value = map[string]int32{
		"UNKNOWN": 0,
		"STDOUT":  1,
		"STDERR":  2,
	}
)

Enum value maps for ConsoleOutputStream.

View Source
var (
	BuildEvent_BuildComponentStreamFinished_FinishType_name = map[int32]string{
		0: "FINISH_TYPE_UNSPECIFIED",
		1: "FINISHED",
		2: "EXPIRED",
	}
	BuildEvent_BuildComponentStreamFinished_FinishType_value = map[string]int32{
		"FINISH_TYPE_UNSPECIFIED": 0,
		"FINISHED":                1,
		"EXPIRED":                 2,
	}
)

Enum value maps for BuildEvent_BuildComponentStreamFinished_FinishType.

View Source
var (
	StreamId_BuildComponent_name = map[int32]string{
		0: "UNKNOWN_COMPONENT",
		1: "CONTROLLER",
		2: "WORKER",
		3: "TOOL",
	}
	StreamId_BuildComponent_value = map[string]int32{
		"UNKNOWN_COMPONENT": 0,
		"CONTROLLER":        1,
		"WORKER":            2,
		"TOOL":              3,
	}
)

Enum value maps for StreamId_BuildComponent.

View Source
var (
	BuildStatus_Result_name = map[int32]string{
		0: "UNKNOWN_STATUS",
		1: "COMMAND_SUCCEEDED",
		2: "COMMAND_FAILED",
		3: "USER_ERROR",
		4: "SYSTEM_ERROR",
		5: "RESOURCE_EXHAUSTED",
		6: "INVOCATION_DEADLINE_EXCEEDED",
		8: "REQUEST_DEADLINE_EXCEEDED",
		7: "CANCELLED",
	}
	BuildStatus_Result_value = map[string]int32{
		"UNKNOWN_STATUS":               0,
		"COMMAND_SUCCEEDED":            1,
		"COMMAND_FAILED":               2,
		"USER_ERROR":                   3,
		"SYSTEM_ERROR":                 4,
		"RESOURCE_EXHAUSTED":           5,
		"INVOCATION_DEADLINE_EXCEEDED": 6,
		"REQUEST_DEADLINE_EXCEEDED":    8,
		"CANCELLED":                    7,
	}
)

Enum value maps for BuildStatus_Result.

View Source
var (
	PublishLifecycleEventRequest_ServiceLevel_name = map[int32]string{
		0: "NONINTERACTIVE",
		1: "INTERACTIVE",
	}
	PublishLifecycleEventRequest_ServiceLevel_value = map[string]int32{
		"NONINTERACTIVE": 0,
		"INTERACTIVE":    1,
	}
)

Enum value maps for PublishLifecycleEventRequest_ServiceLevel.

View Source
var File_google_devtools_build_v1_build_events_proto protoreflect.FileDescriptor
View Source
var File_google_devtools_build_v1_build_status_proto protoreflect.FileDescriptor
View Source
var File_google_devtools_build_v1_publish_build_event_proto protoreflect.FileDescriptor

Functions

func RegisterPublishBuildEventServer

func RegisterPublishBuildEventServer(s *grpc.Server, srv PublishBuildEventServer)

Types

type BuildEvent

type BuildEvent struct {

	// This should be precisely the time when this event happened, and not when
	// the event proto was created or sent.
	EventTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=event_time,json=eventTime,proto3" json:"event_time,omitempty"`
	// //////////////////////////////////////////////////////////////////////////
	// Events that indicate a state change of a build request in the build
	// queue.
	//
	// Types that are assignable to Event:
	//
	//	*BuildEvent_InvocationAttemptStarted_
	//	*BuildEvent_InvocationAttemptFinished_
	//	*BuildEvent_BuildEnqueued_
	//	*BuildEvent_BuildFinished_
	//	*BuildEvent_ConsoleOutput_
	//	*BuildEvent_ComponentStreamFinished
	//	*BuildEvent_BazelEvent
	//	*BuildEvent_BuildExecutionEvent
	//	*BuildEvent_SourceFetchEvent
	Event isBuildEvent_Event `protobuf_oneof:"event"`
	// contains filtered or unexported fields
}

An event representing some state change that occurred in the build. This message does not include field for uniquely identifying an event.

func (*BuildEvent) Descriptor deprecated

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

Deprecated: Use BuildEvent.ProtoReflect.Descriptor instead.

func (*BuildEvent) GetBazelEvent

func (x *BuildEvent) GetBazelEvent() *anypb.Any

func (*BuildEvent) GetBuildEnqueued

func (x *BuildEvent) GetBuildEnqueued() *BuildEvent_BuildEnqueued

func (*BuildEvent) GetBuildExecutionEvent

func (x *BuildEvent) GetBuildExecutionEvent() *anypb.Any

func (*BuildEvent) GetBuildFinished

func (x *BuildEvent) GetBuildFinished() *BuildEvent_BuildFinished

func (*BuildEvent) GetComponentStreamFinished

func (x *BuildEvent) GetComponentStreamFinished() *BuildEvent_BuildComponentStreamFinished

func (*BuildEvent) GetConsoleOutput

func (x *BuildEvent) GetConsoleOutput() *BuildEvent_ConsoleOutput

func (*BuildEvent) GetEvent

func (m *BuildEvent) GetEvent() isBuildEvent_Event

func (*BuildEvent) GetEventTime

func (x *BuildEvent) GetEventTime() *timestamppb.Timestamp

func (*BuildEvent) GetInvocationAttemptFinished

func (x *BuildEvent) GetInvocationAttemptFinished() *BuildEvent_InvocationAttemptFinished

func (*BuildEvent) GetInvocationAttemptStarted

func (x *BuildEvent) GetInvocationAttemptStarted() *BuildEvent_InvocationAttemptStarted

func (*BuildEvent) GetSourceFetchEvent

func (x *BuildEvent) GetSourceFetchEvent() *anypb.Any

func (*BuildEvent) ProtoMessage

func (*BuildEvent) ProtoMessage()

func (*BuildEvent) ProtoReflect

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

func (*BuildEvent) Reset

func (x *BuildEvent) Reset()

func (*BuildEvent) String

func (x *BuildEvent) String() string

type BuildEvent_BazelEvent

type BuildEvent_BazelEvent struct {
	// Structured build event generated by Bazel about its execution progress.
	BazelEvent *anypb.Any `protobuf:"bytes,60,opt,name=bazel_event,json=bazelEvent,proto3,oneof"`
}

type BuildEvent_BuildComponentStreamFinished

type BuildEvent_BuildComponentStreamFinished struct {

	// How the event stream finished.
	Type BuildEvent_BuildComponentStreamFinished_FinishType `` /* 143-byte string literal not displayed */
	// contains filtered or unexported fields
}

Notification of the end of a build event stream published by a build component other than CONTROLLER (See StreamId.BuildComponents).

func (*BuildEvent_BuildComponentStreamFinished) Descriptor deprecated

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

Deprecated: Use BuildEvent_BuildComponentStreamFinished.ProtoReflect.Descriptor instead.

func (*BuildEvent_BuildComponentStreamFinished) GetType

func (*BuildEvent_BuildComponentStreamFinished) ProtoMessage

func (*BuildEvent_BuildComponentStreamFinished) ProtoReflect

func (*BuildEvent_BuildComponentStreamFinished) Reset

func (*BuildEvent_BuildComponentStreamFinished) String

type BuildEvent_BuildComponentStreamFinished_FinishType

type BuildEvent_BuildComponentStreamFinished_FinishType int32

How did the event stream finish.

const (
	// Unknown or unspecified; callers should never set this value.
	BuildEvent_BuildComponentStreamFinished_FINISH_TYPE_UNSPECIFIED BuildEvent_BuildComponentStreamFinished_FinishType = 0
	// Set by the event publisher to indicate a build event stream is
	// finished.
	BuildEvent_BuildComponentStreamFinished_FINISHED BuildEvent_BuildComponentStreamFinished_FinishType = 1
	// Set by the WatchBuild RPC server when the publisher of a build event
	// stream stops publishing events without publishing a
	// BuildComponentStreamFinished event whose type equals FINISHED.
	BuildEvent_BuildComponentStreamFinished_EXPIRED BuildEvent_BuildComponentStreamFinished_FinishType = 2
)

func (BuildEvent_BuildComponentStreamFinished_FinishType) Descriptor

func (BuildEvent_BuildComponentStreamFinished_FinishType) Enum

func (BuildEvent_BuildComponentStreamFinished_FinishType) EnumDescriptor deprecated

Deprecated: Use BuildEvent_BuildComponentStreamFinished_FinishType.Descriptor instead.

func (BuildEvent_BuildComponentStreamFinished_FinishType) Number

func (BuildEvent_BuildComponentStreamFinished_FinishType) String

func (BuildEvent_BuildComponentStreamFinished_FinishType) Type

type BuildEvent_BuildEnqueued

type BuildEvent_BuildEnqueued struct {

	// Additional details about the Build.
	Details *anypb.Any `protobuf:"bytes,1,opt,name=details,proto3" json:"details,omitempty"`
	// contains filtered or unexported fields
}

Notification that the build request is enqueued.

func (*BuildEvent_BuildEnqueued) Descriptor deprecated

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

Deprecated: Use BuildEvent_BuildEnqueued.ProtoReflect.Descriptor instead.

func (*BuildEvent_BuildEnqueued) GetDetails

func (x *BuildEvent_BuildEnqueued) GetDetails() *anypb.Any

func (*BuildEvent_BuildEnqueued) ProtoMessage

func (*BuildEvent_BuildEnqueued) ProtoMessage()

func (*BuildEvent_BuildEnqueued) ProtoReflect

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

func (*BuildEvent_BuildEnqueued) Reset

func (x *BuildEvent_BuildEnqueued) Reset()

func (*BuildEvent_BuildEnqueued) String

func (x *BuildEvent_BuildEnqueued) String() string

type BuildEvent_BuildEnqueued_

type BuildEvent_BuildEnqueued_ struct {
	// The build is enqueued.
	BuildEnqueued *BuildEvent_BuildEnqueued `protobuf:"bytes,53,opt,name=build_enqueued,json=buildEnqueued,proto3,oneof"`
}

type BuildEvent_BuildExecutionEvent

type BuildEvent_BuildExecutionEvent struct {
	// An event that contains supplemental tool-specific information about
	// build execution.
	BuildExecutionEvent *anypb.Any `protobuf:"bytes,61,opt,name=build_execution_event,json=buildExecutionEvent,proto3,oneof"`
}

type BuildEvent_BuildFinished

type BuildEvent_BuildFinished struct {

	// Final status of the build.
	Status *BuildStatus `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// Additional details about the Build.
	Details *anypb.Any `protobuf:"bytes,2,opt,name=details,proto3" json:"details,omitempty"`
	// contains filtered or unexported fields
}

Notification that the build request has finished, and no further invocations will occur. Note that this applies to the entire Build. Individual invocations trigger InvocationFinished when they finish.

func (*BuildEvent_BuildFinished) Descriptor deprecated

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

Deprecated: Use BuildEvent_BuildFinished.ProtoReflect.Descriptor instead.

func (*BuildEvent_BuildFinished) GetDetails

func (x *BuildEvent_BuildFinished) GetDetails() *anypb.Any

func (*BuildEvent_BuildFinished) GetStatus

func (x *BuildEvent_BuildFinished) GetStatus() *BuildStatus

func (*BuildEvent_BuildFinished) ProtoMessage

func (*BuildEvent_BuildFinished) ProtoMessage()

func (*BuildEvent_BuildFinished) ProtoReflect

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

func (*BuildEvent_BuildFinished) Reset

func (x *BuildEvent_BuildFinished) Reset()

func (*BuildEvent_BuildFinished) String

func (x *BuildEvent_BuildFinished) String() string

type BuildEvent_BuildFinished_

type BuildEvent_BuildFinished_ struct {
	// The build has finished. Set when the build is terminated.
	BuildFinished *BuildEvent_BuildFinished `protobuf:"bytes,55,opt,name=build_finished,json=buildFinished,proto3,oneof"`
}

type BuildEvent_ComponentStreamFinished

type BuildEvent_ComponentStreamFinished struct {
	// Indicates the end of a build event stream (with the same StreamId) from
	// a build component executing the requested build task.
	// *** This field does not indicate the WatchBuild RPC is finished. ***
	ComponentStreamFinished *BuildEvent_BuildComponentStreamFinished `protobuf:"bytes,59,opt,name=component_stream_finished,json=componentStreamFinished,proto3,oneof"`
}

type BuildEvent_ConsoleOutput

type BuildEvent_ConsoleOutput struct {

	// The output stream type.
	Type ConsoleOutputStream `protobuf:"varint,1,opt,name=type,proto3,enum=google.devtools.build.v1.ConsoleOutputStream" json:"type,omitempty"`
	// The output stream content.
	//
	// Types that are assignable to Output:
	//
	//	*BuildEvent_ConsoleOutput_TextOutput
	//	*BuildEvent_ConsoleOutput_BinaryOutput
	Output isBuildEvent_ConsoleOutput_Output `protobuf_oneof:"output"`
	// contains filtered or unexported fields
}

Textual output written to standard output or standard error.

func (*BuildEvent_ConsoleOutput) Descriptor deprecated

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

Deprecated: Use BuildEvent_ConsoleOutput.ProtoReflect.Descriptor instead.

func (*BuildEvent_ConsoleOutput) GetBinaryOutput

func (x *BuildEvent_ConsoleOutput) GetBinaryOutput() []byte

func (*BuildEvent_ConsoleOutput) GetOutput

func (m *BuildEvent_ConsoleOutput) GetOutput() isBuildEvent_ConsoleOutput_Output

func (*BuildEvent_ConsoleOutput) GetTextOutput

func (x *BuildEvent_ConsoleOutput) GetTextOutput() string

func (*BuildEvent_ConsoleOutput) GetType

func (*BuildEvent_ConsoleOutput) ProtoMessage

func (*BuildEvent_ConsoleOutput) ProtoMessage()

func (*BuildEvent_ConsoleOutput) ProtoReflect

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

func (*BuildEvent_ConsoleOutput) Reset

func (x *BuildEvent_ConsoleOutput) Reset()

func (*BuildEvent_ConsoleOutput) String

func (x *BuildEvent_ConsoleOutput) String() string

type BuildEvent_ConsoleOutput_

type BuildEvent_ConsoleOutput_ struct {
	// An event containing printed text.
	ConsoleOutput *BuildEvent_ConsoleOutput `protobuf:"bytes,56,opt,name=console_output,json=consoleOutput,proto3,oneof"`
}

type BuildEvent_ConsoleOutput_BinaryOutput

type BuildEvent_ConsoleOutput_BinaryOutput struct {
	// Used if the output is not UTF-8 text (for example, a binary proto).
	BinaryOutput []byte `protobuf:"bytes,3,opt,name=binary_output,json=binaryOutput,proto3,oneof"`
}

type BuildEvent_ConsoleOutput_TextOutput

type BuildEvent_ConsoleOutput_TextOutput struct {
	// Regular UTF-8 output; normal text.
	TextOutput string `protobuf:"bytes,2,opt,name=text_output,json=textOutput,proto3,oneof"`
}

type BuildEvent_InvocationAttemptFinished

type BuildEvent_InvocationAttemptFinished struct {

	// Final status of the invocation.
	InvocationStatus *BuildStatus `protobuf:"bytes,3,opt,name=invocation_status,json=invocationStatus,proto3" json:"invocation_status,omitempty"`
	// Arbitrary details about the invocation attempt.
	Details *anypb.Any `protobuf:"bytes,4,opt,name=details,proto3" json:"details,omitempty"`
	// contains filtered or unexported fields
}

Notification that an invocation attempt has finished.

func (*BuildEvent_InvocationAttemptFinished) Descriptor deprecated

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

Deprecated: Use BuildEvent_InvocationAttemptFinished.ProtoReflect.Descriptor instead.

func (*BuildEvent_InvocationAttemptFinished) GetDetails

func (*BuildEvent_InvocationAttemptFinished) GetInvocationStatus

func (x *BuildEvent_InvocationAttemptFinished) GetInvocationStatus() *BuildStatus

func (*BuildEvent_InvocationAttemptFinished) ProtoMessage

func (*BuildEvent_InvocationAttemptFinished) ProtoMessage()

func (*BuildEvent_InvocationAttemptFinished) ProtoReflect

func (*BuildEvent_InvocationAttemptFinished) Reset

func (*BuildEvent_InvocationAttemptFinished) String

type BuildEvent_InvocationAttemptFinished_

type BuildEvent_InvocationAttemptFinished_ struct {
	// An invocation attempt has finished.
	InvocationAttemptFinished *BuildEvent_InvocationAttemptFinished `protobuf:"bytes,52,opt,name=invocation_attempt_finished,json=invocationAttemptFinished,proto3,oneof"`
}

type BuildEvent_InvocationAttemptStarted

type BuildEvent_InvocationAttemptStarted struct {

	// The number of the invocation attempt, starting at 1 and increasing by 1
	// for each new attempt. Can be used to determine if there is a later
	// invocation attempt replacing the current one a client is processing.
	AttemptNumber int64 `protobuf:"varint,1,opt,name=attempt_number,json=attemptNumber,proto3" json:"attempt_number,omitempty"`
	// Arbitrary details about the invocation attempt.
	Details *anypb.Any `protobuf:"bytes,2,opt,name=details,proto3" json:"details,omitempty"`
	// contains filtered or unexported fields
}

Notification that the build system has attempted to run the build tool.

func (*BuildEvent_InvocationAttemptStarted) Descriptor deprecated

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

Deprecated: Use BuildEvent_InvocationAttemptStarted.ProtoReflect.Descriptor instead.

func (*BuildEvent_InvocationAttemptStarted) GetAttemptNumber

func (x *BuildEvent_InvocationAttemptStarted) GetAttemptNumber() int64

func (*BuildEvent_InvocationAttemptStarted) GetDetails

func (*BuildEvent_InvocationAttemptStarted) ProtoMessage

func (*BuildEvent_InvocationAttemptStarted) ProtoMessage()

func (*BuildEvent_InvocationAttemptStarted) ProtoReflect

func (*BuildEvent_InvocationAttemptStarted) Reset

func (*BuildEvent_InvocationAttemptStarted) String

type BuildEvent_InvocationAttemptStarted_

type BuildEvent_InvocationAttemptStarted_ struct {
	// An invocation attempt has started.
	InvocationAttemptStarted *BuildEvent_InvocationAttemptStarted `protobuf:"bytes,51,opt,name=invocation_attempt_started,json=invocationAttemptStarted,proto3,oneof"`
}

type BuildEvent_SourceFetchEvent

type BuildEvent_SourceFetchEvent struct {
	// An event that contains supplemental tool-specific information about
	// source fetching.
	SourceFetchEvent *anypb.Any `protobuf:"bytes,62,opt,name=source_fetch_event,json=sourceFetchEvent,proto3,oneof"`
}

type BuildStatus

type BuildStatus struct {

	// The end result.
	Result BuildStatus_Result `protobuf:"varint,1,opt,name=result,proto3,enum=google.devtools.build.v1.BuildStatus_Result" json:"result,omitempty"`
	// Final invocation ID of the build, if there was one.
	// This field is only set on a status in BuildFinished event.
	FinalInvocationId string `protobuf:"bytes,3,opt,name=final_invocation_id,json=finalInvocationId,proto3" json:"final_invocation_id,omitempty"`
	// Build tool exit code. Integer value returned by the executed build tool.
	// Might not be available in some cases, e.g., a build timeout.
	BuildToolExitCode *wrapperspb.Int32Value `protobuf:"bytes,4,opt,name=build_tool_exit_code,json=buildToolExitCode,proto3" json:"build_tool_exit_code,omitempty"`
	// Human-readable error message. Do not use for programmatic purposes.
	ErrorMessage string `protobuf:"bytes,5,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
	// Fine-grained diagnostic information to complement the status.
	Details *anypb.Any `protobuf:"bytes,2,opt,name=details,proto3" json:"details,omitempty"`
	// contains filtered or unexported fields
}

Status used for both invocation attempt and overall build completion.

func (*BuildStatus) Descriptor deprecated

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

Deprecated: Use BuildStatus.ProtoReflect.Descriptor instead.

func (*BuildStatus) GetBuildToolExitCode

func (x *BuildStatus) GetBuildToolExitCode() *wrapperspb.Int32Value

func (*BuildStatus) GetDetails

func (x *BuildStatus) GetDetails() *anypb.Any

func (*BuildStatus) GetErrorMessage

func (x *BuildStatus) GetErrorMessage() string

func (*BuildStatus) GetFinalInvocationId

func (x *BuildStatus) GetFinalInvocationId() string

func (*BuildStatus) GetResult

func (x *BuildStatus) GetResult() BuildStatus_Result

func (*BuildStatus) ProtoMessage

func (*BuildStatus) ProtoMessage()

func (*BuildStatus) ProtoReflect

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

func (*BuildStatus) Reset

func (x *BuildStatus) Reset()

func (*BuildStatus) String

func (x *BuildStatus) String() string

type BuildStatus_Result

type BuildStatus_Result int32

The end result of the Build.

const (
	// Unspecified or unknown.
	BuildStatus_UNKNOWN_STATUS BuildStatus_Result = 0
	// Build was successful and tests (if requested) all pass.
	BuildStatus_COMMAND_SUCCEEDED BuildStatus_Result = 1
	// Build error and/or test failure.
	BuildStatus_COMMAND_FAILED BuildStatus_Result = 2
	// Unable to obtain a result due to input provided by the user.
	BuildStatus_USER_ERROR BuildStatus_Result = 3
	// Unable to obtain a result due to a failure within the build system.
	BuildStatus_SYSTEM_ERROR BuildStatus_Result = 4
	// Build required too many resources, such as build tool RAM.
	BuildStatus_RESOURCE_EXHAUSTED BuildStatus_Result = 5
	// An invocation attempt time exceeded its deadline.
	BuildStatus_INVOCATION_DEADLINE_EXCEEDED BuildStatus_Result = 6
	// Build request time exceeded the request_deadline
	BuildStatus_REQUEST_DEADLINE_EXCEEDED BuildStatus_Result = 8
	// The build was cancelled by a call to CancelBuild.
	BuildStatus_CANCELLED BuildStatus_Result = 7
)

func (BuildStatus_Result) Descriptor

func (BuildStatus_Result) Enum

func (BuildStatus_Result) EnumDescriptor deprecated

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

Deprecated: Use BuildStatus_Result.Descriptor instead.

func (BuildStatus_Result) Number

func (BuildStatus_Result) String

func (x BuildStatus_Result) String() string

func (BuildStatus_Result) Type

type ConsoleOutputStream

type ConsoleOutputStream int32

The type of console output stream.

const (
	// Unspecified or unknown.
	ConsoleOutputStream_UNKNOWN ConsoleOutputStream = 0
	// Normal output stream.
	ConsoleOutputStream_STDOUT ConsoleOutputStream = 1
	// Error output stream.
	ConsoleOutputStream_STDERR ConsoleOutputStream = 2
)

func (ConsoleOutputStream) Descriptor

func (ConsoleOutputStream) Enum

func (ConsoleOutputStream) EnumDescriptor deprecated

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

Deprecated: Use ConsoleOutputStream.Descriptor instead.

func (ConsoleOutputStream) Number

func (ConsoleOutputStream) String

func (x ConsoleOutputStream) String() string

func (ConsoleOutputStream) Type

type OrderedBuildEvent

type OrderedBuildEvent struct {

	// Which build event stream this event belongs to.
	StreamId *StreamId `protobuf:"bytes,1,opt,name=stream_id,json=streamId,proto3" json:"stream_id,omitempty"`
	// The position of this event in the stream. The sequence numbers for a build
	// event stream should be a sequence of consecutive natural numbers starting
	// from one. (1, 2, 3, ...)
	SequenceNumber int64 `protobuf:"varint,2,opt,name=sequence_number,json=sequenceNumber,proto3" json:"sequence_number,omitempty"`
	// The actual event.
	Event *BuildEvent `protobuf:"bytes,3,opt,name=event,proto3" json:"event,omitempty"`
	// contains filtered or unexported fields
}

Build event with contextual information about the stream it belongs to and its position in that stream.

func (*OrderedBuildEvent) Descriptor deprecated

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

Deprecated: Use OrderedBuildEvent.ProtoReflect.Descriptor instead.

func (*OrderedBuildEvent) GetEvent

func (x *OrderedBuildEvent) GetEvent() *BuildEvent

func (*OrderedBuildEvent) GetSequenceNumber

func (x *OrderedBuildEvent) GetSequenceNumber() int64

func (*OrderedBuildEvent) GetStreamId

func (x *OrderedBuildEvent) GetStreamId() *StreamId

func (*OrderedBuildEvent) ProtoMessage

func (*OrderedBuildEvent) ProtoMessage()

func (*OrderedBuildEvent) ProtoReflect

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

func (*OrderedBuildEvent) Reset

func (x *OrderedBuildEvent) Reset()

func (*OrderedBuildEvent) String

func (x *OrderedBuildEvent) String() string

type PublishBuildEventClient

type PublishBuildEventClient interface {
	// Publish a build event stating the new state of a build (typically from the
	// build queue). The BuildEnqueued event must be published before all other
	// events for the same build ID.
	//
	// The backend will persist the event and deliver it to registered frontend
	// jobs immediately without batching.
	//
	// The commit status of the request is reported by the RPC's util_status()
	// function. The error code is the canonical error code defined in
	// //util/task/codes.proto.
	PublishLifecycleEvent(ctx context.Context, in *PublishLifecycleEventRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Publish build tool events belonging to the same stream to a backend job
	// using bidirectional streaming.
	PublishBuildToolEventStream(ctx context.Context, opts ...grpc.CallOption) (PublishBuildEvent_PublishBuildToolEventStreamClient, error)
}

PublishBuildEventClient is the client API for PublishBuildEvent service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type PublishBuildEventServer

type PublishBuildEventServer interface {
	// Publish a build event stating the new state of a build (typically from the
	// build queue). The BuildEnqueued event must be published before all other
	// events for the same build ID.
	//
	// The backend will persist the event and deliver it to registered frontend
	// jobs immediately without batching.
	//
	// The commit status of the request is reported by the RPC's util_status()
	// function. The error code is the canonical error code defined in
	// //util/task/codes.proto.
	PublishLifecycleEvent(context.Context, *PublishLifecycleEventRequest) (*emptypb.Empty, error)
	// Publish build tool events belonging to the same stream to a backend job
	// using bidirectional streaming.
	PublishBuildToolEventStream(PublishBuildEvent_PublishBuildToolEventStreamServer) error
}

PublishBuildEventServer is the server API for PublishBuildEvent service.

type PublishBuildEvent_PublishBuildToolEventStreamClient

type PublishBuildEvent_PublishBuildToolEventStreamClient interface {
	Send(*PublishBuildToolEventStreamRequest) error
	Recv() (*PublishBuildToolEventStreamResponse, error)
	grpc.ClientStream
}

type PublishBuildEvent_PublishBuildToolEventStreamServer

type PublishBuildEvent_PublishBuildToolEventStreamServer interface {
	Send(*PublishBuildToolEventStreamResponse) error
	Recv() (*PublishBuildToolEventStreamRequest, error)
	grpc.ServerStream
}

type PublishBuildToolEventStreamRequest

type PublishBuildToolEventStreamRequest struct {

	// Required. The build event with position info.
	// New publishing clients should use this field rather than the 3 above.
	OrderedBuildEvent *OrderedBuildEvent `protobuf:"bytes,4,opt,name=ordered_build_event,json=orderedBuildEvent,proto3" json:"ordered_build_event,omitempty"`
	// The keywords to be attached to the notification which notifies the start
	// of a new build event stream. BES only reads this field when sequence_number
	// or ordered_build_event.sequence_number is 1 in this message. If this field
	// is empty, BES will not publish notification messages for this stream.
	NotificationKeywords []string `protobuf:"bytes,5,rep,name=notification_keywords,json=notificationKeywords,proto3" json:"notification_keywords,omitempty"`
	// Required. The project this build is associated with.
	// This should match the project used for the initial call to
	// PublishLifecycleEvent (containing a BuildEnqueued message).
	ProjectId string `protobuf:"bytes,6,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Whether to require a previously received matching InvocationAttemptStarted
	// event before continuing event processing for the event in the current
	// request. BES only performs this check for events with sequence_number 1
	// i.e. the first event in the stream.
	CheckPrecedingLifecycleEventsPresent bool `` /* 176-byte string literal not displayed */
	// contains filtered or unexported fields
}

Streaming request message for PublishBuildToolEventStream.

func (*PublishBuildToolEventStreamRequest) Descriptor deprecated

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

Deprecated: Use PublishBuildToolEventStreamRequest.ProtoReflect.Descriptor instead.

func (*PublishBuildToolEventStreamRequest) GetCheckPrecedingLifecycleEventsPresent

func (x *PublishBuildToolEventStreamRequest) GetCheckPrecedingLifecycleEventsPresent() bool

func (*PublishBuildToolEventStreamRequest) GetNotificationKeywords

func (x *PublishBuildToolEventStreamRequest) GetNotificationKeywords() []string

func (*PublishBuildToolEventStreamRequest) GetOrderedBuildEvent

func (x *PublishBuildToolEventStreamRequest) GetOrderedBuildEvent() *OrderedBuildEvent

func (*PublishBuildToolEventStreamRequest) GetProjectId

func (x *PublishBuildToolEventStreamRequest) GetProjectId() string

func (*PublishBuildToolEventStreamRequest) ProtoMessage

func (*PublishBuildToolEventStreamRequest) ProtoMessage()

func (*PublishBuildToolEventStreamRequest) ProtoReflect

func (*PublishBuildToolEventStreamRequest) Reset

func (*PublishBuildToolEventStreamRequest) String

type PublishBuildToolEventStreamResponse

type PublishBuildToolEventStreamResponse struct {

	// The stream that contains this event.
	StreamId *StreamId `protobuf:"bytes,1,opt,name=stream_id,json=streamId,proto3" json:"stream_id,omitempty"`
	// The sequence number of this event that has been committed.
	SequenceNumber int64 `protobuf:"varint,2,opt,name=sequence_number,json=sequenceNumber,proto3" json:"sequence_number,omitempty"`
	// contains filtered or unexported fields
}

States which event has been committed. Any failure to commit will cause RPC errors, hence not recorded by this proto.

func (*PublishBuildToolEventStreamResponse) Descriptor deprecated

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

Deprecated: Use PublishBuildToolEventStreamResponse.ProtoReflect.Descriptor instead.

func (*PublishBuildToolEventStreamResponse) GetSequenceNumber

func (x *PublishBuildToolEventStreamResponse) GetSequenceNumber() int64

func (*PublishBuildToolEventStreamResponse) GetStreamId

func (*PublishBuildToolEventStreamResponse) ProtoMessage

func (*PublishBuildToolEventStreamResponse) ProtoMessage()

func (*PublishBuildToolEventStreamResponse) ProtoReflect

func (*PublishBuildToolEventStreamResponse) Reset

func (*PublishBuildToolEventStreamResponse) String

type PublishLifecycleEventRequest

type PublishLifecycleEventRequest struct {

	// The interactivity of this build.
	ServiceLevel PublishLifecycleEventRequest_ServiceLevel `` /* 170-byte string literal not displayed */
	// Required. The lifecycle build event. If this is a build tool event, the RPC
	// will fail with INVALID_REQUEST.
	BuildEvent *OrderedBuildEvent `protobuf:"bytes,2,opt,name=build_event,json=buildEvent,proto3" json:"build_event,omitempty"`
	// If the next event for this build or invocation (depending on the event
	// type) hasn't been published after this duration from when {build_event}
	// is written to BES, consider this stream expired. If this field is not set,
	// BES backend will use its own default value.
	StreamTimeout *durationpb.Duration `protobuf:"bytes,3,opt,name=stream_timeout,json=streamTimeout,proto3" json:"stream_timeout,omitempty"`
	// Additional information about a build request. These are define by the event
	// publishers, and the Build Event Service does not validate or interpret
	// them. They are used while notifying internal systems of new builds and
	// invocations if the OrderedBuildEvent.event type is
	// BuildEnqueued/InvocationAttemptStarted.
	NotificationKeywords []string `protobuf:"bytes,4,rep,name=notification_keywords,json=notificationKeywords,proto3" json:"notification_keywords,omitempty"`
	// Required. The project this build is associated with.
	// This should match the project used for the initial call to
	// PublishLifecycleEvent (containing a BuildEnqueued message).
	ProjectId string `protobuf:"bytes,6,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Whether to require a previously received matching parent lifecycle event
	// for the current request's event before continuing processing.
	//   - InvocationAttemptStarted and BuildFinished events require a BuildEnqueued
	//     parent event.
	//   - InvocationAttemptFinished events require an InvocationAttemptStarted
	//     parent event.
	CheckPrecedingLifecycleEventsPresent bool `` /* 176-byte string literal not displayed */
	// contains filtered or unexported fields
}

Publishes 'lifecycle events' that update the high-level state of a build:

  • BuildEnqueued: When a build is scheduled.
  • InvocationAttemptStarted: When work for a build starts; there can be multiple invocations for a build (e.g. retries).
  • InvocationAttemptCompleted: When work for a build finishes.
  • BuildFinished: When a build is finished.

func (*PublishLifecycleEventRequest) Descriptor deprecated

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

Deprecated: Use PublishLifecycleEventRequest.ProtoReflect.Descriptor instead.

func (*PublishLifecycleEventRequest) GetBuildEvent

func (x *PublishLifecycleEventRequest) GetBuildEvent() *OrderedBuildEvent

func (*PublishLifecycleEventRequest) GetCheckPrecedingLifecycleEventsPresent

func (x *PublishLifecycleEventRequest) GetCheckPrecedingLifecycleEventsPresent() bool

func (*PublishLifecycleEventRequest) GetNotificationKeywords

func (x *PublishLifecycleEventRequest) GetNotificationKeywords() []string

func (*PublishLifecycleEventRequest) GetProjectId

func (x *PublishLifecycleEventRequest) GetProjectId() string

func (*PublishLifecycleEventRequest) GetServiceLevel

func (*PublishLifecycleEventRequest) GetStreamTimeout

func (x *PublishLifecycleEventRequest) GetStreamTimeout() *durationpb.Duration

func (*PublishLifecycleEventRequest) ProtoMessage

func (*PublishLifecycleEventRequest) ProtoMessage()

func (*PublishLifecycleEventRequest) ProtoReflect

func (*PublishLifecycleEventRequest) Reset

func (x *PublishLifecycleEventRequest) Reset()

func (*PublishLifecycleEventRequest) String

type PublishLifecycleEventRequest_ServiceLevel

type PublishLifecycleEventRequest_ServiceLevel int32

The service level of the build request. Backends only uses this value when the BuildEnqueued event is published to determine what level of service this build should receive.

const (
	// Non-interactive builds can tolerate longer event latencies. This is the
	// default ServiceLevel if callers do not specify one.
	PublishLifecycleEventRequest_NONINTERACTIVE PublishLifecycleEventRequest_ServiceLevel = 0
	// The events of an interactive build should be delivered with low latency.
	PublishLifecycleEventRequest_INTERACTIVE PublishLifecycleEventRequest_ServiceLevel = 1
)

func (PublishLifecycleEventRequest_ServiceLevel) Descriptor

func (PublishLifecycleEventRequest_ServiceLevel) Enum

func (PublishLifecycleEventRequest_ServiceLevel) EnumDescriptor deprecated

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

Deprecated: Use PublishLifecycleEventRequest_ServiceLevel.Descriptor instead.

func (PublishLifecycleEventRequest_ServiceLevel) Number

func (PublishLifecycleEventRequest_ServiceLevel) String

func (PublishLifecycleEventRequest_ServiceLevel) Type

type StreamId

type StreamId struct {

	// The id of a Build message.
	BuildId string `protobuf:"bytes,1,opt,name=build_id,json=buildId,proto3" json:"build_id,omitempty"`
	// The unique invocation ID within this build.
	// It should be the same as {invocation} (below) during the migration.
	InvocationId string `protobuf:"bytes,6,opt,name=invocation_id,json=invocationId,proto3" json:"invocation_id,omitempty"`
	// The component that emitted this event.
	Component StreamId_BuildComponent `` /* 126-byte string literal not displayed */
	// contains filtered or unexported fields
}

Unique identifier for a build event stream.

func (*StreamId) Descriptor deprecated

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

Deprecated: Use StreamId.ProtoReflect.Descriptor instead.

func (*StreamId) GetBuildId

func (x *StreamId) GetBuildId() string

func (*StreamId) GetComponent

func (x *StreamId) GetComponent() StreamId_BuildComponent

func (*StreamId) GetInvocationId

func (x *StreamId) GetInvocationId() string

func (*StreamId) ProtoMessage

func (*StreamId) ProtoMessage()

func (*StreamId) ProtoReflect

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

func (*StreamId) Reset

func (x *StreamId) Reset()

func (*StreamId) String

func (x *StreamId) String() string

type StreamId_BuildComponent

type StreamId_BuildComponent int32

Which build component generates this event stream. Each build component may generate one event stream.

const (
	// Unknown or unspecified; callers should never set this value.
	StreamId_UNKNOWN_COMPONENT StreamId_BuildComponent = 0
	// A component that coordinates builds.
	StreamId_CONTROLLER StreamId_BuildComponent = 1
	// A component that runs executables needed to complete a build.
	StreamId_WORKER StreamId_BuildComponent = 2
	// A component that builds something.
	StreamId_TOOL StreamId_BuildComponent = 3
)

func (StreamId_BuildComponent) Descriptor

func (StreamId_BuildComponent) Enum

func (StreamId_BuildComponent) EnumDescriptor deprecated

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

Deprecated: Use StreamId_BuildComponent.Descriptor instead.

func (StreamId_BuildComponent) Number

func (StreamId_BuildComponent) String

func (x StreamId_BuildComponent) String() string

func (StreamId_BuildComponent) Type

type UnimplementedPublishBuildEventServer

type UnimplementedPublishBuildEventServer struct {
}

UnimplementedPublishBuildEventServer can be embedded to have forward compatible implementations.

func (*UnimplementedPublishBuildEventServer) PublishBuildToolEventStream

func (*UnimplementedPublishBuildEventServer) PublishLifecycleEvent

Jump to

Keyboard shortcuts

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