Class StreamingPullRequest.Builder

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

public static final class StreamingPullRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<StreamingPullRequest.Builder> implements StreamingPullRequestOrBuilder
 Request for the `StreamingPull` streaming RPC method. This request is used to
 establish the initial stream as well as to stream acknowledgements and ack
 deadline modifications from the client to the server.
 
Protobuf type google.pubsub.v1.StreamingPullRequest
  • 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<StreamingPullRequest.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<StreamingPullRequest.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<StreamingPullRequest.Builder>
    • getDefaultInstanceForType

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

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

      public StreamingPullRequest buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.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<StreamingPullRequest.Builder>
    • setField

      public StreamingPullRequest.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<StreamingPullRequest.Builder>
    • clearField

      public StreamingPullRequest.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<StreamingPullRequest.Builder>
    • clearOneof

      public StreamingPullRequest.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<StreamingPullRequest.Builder>
    • setRepeatedField

      public StreamingPullRequest.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<StreamingPullRequest.Builder>
    • addRepeatedField

      public StreamingPullRequest.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<StreamingPullRequest.Builder>
    • mergeFrom

      public StreamingPullRequest.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<StreamingPullRequest.Builder>
    • mergeFrom

    • isInitialized

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

      public StreamingPullRequest.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<StreamingPullRequest.Builder>
      Throws:
      IOException
    • getSubscription

      public String getSubscription()
       Required. The subscription for which to initialize the new stream. This
       must be provided in the first request on the stream, and must not be set in
       subsequent requests from client to server.
       Format is `projects/{project}/subscriptions/{sub}`.
       
      string subscription = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getSubscription in interface StreamingPullRequestOrBuilder
      Returns:
      The subscription.
    • getSubscriptionBytes

      public com.google.protobuf.ByteString getSubscriptionBytes()
       Required. The subscription for which to initialize the new stream. This
       must be provided in the first request on the stream, and must not be set in
       subsequent requests from client to server.
       Format is `projects/{project}/subscriptions/{sub}`.
       
      string subscription = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getSubscriptionBytes in interface StreamingPullRequestOrBuilder
      Returns:
      The bytes for subscription.
    • setSubscription

      public StreamingPullRequest.Builder setSubscription(String value)
       Required. The subscription for which to initialize the new stream. This
       must be provided in the first request on the stream, and must not be set in
       subsequent requests from client to server.
       Format is `projects/{project}/subscriptions/{sub}`.
       
      string subscription = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The subscription to set.
      Returns:
      This builder for chaining.
    • clearSubscription

      public StreamingPullRequest.Builder clearSubscription()
       Required. The subscription for which to initialize the new stream. This
       must be provided in the first request on the stream, and must not be set in
       subsequent requests from client to server.
       Format is `projects/{project}/subscriptions/{sub}`.
       
      string subscription = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.
    • setSubscriptionBytes

      public StreamingPullRequest.Builder setSubscriptionBytes(com.google.protobuf.ByteString value)
       Required. The subscription for which to initialize the new stream. This
       must be provided in the first request on the stream, and must not be set in
       subsequent requests from client to server.
       Format is `projects/{project}/subscriptions/{sub}`.
       
      string subscription = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for subscription to set.
      Returns:
      This builder for chaining.
    • getAckIdsList

      public com.google.protobuf.ProtocolStringList getAckIdsList()
       Optional. List of acknowledgement IDs for acknowledging previously received
       messages (received on this stream or a different stream). If an ack ID has
       expired, the corresponding message may be redelivered later. Acknowledging
       a message more than once will not result in an error. If the
       acknowledgement ID is malformed, the stream will be aborted with status
       `INVALID_ARGUMENT`.
       
      repeated string ack_ids = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAckIdsList in interface StreamingPullRequestOrBuilder
      Returns:
      A list containing the ackIds.
    • getAckIdsCount

      public int getAckIdsCount()
       Optional. List of acknowledgement IDs for acknowledging previously received
       messages (received on this stream or a different stream). If an ack ID has
       expired, the corresponding message may be redelivered later. Acknowledging
       a message more than once will not result in an error. If the
       acknowledgement ID is malformed, the stream will be aborted with status
       `INVALID_ARGUMENT`.
       
      repeated string ack_ids = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAckIdsCount in interface StreamingPullRequestOrBuilder
      Returns:
      The count of ackIds.
    • getAckIds

      public String getAckIds(int index)
       Optional. List of acknowledgement IDs for acknowledging previously received
       messages (received on this stream or a different stream). If an ack ID has
       expired, the corresponding message may be redelivered later. Acknowledging
       a message more than once will not result in an error. If the
       acknowledgement ID is malformed, the stream will be aborted with status
       `INVALID_ARGUMENT`.
       
      repeated string ack_ids = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAckIds in interface StreamingPullRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The ackIds at the given index.
    • getAckIdsBytes

      public com.google.protobuf.ByteString getAckIdsBytes(int index)
       Optional. List of acknowledgement IDs for acknowledging previously received
       messages (received on this stream or a different stream). If an ack ID has
       expired, the corresponding message may be redelivered later. Acknowledging
       a message more than once will not result in an error. If the
       acknowledgement ID is malformed, the stream will be aborted with status
       `INVALID_ARGUMENT`.
       
      repeated string ack_ids = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAckIdsBytes in interface StreamingPullRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the ackIds at the given index.
    • setAckIds

      public StreamingPullRequest.Builder setAckIds(int index, String value)
       Optional. List of acknowledgement IDs for acknowledging previously received
       messages (received on this stream or a different stream). If an ack ID has
       expired, the corresponding message may be redelivered later. Acknowledging
       a message more than once will not result in an error. If the
       acknowledgement ID is malformed, the stream will be aborted with status
       `INVALID_ARGUMENT`.
       
      repeated string ack_ids = 2 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index to set the value at.
      value - The ackIds to set.
      Returns:
      This builder for chaining.
    • addAckIds

      public StreamingPullRequest.Builder addAckIds(String value)
       Optional. List of acknowledgement IDs for acknowledging previously received
       messages (received on this stream or a different stream). If an ack ID has
       expired, the corresponding message may be redelivered later. Acknowledging
       a message more than once will not result in an error. If the
       acknowledgement ID is malformed, the stream will be aborted with status
       `INVALID_ARGUMENT`.
       
      repeated string ack_ids = 2 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The ackIds to add.
      Returns:
      This builder for chaining.
    • addAllAckIds

      public StreamingPullRequest.Builder addAllAckIds(Iterable<String> values)
       Optional. List of acknowledgement IDs for acknowledging previously received
       messages (received on this stream or a different stream). If an ack ID has
       expired, the corresponding message may be redelivered later. Acknowledging
       a message more than once will not result in an error. If the
       acknowledgement ID is malformed, the stream will be aborted with status
       `INVALID_ARGUMENT`.
       
      repeated string ack_ids = 2 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      values - The ackIds to add.
      Returns:
      This builder for chaining.
    • clearAckIds

      public StreamingPullRequest.Builder clearAckIds()
       Optional. List of acknowledgement IDs for acknowledging previously received
       messages (received on this stream or a different stream). If an ack ID has
       expired, the corresponding message may be redelivered later. Acknowledging
       a message more than once will not result in an error. If the
       acknowledgement ID is malformed, the stream will be aborted with status
       `INVALID_ARGUMENT`.
       
      repeated string ack_ids = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.
    • addAckIdsBytes

      public StreamingPullRequest.Builder addAckIdsBytes(com.google.protobuf.ByteString value)
       Optional. List of acknowledgement IDs for acknowledging previously received
       messages (received on this stream or a different stream). If an ack ID has
       expired, the corresponding message may be redelivered later. Acknowledging
       a message more than once will not result in an error. If the
       acknowledgement ID is malformed, the stream will be aborted with status
       `INVALID_ARGUMENT`.
       
      repeated string ack_ids = 2 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes of the ackIds to add.
      Returns:
      This builder for chaining.
    • getModifyDeadlineSecondsList

      public List<Integer> getModifyDeadlineSecondsList()
       Optional. The list of new ack deadlines for the IDs listed in
       `modify_deadline_ack_ids`. The size of this list must be the same as the
       size of `modify_deadline_ack_ids`. If it differs the stream will be aborted
       with `INVALID_ARGUMENT`. Each element in this list is applied to the
       element in the same position in `modify_deadline_ack_ids`. The new ack
       deadline is with respect to the time this request was sent to the Pub/Sub
       system. Must be >= 0. For example, if the value is 10, the new ack deadline
       will expire 10 seconds after this request is received. If the value is 0,
       the message is immediately made available for another streaming or
       non-streaming pull request. If the value is < 0 (an error), the stream will
       be aborted with status `INVALID_ARGUMENT`.
       
      repeated int32 modify_deadline_seconds = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getModifyDeadlineSecondsList in interface StreamingPullRequestOrBuilder
      Returns:
      A list containing the modifyDeadlineSeconds.
    • getModifyDeadlineSecondsCount

      public int getModifyDeadlineSecondsCount()
       Optional. The list of new ack deadlines for the IDs listed in
       `modify_deadline_ack_ids`. The size of this list must be the same as the
       size of `modify_deadline_ack_ids`. If it differs the stream will be aborted
       with `INVALID_ARGUMENT`. Each element in this list is applied to the
       element in the same position in `modify_deadline_ack_ids`. The new ack
       deadline is with respect to the time this request was sent to the Pub/Sub
       system. Must be >= 0. For example, if the value is 10, the new ack deadline
       will expire 10 seconds after this request is received. If the value is 0,
       the message is immediately made available for another streaming or
       non-streaming pull request. If the value is < 0 (an error), the stream will
       be aborted with status `INVALID_ARGUMENT`.
       
      repeated int32 modify_deadline_seconds = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getModifyDeadlineSecondsCount in interface StreamingPullRequestOrBuilder
      Returns:
      The count of modifyDeadlineSeconds.
    • getModifyDeadlineSeconds

      public int getModifyDeadlineSeconds(int index)
       Optional. The list of new ack deadlines for the IDs listed in
       `modify_deadline_ack_ids`. The size of this list must be the same as the
       size of `modify_deadline_ack_ids`. If it differs the stream will be aborted
       with `INVALID_ARGUMENT`. Each element in this list is applied to the
       element in the same position in `modify_deadline_ack_ids`. The new ack
       deadline is with respect to the time this request was sent to the Pub/Sub
       system. Must be >= 0. For example, if the value is 10, the new ack deadline
       will expire 10 seconds after this request is received. If the value is 0,
       the message is immediately made available for another streaming or
       non-streaming pull request. If the value is < 0 (an error), the stream will
       be aborted with status `INVALID_ARGUMENT`.
       
      repeated int32 modify_deadline_seconds = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getModifyDeadlineSeconds in interface StreamingPullRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The modifyDeadlineSeconds at the given index.
    • setModifyDeadlineSeconds

      public StreamingPullRequest.Builder setModifyDeadlineSeconds(int index, int value)
       Optional. The list of new ack deadlines for the IDs listed in
       `modify_deadline_ack_ids`. The size of this list must be the same as the
       size of `modify_deadline_ack_ids`. If it differs the stream will be aborted
       with `INVALID_ARGUMENT`. Each element in this list is applied to the
       element in the same position in `modify_deadline_ack_ids`. The new ack
       deadline is with respect to the time this request was sent to the Pub/Sub
       system. Must be >= 0. For example, if the value is 10, the new ack deadline
       will expire 10 seconds after this request is received. If the value is 0,
       the message is immediately made available for another streaming or
       non-streaming pull request. If the value is < 0 (an error), the stream will
       be aborted with status `INVALID_ARGUMENT`.
       
      repeated int32 modify_deadline_seconds = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index to set the value at.
      value - The modifyDeadlineSeconds to set.
      Returns:
      This builder for chaining.
    • addModifyDeadlineSeconds

      public StreamingPullRequest.Builder addModifyDeadlineSeconds(int value)
       Optional. The list of new ack deadlines for the IDs listed in
       `modify_deadline_ack_ids`. The size of this list must be the same as the
       size of `modify_deadline_ack_ids`. If it differs the stream will be aborted
       with `INVALID_ARGUMENT`. Each element in this list is applied to the
       element in the same position in `modify_deadline_ack_ids`. The new ack
       deadline is with respect to the time this request was sent to the Pub/Sub
       system. Must be >= 0. For example, if the value is 10, the new ack deadline
       will expire 10 seconds after this request is received. If the value is 0,
       the message is immediately made available for another streaming or
       non-streaming pull request. If the value is < 0 (an error), the stream will
       be aborted with status `INVALID_ARGUMENT`.
       
      repeated int32 modify_deadline_seconds = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The modifyDeadlineSeconds to add.
      Returns:
      This builder for chaining.
    • addAllModifyDeadlineSeconds

      public StreamingPullRequest.Builder addAllModifyDeadlineSeconds(Iterable<? extends Integer> values)
       Optional. The list of new ack deadlines for the IDs listed in
       `modify_deadline_ack_ids`. The size of this list must be the same as the
       size of `modify_deadline_ack_ids`. If it differs the stream will be aborted
       with `INVALID_ARGUMENT`. Each element in this list is applied to the
       element in the same position in `modify_deadline_ack_ids`. The new ack
       deadline is with respect to the time this request was sent to the Pub/Sub
       system. Must be >= 0. For example, if the value is 10, the new ack deadline
       will expire 10 seconds after this request is received. If the value is 0,
       the message is immediately made available for another streaming or
       non-streaming pull request. If the value is < 0 (an error), the stream will
       be aborted with status `INVALID_ARGUMENT`.
       
      repeated int32 modify_deadline_seconds = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      values - The modifyDeadlineSeconds to add.
      Returns:
      This builder for chaining.
    • clearModifyDeadlineSeconds

      public StreamingPullRequest.Builder clearModifyDeadlineSeconds()
       Optional. The list of new ack deadlines for the IDs listed in
       `modify_deadline_ack_ids`. The size of this list must be the same as the
       size of `modify_deadline_ack_ids`. If it differs the stream will be aborted
       with `INVALID_ARGUMENT`. Each element in this list is applied to the
       element in the same position in `modify_deadline_ack_ids`. The new ack
       deadline is with respect to the time this request was sent to the Pub/Sub
       system. Must be >= 0. For example, if the value is 10, the new ack deadline
       will expire 10 seconds after this request is received. If the value is 0,
       the message is immediately made available for another streaming or
       non-streaming pull request. If the value is < 0 (an error), the stream will
       be aborted with status `INVALID_ARGUMENT`.
       
      repeated int32 modify_deadline_seconds = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.
    • getModifyDeadlineAckIdsList

      public com.google.protobuf.ProtocolStringList getModifyDeadlineAckIdsList()
       Optional. List of acknowledgement IDs whose deadline will be modified based
       on the corresponding element in `modify_deadline_seconds`. This field can
       be used to indicate that more time is needed to process a message by the
       subscriber, or to make the message available for redelivery if the
       processing was interrupted.
       
      repeated string modify_deadline_ack_ids = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getModifyDeadlineAckIdsList in interface StreamingPullRequestOrBuilder
      Returns:
      A list containing the modifyDeadlineAckIds.
    • getModifyDeadlineAckIdsCount

      public int getModifyDeadlineAckIdsCount()
       Optional. List of acknowledgement IDs whose deadline will be modified based
       on the corresponding element in `modify_deadline_seconds`. This field can
       be used to indicate that more time is needed to process a message by the
       subscriber, or to make the message available for redelivery if the
       processing was interrupted.
       
      repeated string modify_deadline_ack_ids = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getModifyDeadlineAckIdsCount in interface StreamingPullRequestOrBuilder
      Returns:
      The count of modifyDeadlineAckIds.
    • getModifyDeadlineAckIds

      public String getModifyDeadlineAckIds(int index)
       Optional. List of acknowledgement IDs whose deadline will be modified based
       on the corresponding element in `modify_deadline_seconds`. This field can
       be used to indicate that more time is needed to process a message by the
       subscriber, or to make the message available for redelivery if the
       processing was interrupted.
       
      repeated string modify_deadline_ack_ids = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getModifyDeadlineAckIds in interface StreamingPullRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The modifyDeadlineAckIds at the given index.
    • getModifyDeadlineAckIdsBytes

      public com.google.protobuf.ByteString getModifyDeadlineAckIdsBytes(int index)
       Optional. List of acknowledgement IDs whose deadline will be modified based
       on the corresponding element in `modify_deadline_seconds`. This field can
       be used to indicate that more time is needed to process a message by the
       subscriber, or to make the message available for redelivery if the
       processing was interrupted.
       
      repeated string modify_deadline_ack_ids = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getModifyDeadlineAckIdsBytes in interface StreamingPullRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the modifyDeadlineAckIds at the given index.
    • setModifyDeadlineAckIds

      public StreamingPullRequest.Builder setModifyDeadlineAckIds(int index, String value)
       Optional. List of acknowledgement IDs whose deadline will be modified based
       on the corresponding element in `modify_deadline_seconds`. This field can
       be used to indicate that more time is needed to process a message by the
       subscriber, or to make the message available for redelivery if the
       processing was interrupted.
       
      repeated string modify_deadline_ack_ids = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index to set the value at.
      value - The modifyDeadlineAckIds to set.
      Returns:
      This builder for chaining.
    • addModifyDeadlineAckIds

      public StreamingPullRequest.Builder addModifyDeadlineAckIds(String value)
       Optional. List of acknowledgement IDs whose deadline will be modified based
       on the corresponding element in `modify_deadline_seconds`. This field can
       be used to indicate that more time is needed to process a message by the
       subscriber, or to make the message available for redelivery if the
       processing was interrupted.
       
      repeated string modify_deadline_ack_ids = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The modifyDeadlineAckIds to add.
      Returns:
      This builder for chaining.
    • addAllModifyDeadlineAckIds

      public StreamingPullRequest.Builder addAllModifyDeadlineAckIds(Iterable<String> values)
       Optional. List of acknowledgement IDs whose deadline will be modified based
       on the corresponding element in `modify_deadline_seconds`. This field can
       be used to indicate that more time is needed to process a message by the
       subscriber, or to make the message available for redelivery if the
       processing was interrupted.
       
      repeated string modify_deadline_ack_ids = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      values - The modifyDeadlineAckIds to add.
      Returns:
      This builder for chaining.
    • clearModifyDeadlineAckIds

      public StreamingPullRequest.Builder clearModifyDeadlineAckIds()
       Optional. List of acknowledgement IDs whose deadline will be modified based
       on the corresponding element in `modify_deadline_seconds`. This field can
       be used to indicate that more time is needed to process a message by the
       subscriber, or to make the message available for redelivery if the
       processing was interrupted.
       
      repeated string modify_deadline_ack_ids = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.
    • addModifyDeadlineAckIdsBytes

      public StreamingPullRequest.Builder addModifyDeadlineAckIdsBytes(com.google.protobuf.ByteString value)
       Optional. List of acknowledgement IDs whose deadline will be modified based
       on the corresponding element in `modify_deadline_seconds`. This field can
       be used to indicate that more time is needed to process a message by the
       subscriber, or to make the message available for redelivery if the
       processing was interrupted.
       
      repeated string modify_deadline_ack_ids = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes of the modifyDeadlineAckIds to add.
      Returns:
      This builder for chaining.
    • getStreamAckDeadlineSeconds

      public int getStreamAckDeadlineSeconds()
       Required. The ack deadline to use for the stream. This must be provided in
       the first request on the stream, but it can also be updated on subsequent
       requests from client to server. The minimum deadline you can specify is 10
       seconds. The maximum deadline you can specify is 600 seconds (10 minutes).
       
      int32 stream_ack_deadline_seconds = 5 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getStreamAckDeadlineSeconds in interface StreamingPullRequestOrBuilder
      Returns:
      The streamAckDeadlineSeconds.
    • setStreamAckDeadlineSeconds

      public StreamingPullRequest.Builder setStreamAckDeadlineSeconds(int value)
       Required. The ack deadline to use for the stream. This must be provided in
       the first request on the stream, but it can also be updated on subsequent
       requests from client to server. The minimum deadline you can specify is 10
       seconds. The maximum deadline you can specify is 600 seconds (10 minutes).
       
      int32 stream_ack_deadline_seconds = 5 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The streamAckDeadlineSeconds to set.
      Returns:
      This builder for chaining.
    • clearStreamAckDeadlineSeconds

      public StreamingPullRequest.Builder clearStreamAckDeadlineSeconds()
       Required. The ack deadline to use for the stream. This must be provided in
       the first request on the stream, but it can also be updated on subsequent
       requests from client to server. The minimum deadline you can specify is 10
       seconds. The maximum deadline you can specify is 600 seconds (10 minutes).
       
      int32 stream_ack_deadline_seconds = 5 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.
    • getClientId

      public String getClientId()
       Optional. A unique identifier that is used to distinguish client instances
       from each other. Only needs to be provided on the initial request. When a
       stream disconnects and reconnects for the same stream, the client_id should
       be set to the same value so that state associated with the old stream can
       be transferred to the new stream. The same client_id should not be used for
       different client instances.
       
      string client_id = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getClientId in interface StreamingPullRequestOrBuilder
      Returns:
      The clientId.
    • getClientIdBytes

      public com.google.protobuf.ByteString getClientIdBytes()
       Optional. A unique identifier that is used to distinguish client instances
       from each other. Only needs to be provided on the initial request. When a
       stream disconnects and reconnects for the same stream, the client_id should
       be set to the same value so that state associated with the old stream can
       be transferred to the new stream. The same client_id should not be used for
       different client instances.
       
      string client_id = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getClientIdBytes in interface StreamingPullRequestOrBuilder
      Returns:
      The bytes for clientId.
    • setClientId

      public StreamingPullRequest.Builder setClientId(String value)
       Optional. A unique identifier that is used to distinguish client instances
       from each other. Only needs to be provided on the initial request. When a
       stream disconnects and reconnects for the same stream, the client_id should
       be set to the same value so that state associated with the old stream can
       be transferred to the new stream. The same client_id should not be used for
       different client instances.
       
      string client_id = 6 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The clientId to set.
      Returns:
      This builder for chaining.
    • clearClientId

      public StreamingPullRequest.Builder clearClientId()
       Optional. A unique identifier that is used to distinguish client instances
       from each other. Only needs to be provided on the initial request. When a
       stream disconnects and reconnects for the same stream, the client_id should
       be set to the same value so that state associated with the old stream can
       be transferred to the new stream. The same client_id should not be used for
       different client instances.
       
      string client_id = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.
    • setClientIdBytes

      public StreamingPullRequest.Builder setClientIdBytes(com.google.protobuf.ByteString value)
       Optional. A unique identifier that is used to distinguish client instances
       from each other. Only needs to be provided on the initial request. When a
       stream disconnects and reconnects for the same stream, the client_id should
       be set to the same value so that state associated with the old stream can
       be transferred to the new stream. The same client_id should not be used for
       different client instances.
       
      string client_id = 6 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for clientId to set.
      Returns:
      This builder for chaining.
    • getMaxOutstandingMessages

      public long getMaxOutstandingMessages()
       Optional. Flow control settings for the maximum number of outstanding
       messages. When there are `max_outstanding_messages` currently sent to the
       streaming pull client that have not yet been acked or nacked, the server
       stops sending more messages. The sending of messages resumes once the
       number of outstanding messages is less than this value. If the value is
       <= 0, there is no limit to the number of outstanding messages. This
       property can only be set on the initial StreamingPullRequest. If it is set
       on a subsequent request, the stream will be aborted with status
       `INVALID_ARGUMENT`.
       
      int64 max_outstanding_messages = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMaxOutstandingMessages in interface StreamingPullRequestOrBuilder
      Returns:
      The maxOutstandingMessages.
    • setMaxOutstandingMessages

      public StreamingPullRequest.Builder setMaxOutstandingMessages(long value)
       Optional. Flow control settings for the maximum number of outstanding
       messages. When there are `max_outstanding_messages` currently sent to the
       streaming pull client that have not yet been acked or nacked, the server
       stops sending more messages. The sending of messages resumes once the
       number of outstanding messages is less than this value. If the value is
       <= 0, there is no limit to the number of outstanding messages. This
       property can only be set on the initial StreamingPullRequest. If it is set
       on a subsequent request, the stream will be aborted with status
       `INVALID_ARGUMENT`.
       
      int64 max_outstanding_messages = 7 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The maxOutstandingMessages to set.
      Returns:
      This builder for chaining.
    • clearMaxOutstandingMessages

      public StreamingPullRequest.Builder clearMaxOutstandingMessages()
       Optional. Flow control settings for the maximum number of outstanding
       messages. When there are `max_outstanding_messages` currently sent to the
       streaming pull client that have not yet been acked or nacked, the server
       stops sending more messages. The sending of messages resumes once the
       number of outstanding messages is less than this value. If the value is
       <= 0, there is no limit to the number of outstanding messages. This
       property can only be set on the initial StreamingPullRequest. If it is set
       on a subsequent request, the stream will be aborted with status
       `INVALID_ARGUMENT`.
       
      int64 max_outstanding_messages = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.
    • getMaxOutstandingBytes

      public long getMaxOutstandingBytes()
       Optional. Flow control settings for the maximum number of outstanding
       bytes. When there are `max_outstanding_bytes` or more worth of messages
       currently sent to the streaming pull client that have not yet been acked or
       nacked, the server will stop sending more messages. The sending of messages
       resumes once the number of outstanding bytes is less than this value. If
       the value is <= 0, there is no limit to the number of outstanding bytes.
       This property can only be set on the initial StreamingPullRequest. If it is
       set on a subsequent request, the stream will be aborted with status
       `INVALID_ARGUMENT`.
       
      int64 max_outstanding_bytes = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMaxOutstandingBytes in interface StreamingPullRequestOrBuilder
      Returns:
      The maxOutstandingBytes.
    • setMaxOutstandingBytes

      public StreamingPullRequest.Builder setMaxOutstandingBytes(long value)
       Optional. Flow control settings for the maximum number of outstanding
       bytes. When there are `max_outstanding_bytes` or more worth of messages
       currently sent to the streaming pull client that have not yet been acked or
       nacked, the server will stop sending more messages. The sending of messages
       resumes once the number of outstanding bytes is less than this value. If
       the value is <= 0, there is no limit to the number of outstanding bytes.
       This property can only be set on the initial StreamingPullRequest. If it is
       set on a subsequent request, the stream will be aborted with status
       `INVALID_ARGUMENT`.
       
      int64 max_outstanding_bytes = 8 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The maxOutstandingBytes to set.
      Returns:
      This builder for chaining.
    • clearMaxOutstandingBytes

      public StreamingPullRequest.Builder clearMaxOutstandingBytes()
       Optional. Flow control settings for the maximum number of outstanding
       bytes. When there are `max_outstanding_bytes` or more worth of messages
       currently sent to the streaming pull client that have not yet been acked or
       nacked, the server will stop sending more messages. The sending of messages
       resumes once the number of outstanding bytes is less than this value. If
       the value is <= 0, there is no limit to the number of outstanding bytes.
       This property can only be set on the initial StreamingPullRequest. If it is
       set on a subsequent request, the stream will be aborted with status
       `INVALID_ARGUMENT`.
       
      int64 max_outstanding_bytes = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.
    • setUnknownFields

      public final StreamingPullRequest.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<StreamingPullRequest.Builder>
    • mergeUnknownFields

      public final StreamingPullRequest.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<StreamingPullRequest.Builder>