Package com.google.pubsub.v1

Class StreamingPullRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.pubsub.v1.StreamingPullRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, StreamingPullRequestOrBuilder, Serializable
public final class StreamingPullRequest extends com.google.protobuf.GeneratedMessageV3 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
See Also:

  • Field Details

    • SUBSCRIPTION_FIELD_NUMBER

      public static final int SUBSCRIPTION_FIELD_NUMBER
      See Also:

    • ACK_IDS_FIELD_NUMBER

      public static final int ACK_IDS_FIELD_NUMBER
      See Also:

    • MODIFY_DEADLINE_SECONDS_FIELD_NUMBER

      public static final int MODIFY_DEADLINE_SECONDS_FIELD_NUMBER
      See Also:

    • MODIFY_DEADLINE_ACK_IDS_FIELD_NUMBER

      public static final int MODIFY_DEADLINE_ACK_IDS_FIELD_NUMBER
      See Also:

    • STREAM_ACK_DEADLINE_SECONDS_FIELD_NUMBER

      public static final int STREAM_ACK_DEADLINE_SECONDS_FIELD_NUMBER
      See Also:

    • CLIENT_ID_FIELD_NUMBER

      public static final int CLIENT_ID_FIELD_NUMBER
      See Also:

    • MAX_OUTSTANDING_MESSAGES_FIELD_NUMBER

      public static final int MAX_OUTSTANDING_MESSAGES_FIELD_NUMBER
      See Also:

    • MAX_OUTSTANDING_BYTES_FIELD_NUMBER

      public static final int MAX_OUTSTANDING_BYTES_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • 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

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

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

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

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

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

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

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

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

    • isInitialized

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

    • 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.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

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

    • 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 StreamingPullRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static StreamingPullRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static StreamingPullRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static StreamingPullRequest.Builder newBuilder()

    • newBuilder

      public static StreamingPullRequest.Builder newBuilder(StreamingPullRequest prototype)

    • toBuilder

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

    • newBuilderForType

      protected StreamingPullRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static StreamingPullRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<StreamingPullRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<StreamingPullRequest> 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.GeneratedMessageV3

    • getDefaultInstanceForType

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