package google.devtools.build.v1

Get desktop application:
View/edit binary Protocol Buffers messages

A service for publishing BuildEvents. BuildEvents are generated by Build Systems to record actions taken during a Build. Events occur in streams, are identified by a StreamId, and ordered by sequence number in a stream. A Build may contain several streams of BuildEvents, depending on the systems that are involved in the Build. Some BuildEvents are used to declare the beginning and end of major portions of a Build; these are called LifecycleEvents, and are used (for example) to indicate the beginning or end of a Build, and the beginning or end of an Invocation attempt (there can be more than 1 Invocation in a Build if, for example, a failure occurs somewhere and it needs to be retried). Other, build-tool events represent actions taken by the Build tool, such as target objects produced via compilation, tests run, et cetera. There could be more than one build tool stream for an invocation attempt of a build.

• rpc PublishLifecycleEvent (PublishLifecycleEventRequest, protobuf.Empty)

  publish_build_event.proto:63

  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.

• rpc PublishBuildToolEventStream (stream PublishBuildToolEventStreamRequest, stream PublishBuildToolEventStreamResponse)

  publish_build_event.proto:74

  Publish build tool events belonging to the same stream to a backend job using bidirectional streaming.

  message PublishBuildToolEventStreamResponse

  publish_build_event.proto:141

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

  • optional StreamId stream_id = 1

    The stream that contains this event.

  • int64 sequence_number = 2

    The sequence number of this event that has been committed.

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

Used in: OrderedBuildEvent

• optional protobuf.Timestamp event_time = 1

  This should be precisely the time when this event happened, and not when the event proto was created or sent.

• oneof event

  ////////////////////////////////////////////////////////////////////////// Events that indicate a state change of a build request in the build queue.

  • BuildEvent.InvocationAttemptStarted invocation_attempt_started = 51

    An invocation attempt has started.

  • BuildEvent.InvocationAttemptFinished invocation_attempt_finished = 52

    An invocation attempt has finished.

  • BuildEvent.BuildEnqueued build_enqueued = 53

    The build is enqueued.

  • BuildEvent.BuildFinished build_finished = 55

    The build has finished. Set when the build is terminated.

  • BuildEvent.ConsoleOutput console_output = 56

    An event containing printed text.

  • BuildEvent.BuildComponentStreamFinished component_stream_finished = 59

    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. ***

  • protobuf.Any bazel_event = 60

    Structured build event generated by Bazel about its execution progress.

  • protobuf.Any build_execution_event = 61

    An event that contains supplemental tool-specific information about build execution.

  • protobuf.Any source_fetch_event = 62

    An event that contains supplemental tool-specific information about source fetching.

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

Used in: BuildEvent

• BuildComponentStreamFinished.FinishType type = 1

  How the event stream finished.

How did the event stream finish.

Used in: BuildComponentStreamFinished

• FINISH_TYPE_UNSPECIFIED = 0

  Unknown or unspecified; callers should never set this value.

• FINISHED = 1

  Set by the event publisher to indicate a build event stream is finished.

• EXPIRED = 2

  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.

Notification that the build request is enqueued.

Used in: BuildEvent

• optional protobuf.Any details = 1

  Additional details about the Build.

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.

Used in: BuildEvent

• optional BuildStatus status = 1

  Final status of the build.

• optional protobuf.Any details = 2

  Additional details about the Build.

Textual output written to standard output or standard error.

Used in: BuildEvent

• ConsoleOutputStream type = 1

  The output stream type.

• oneof output

  The output stream content.

  • string text_output = 2

    Regular UTF-8 output; normal text.

  • bytes binary_output = 3

    Used if the output is not UTF-8 text (for example, a binary proto).

Notification that an invocation attempt has finished.

Used in: BuildEvent

• optional BuildStatus invocation_status = 3

  Final status of the invocation.

• optional protobuf.Any details = 4

  Arbitrary details about the invocation attempt.

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

Used in: BuildEvent

• int64 attempt_number = 1

  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.

• optional protobuf.Any details = 2

  Arbitrary details about the invocation attempt.

Status used for both invocation attempt and overall build completion.

Used in: BuildEvent.BuildFinished, BuildEvent.InvocationAttemptFinished

