Class PublishLifecycleEventRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.devtools.build.v1.PublishLifecycleEventRequest
All Implemented Interfaces:
PublishLifecycleEventRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class PublishLifecycleEventRequest extends com.google.protobuf.GeneratedMessage implements PublishLifecycleEventRequestOrBuilder
 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.
 
Protobuf type google.devtools.build.v1.PublishLifecycleEventRequest
See Also:
  • Field Details

    • SERVICE_LEVEL_FIELD_NUMBER

      public static final int SERVICE_LEVEL_FIELD_NUMBER
      See Also:
    • BUILD_EVENT_FIELD_NUMBER

      public static final int BUILD_EVENT_FIELD_NUMBER
      See Also:
    • STREAM_TIMEOUT_FIELD_NUMBER

      public static final int STREAM_TIMEOUT_FIELD_NUMBER
      See Also:
    • NOTIFICATION_KEYWORDS_FIELD_NUMBER

      public static final int NOTIFICATION_KEYWORDS_FIELD_NUMBER
      See Also:
    • PROJECT_ID_FIELD_NUMBER

      public static final int PROJECT_ID_FIELD_NUMBER
      See Also:
    • CHECK_PRECEDING_LIFECYCLE_EVENTS_PRESENT_FIELD_NUMBER

      public static final int CHECK_PRECEDING_LIFECYCLE_EVENTS_PRESENT_FIELD_NUMBER
      See Also:
  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • getServiceLevelValue

      public int getServiceLevelValue()
       The interactivity of this build.
       
      .google.devtools.build.v1.PublishLifecycleEventRequest.ServiceLevel service_level = 1;
      Specified by:
      getServiceLevelValue in interface PublishLifecycleEventRequestOrBuilder
      Returns:
      The enum numeric value on the wire for serviceLevel.
    • getServiceLevel

       The interactivity of this build.
       
      .google.devtools.build.v1.PublishLifecycleEventRequest.ServiceLevel service_level = 1;
      Specified by:
      getServiceLevel in interface PublishLifecycleEventRequestOrBuilder
      Returns:
      The serviceLevel.
    • hasBuildEvent

      public boolean hasBuildEvent()
       Required. The lifecycle build event. If this is a build tool event, the RPC
       will fail with INVALID_REQUEST.
       
      .google.devtools.build.v1.OrderedBuildEvent build_event = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasBuildEvent in interface PublishLifecycleEventRequestOrBuilder
      Returns:
      Whether the buildEvent field is set.
    • getBuildEvent

      public OrderedBuildEvent getBuildEvent()
       Required. The lifecycle build event. If this is a build tool event, the RPC
       will fail with INVALID_REQUEST.
       
      .google.devtools.build.v1.OrderedBuildEvent build_event = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getBuildEvent in interface PublishLifecycleEventRequestOrBuilder
      Returns:
      The buildEvent.
    • getBuildEventOrBuilder

      public OrderedBuildEventOrBuilder getBuildEventOrBuilder()
       Required. The lifecycle build event. If this is a build tool event, the RPC
       will fail with INVALID_REQUEST.
       
      .google.devtools.build.v1.OrderedBuildEvent build_event = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getBuildEventOrBuilder in interface PublishLifecycleEventRequestOrBuilder
    • hasStreamTimeout

      public boolean hasStreamTimeout()
       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.
       
      .google.protobuf.Duration stream_timeout = 3;
      Specified by:
      hasStreamTimeout in interface PublishLifecycleEventRequestOrBuilder
      Returns:
      Whether the streamTimeout field is set.
    • getStreamTimeout

      public com.google.protobuf.Duration getStreamTimeout()
       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.
       
      .google.protobuf.Duration stream_timeout = 3;
      Specified by:
      getStreamTimeout in interface PublishLifecycleEventRequestOrBuilder
      Returns:
      The streamTimeout.
    • getStreamTimeoutOrBuilder

      public com.google.protobuf.DurationOrBuilder getStreamTimeoutOrBuilder()
       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.
       
      .google.protobuf.Duration stream_timeout = 3;
      Specified by:
      getStreamTimeoutOrBuilder in interface PublishLifecycleEventRequestOrBuilder
    • getNotificationKeywordsList

      public com.google.protobuf.ProtocolStringList getNotificationKeywordsList()
       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.
       
      repeated string notification_keywords = 4;
      Specified by:
      getNotificationKeywordsList in interface PublishLifecycleEventRequestOrBuilder
      Returns:
      A list containing the notificationKeywords.
    • getNotificationKeywordsCount

      public int getNotificationKeywordsCount()
       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.
       
      repeated string notification_keywords = 4;
      Specified by:
      getNotificationKeywordsCount in interface PublishLifecycleEventRequestOrBuilder
      Returns:
      The count of notificationKeywords.
    • getNotificationKeywords

      public String getNotificationKeywords(int index)
       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.
       
      repeated string notification_keywords = 4;
      Specified by:
      getNotificationKeywords in interface PublishLifecycleEventRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The notificationKeywords at the given index.
    • getNotificationKeywordsBytes

      public com.google.protobuf.ByteString getNotificationKeywordsBytes(int index)
       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.
       
      repeated string notification_keywords = 4;
      Specified by:
      getNotificationKeywordsBytes in interface PublishLifecycleEventRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the notificationKeywords at the given index.
    • getProjectId

      public String getProjectId()
       Required. The project this build is associated with.
       This should match the project used for the initial call to
       PublishLifecycleEvent (containing a BuildEnqueued message).
       
      string project_id = 6 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getProjectId in interface PublishLifecycleEventRequestOrBuilder
      Returns:
      The projectId.
    • getProjectIdBytes

      public com.google.protobuf.ByteString getProjectIdBytes()
       Required. The project this build is associated with.
       This should match the project used for the initial call to
       PublishLifecycleEvent (containing a BuildEnqueued message).
       
      string project_id = 6 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getProjectIdBytes in interface PublishLifecycleEventRequestOrBuilder
      Returns:
      The bytes for projectId.
    • getCheckPrecedingLifecycleEventsPresent

      public boolean getCheckPrecedingLifecycleEventsPresent()
       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.
       
      bool check_preceding_lifecycle_events_present = 7;
      Specified by:
      getCheckPrecedingLifecycleEventsPresent in interface PublishLifecycleEventRequestOrBuilder
      Returns:
      The checkPrecedingLifecycleEventsPresent.
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage
    • parseFrom

      public static PublishLifecycleEventRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PublishLifecycleEventRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PublishLifecycleEventRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PublishLifecycleEventRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PublishLifecycleEventRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PublishLifecycleEventRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PublishLifecycleEventRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static PublishLifecycleEventRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static PublishLifecycleEventRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static PublishLifecycleEventRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static PublishLifecycleEventRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static PublishLifecycleEventRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public PublishLifecycleEventRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static PublishLifecycleEventRequest.Builder newBuilder()
    • newBuilder

    • toBuilder

      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected PublishLifecycleEventRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static PublishLifecycleEventRequest getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<PublishLifecycleEventRequest> parser()
    • getParserForType

      public com.google.protobuf.Parser<PublishLifecycleEventRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage
    • getDefaultInstanceForType

      public PublishLifecycleEventRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder