Struct google_api_proto::google::devtools::build::v1::publish_build_event_client::PublishBuildEventClient

pub struct PublishBuildEventClient<T> { /* private fields */ }

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.

Implementations

impl<T> PublishBuildEventClient<T>

where T: GrpcService<BoxBody>, T::Error: Into<StdError>, T::ResponseBody: Body<Data = Bytes> + Send + 'static, <T::ResponseBody as Body>::Error: Into<StdError> + Send,

pub fn new(inner: T) -> Self

pub fn with_origin(inner: T, origin: Uri) -> Self

pub fn with_interceptor<F>( inner: T, interceptor: F, ) -> PublishBuildEventClient<InterceptedService<T, F>>

where F: Interceptor, T::ResponseBody: Default, T: Service<Request<BoxBody>, Response = Response<<T as GrpcService<BoxBody>>::ResponseBody>>, <T as Service<Request<BoxBody>>>::Error: Into<StdError> + Send + Sync,

pub fn send_compressed(self, encoding: CompressionEncoding) -> Self

Compress requests with the given encoding.

This requires the server to support it otherwise it might respond with an error.

pub fn accept_compressed(self, encoding: CompressionEncoding) -> Self

Enable decompressing responses.

pub fn max_decoding_message_size(self, limit: usize) -> Self

Limits the maximum size of a decoded message.

Default: 4MB

pub fn max_encoding_message_size(self, limit: usize) -> Self

Limits the maximum size of an encoded message.

Default: usize::MAX

pub async fn publish_lifecycle_event( &mut self, request: impl IntoRequest<PublishLifecycleEventRequest>, ) -> Result<Response<()>, Status>

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.

pub async fn publish_build_tool_event_stream( &mut self, request: impl IntoStreamingRequest<Message = PublishBuildToolEventStreamRequest>, ) -> Result<Response<Streaming<PublishBuildToolEventStreamResponse>>, Status>

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

Trait Implementations

impl<T: Clone> Clone for PublishBuildEventClient<T>

fn clone(&self) -> PublishBuildEventClient<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for PublishBuildEventClient<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.