• BuildStatus.Result result = 1

  The end result.

• string final_invocation_id = 3

  Final invocation ID of the build, if there was one. This field is only set on a status in BuildFinished event.

• optional protobuf.Int32Value build_tool_exit_code = 4

  Build tool exit code. Integer value returned by the executed build tool. Might not be available in some cases, e.g., a build timeout.

• string error_message = 5

  Human-readable error message. Do not use for programmatic purposes.

• optional protobuf.Any details = 2

  Fine-grained diagnostic information to complement the status.

The end result of the Build.

Used in: BuildStatus

• UNKNOWN_STATUS = 0

  Unspecified or unknown.

• COMMAND_SUCCEEDED = 1

  Build was successful and tests (if requested) all pass.

• COMMAND_FAILED = 2

  Build error and/or test failure.

• USER_ERROR = 3

  Unable to obtain a result due to input provided by the user.

• SYSTEM_ERROR = 4

  Unable to obtain a result due to a failure within the build system.

• RESOURCE_EXHAUSTED = 5

  Build required too many resources, such as build tool RAM.

• INVOCATION_DEADLINE_EXCEEDED = 6

  An invocation attempt time exceeded its deadline.

• REQUEST_DEADLINE_EXCEEDED = 8

  Build request time exceeded the request_deadline

• CANCELLED = 7

  The build was cancelled by a call to CancelBuild.

The type of console output stream.

Used in: BuildEvent.ConsoleOutput

• UNKNOWN = 0

  Unspecified or unknown.

• STDOUT = 1

  Normal output stream.

• STDERR = 2

  Error output stream.

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

Used in: PublishBuildToolEventStreamRequest, PublishLifecycleEventRequest

• optional StreamId stream_id = 1

  Which build event stream this event belongs to.

• int64 sequence_number = 2

  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, ...)

• optional BuildEvent event = 3

  The actual event.

Streaming request message for PublishBuildToolEventStream.

Used as request type in: PublishBuildEvent.PublishBuildToolEventStream

Used as field type in: com.github.trace_machina.nativelink.events.BepEvent

• optional OrderedBuildEvent ordered_build_event = 4

  Required. The build event with position info. New publishing clients should use this field rather than the 3 above.

• repeated string notification_keywords = 5

  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.

• string project_id = 6

  Required. The project this build is associated with. This should match the project used for the initial call to PublishLifecycleEvent (containing a BuildEnqueued message).

• bool check_preceding_lifecycle_events_present = 7

  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.

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.

Used as request type in: PublishBuildEvent.PublishLifecycleEvent

Used as field type in: com.github.trace_machina.nativelink.events.BepEvent

• PublishLifecycleEventRequest.ServiceLevel service_level = 1

  The interactivity of this build.

• optional OrderedBuildEvent build_event = 2

  Required. The lifecycle build event. If this is a build tool event, the RPC will fail with INVALID_REQUEST.

• optional protobuf.Duration stream_timeout = 3

  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.

• repeated string notification_keywords = 4

  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.

• string project_id = 6

  Required. The project this build is associated with. This should match the project used for the initial call to PublishLifecycleEvent (containing a BuildEnqueued message).

• bool check_preceding_lifecycle_events_present = 7

  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.

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.

Used in: PublishLifecycleEventRequest

• NONINTERACTIVE = 0

  Non-interactive builds can tolerate longer event latencies. This is the default ServiceLevel if callers do not specify one.

• INTERACTIVE = 1

  The events of an interactive build should be delivered with low latency.

Unique identifier for a build event stream.

Used in: OrderedBuildEvent, PublishBuildToolEventStreamResponse

• string build_id = 1

  The id of a Build message.

• string invocation_id = 6

  The unique invocation ID within this build. It should be the same as {invocation} (below) during the migration.

• StreamId.BuildComponent component = 3

  The component that emitted this event.

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

Used in: StreamId

• UNKNOWN_COMPONENT = 0

  Unknown or unspecified; callers should never set this value.

• CONTROLLER = 1

  A component that coordinates builds.

• WORKER = 2

  A component that runs executables needed to complete a build.

• TOOL = 3

  A component that builds something.