Class ReceivedMessage.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<ReceivedMessage.Builder>
com.google.pubsub.v1.ReceivedMessage.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ReceivedMessageOrBuilder, Cloneable
Enclosing class:
ReceivedMessage

public static final class ReceivedMessage.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<ReceivedMessage.Builder> implements ReceivedMessageOrBuilder
 A message and its corresponding acknowledgment ID.
 
Protobuf type google.pubsub.v1.ReceivedMessage
  • Method Details

    • getDescriptor

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

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ReceivedMessage.Builder>
    • clear

      public ReceivedMessage.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<ReceivedMessage.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ReceivedMessage.Builder>
    • getDefaultInstanceForType

      public ReceivedMessage getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
    • build

      public ReceivedMessage build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder
    • buildPartial

      public ReceivedMessage buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder
    • clone

      public ReceivedMessage.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<ReceivedMessage.Builder>
    • setField

      public ReceivedMessage.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<ReceivedMessage.Builder>
    • clearField

      public ReceivedMessage.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ReceivedMessage.Builder>
    • clearOneof

      public ReceivedMessage.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ReceivedMessage.Builder>
    • setRepeatedField

      public ReceivedMessage.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ReceivedMessage.Builder>
    • addRepeatedField

      public ReceivedMessage.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ReceivedMessage.Builder>
    • mergeFrom

      public ReceivedMessage.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ReceivedMessage.Builder>
    • mergeFrom

      public ReceivedMessage.Builder mergeFrom(ReceivedMessage other)
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ReceivedMessage.Builder>
    • mergeFrom

      public ReceivedMessage.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ReceivedMessage.Builder>
      Throws:
      IOException
    • getAckId

      public String getAckId()
       Optional. This ID can be used to acknowledge the received message.
       
      string ack_id = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAckId in interface ReceivedMessageOrBuilder
      Returns:
      The ackId.
    • getAckIdBytes

      public com.google.protobuf.ByteString getAckIdBytes()
       Optional. This ID can be used to acknowledge the received message.
       
      string ack_id = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAckIdBytes in interface ReceivedMessageOrBuilder
      Returns:
      The bytes for ackId.
    • setAckId

      public ReceivedMessage.Builder setAckId(String value)
       Optional. This ID can be used to acknowledge the received message.
       
      string ack_id = 1 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The ackId to set.
      Returns:
      This builder for chaining.
    • clearAckId

      public ReceivedMessage.Builder clearAckId()
       Optional. This ID can be used to acknowledge the received message.
       
      string ack_id = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.
    • setAckIdBytes

      public ReceivedMessage.Builder setAckIdBytes(com.google.protobuf.ByteString value)
       Optional. This ID can be used to acknowledge the received message.
       
      string ack_id = 1 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for ackId to set.
      Returns:
      This builder for chaining.
    • hasMessage

      public boolean hasMessage()
       Optional. The message.
       
      .google.pubsub.v1.PubsubMessage message = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasMessage in interface ReceivedMessageOrBuilder
      Returns:
      Whether the message field is set.
    • getMessage

      public PubsubMessage getMessage()
       Optional. The message.
       
      .google.pubsub.v1.PubsubMessage message = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMessage in interface ReceivedMessageOrBuilder
      Returns:
      The message.
    • setMessage

      public ReceivedMessage.Builder setMessage(PubsubMessage value)
       Optional. The message.
       
      .google.pubsub.v1.PubsubMessage message = 2 [(.google.api.field_behavior) = OPTIONAL];
    • setMessage

      public ReceivedMessage.Builder setMessage(PubsubMessage.Builder builderForValue)
       Optional. The message.
       
      .google.pubsub.v1.PubsubMessage message = 2 [(.google.api.field_behavior) = OPTIONAL];
    • mergeMessage

      public ReceivedMessage.Builder mergeMessage(PubsubMessage value)
       Optional. The message.
       
      .google.pubsub.v1.PubsubMessage message = 2 [(.google.api.field_behavior) = OPTIONAL];
    • clearMessage

      public ReceivedMessage.Builder clearMessage()
       Optional. The message.
       
      .google.pubsub.v1.PubsubMessage message = 2 [(.google.api.field_behavior) = OPTIONAL];
    • getMessageBuilder

      public PubsubMessage.Builder getMessageBuilder()
       Optional. The message.
       
      .google.pubsub.v1.PubsubMessage message = 2 [(.google.api.field_behavior) = OPTIONAL];
    • getMessageOrBuilder

      public PubsubMessageOrBuilder getMessageOrBuilder()
       Optional. The message.
       
      .google.pubsub.v1.PubsubMessage message = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMessageOrBuilder in interface ReceivedMessageOrBuilder
    • getDeliveryAttempt

      public int getDeliveryAttempt()
       Optional. The approximate number of times that Pub/Sub has attempted to
       deliver the associated message to a subscriber.
      
       More precisely, this is 1 + (number of NACKs) +
       (number of ack_deadline exceeds) for this message.
      
       A NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline
       exceeds event is whenever a message is not acknowledged within
       ack_deadline. Note that ack_deadline is initially
       Subscription.ackDeadlineSeconds, but may get extended automatically by
       the client library.
      
       Upon the first delivery of a given message, `delivery_attempt` will have a
       value of 1. The value is calculated at best effort and is approximate.
      
       If a DeadLetterPolicy is not set on the subscription, this will be 0.
       
      int32 delivery_attempt = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDeliveryAttempt in interface ReceivedMessageOrBuilder
      Returns:
      The deliveryAttempt.
    • setDeliveryAttempt

      public ReceivedMessage.Builder setDeliveryAttempt(int value)
       Optional. The approximate number of times that Pub/Sub has attempted to
       deliver the associated message to a subscriber.
      
       More precisely, this is 1 + (number of NACKs) +
       (number of ack_deadline exceeds) for this message.
      
       A NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline
       exceeds event is whenever a message is not acknowledged within
       ack_deadline. Note that ack_deadline is initially
       Subscription.ackDeadlineSeconds, but may get extended automatically by
       the client library.
      
       Upon the first delivery of a given message, `delivery_attempt` will have a
       value of 1. The value is calculated at best effort and is approximate.
      
       If a DeadLetterPolicy is not set on the subscription, this will be 0.
       
      int32 delivery_attempt = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The deliveryAttempt to set.
      Returns:
      This builder for chaining.
    • clearDeliveryAttempt

      public ReceivedMessage.Builder clearDeliveryAttempt()
       Optional. The approximate number of times that Pub/Sub has attempted to
       deliver the associated message to a subscriber.
      
       More precisely, this is 1 + (number of NACKs) +
       (number of ack_deadline exceeds) for this message.
      
       A NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline
       exceeds event is whenever a message is not acknowledged within
       ack_deadline. Note that ack_deadline is initially
       Subscription.ackDeadlineSeconds, but may get extended automatically by
       the client library.
      
       Upon the first delivery of a given message, `delivery_attempt` will have a
       value of 1. The value is calculated at best effort and is approximate.
      
       If a DeadLetterPolicy is not set on the subscription, this will be 0.
       
      int32 delivery_attempt = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.
    • setUnknownFields

      public final ReceivedMessage.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ReceivedMessage.Builder>
    • mergeUnknownFields

      public final ReceivedMessage.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ReceivedMessage.Builder>