Package com.google.pubsub.v1

Interface StreamingPullRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    StreamingPullRequest, StreamingPullRequest.Builder
    public interface StreamingPullRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getAckIds​(int index)
      List of acknowledgement IDs for acknowledging previously received messages (received on this stream or a different stream).
      com.google.protobuf.ByteString getAckIdsBytes​(int index)
      List of acknowledgement IDs for acknowledging previously received messages (received on this stream or a different stream).
      int getAckIdsCount()
      List of acknowledgement IDs for acknowledging previously received messages (received on this stream or a different stream).
      List<String> getAckIdsList()
      List of acknowledgement IDs for acknowledging previously received messages (received on this stream or a different stream).
      String getClientId()
      A unique identifier that is used to distinguish client instances from each other.
      com.google.protobuf.ByteString getClientIdBytes()
      A unique identifier that is used to distinguish client instances from each other.
      long getMaxOutstandingBytes()
      Flow control settings for the maximum number of outstanding bytes.
      long getMaxOutstandingMessages()
      Flow control settings for the maximum number of outstanding messages.
      String getModifyDeadlineAckIds​(int index)
      List of acknowledgement IDs whose deadline will be modified based on the corresponding element in `modify_deadline_seconds`.
      com.google.protobuf.ByteString getModifyDeadlineAckIdsBytes​(int index)
      List of acknowledgement IDs whose deadline will be modified based on the corresponding element in `modify_deadline_seconds`.
      int getModifyDeadlineAckIdsCount()
      List of acknowledgement IDs whose deadline will be modified based on the corresponding element in `modify_deadline_seconds`.
      List<String> getModifyDeadlineAckIdsList()
      List of acknowledgement IDs whose deadline will be modified based on the corresponding element in `modify_deadline_seconds`.
      int getModifyDeadlineSeconds​(int index)
      The list of new ack deadlines for the IDs listed in `modify_deadline_ack_ids`.
      int getModifyDeadlineSecondsCount()
      The list of new ack deadlines for the IDs listed in `modify_deadline_ack_ids`.
      List<Integer> getModifyDeadlineSecondsList()
      The list of new ack deadlines for the IDs listed in `modify_deadline_ack_ids`.
      int getStreamAckDeadlineSeconds()
      Required.
      String getSubscription()
      Required.
      com.google.protobuf.ByteString getSubscriptionBytes()
      Required.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getSubscription

        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) = { ... }
        Returns:
        The subscription.

      • getSubscriptionBytes

        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) = { ... }
        Returns:
        The bytes for subscription.

      • getAckIdsList

        List<String> getAckIdsList()
         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;
        Returns:
        A list containing the ackIds.

      • getAckIdsCount

        int getAckIdsCount()
         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;
        Returns:
        The count of ackIds.

      • getAckIds

        String getAckIds​(int index)
         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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The ackIds at the given index.

      • getAckIdsBytes

        com.google.protobuf.ByteString getAckIdsBytes​(int index)
         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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the ackIds at the given index.

      • getModifyDeadlineSecondsList

        List<Integer> getModifyDeadlineSecondsList()
         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;
        Returns:
        A list containing the modifyDeadlineSeconds.

      • getModifyDeadlineSecondsCount

        int getModifyDeadlineSecondsCount()
         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;
        Returns:
        The count of modifyDeadlineSeconds.

      • getModifyDeadlineSeconds

        int getModifyDeadlineSeconds​(int index)
         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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The modifyDeadlineSeconds at the given index.

      • getModifyDeadlineAckIdsList

        List<String> getModifyDeadlineAckIdsList()
         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;
        Returns:
        A list containing the modifyDeadlineAckIds.

      • getModifyDeadlineAckIdsCount

        int getModifyDeadlineAckIdsCount()
         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;
        Returns:
        The count of modifyDeadlineAckIds.

      • getModifyDeadlineAckIds

        String getModifyDeadlineAckIds​(int index)
         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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The modifyDeadlineAckIds at the given index.

      • getModifyDeadlineAckIdsBytes

        com.google.protobuf.ByteString getModifyDeadlineAckIdsBytes​(int index)
         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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the modifyDeadlineAckIds at the given index.

      • getStreamAckDeadlineSeconds

        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];
        Returns:
        The streamAckDeadlineSeconds.

      • getClientId

        String getClientId()
         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;
        Returns:
        The clientId.

      • getClientIdBytes

        com.google.protobuf.ByteString getClientIdBytes()
         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;
        Returns:
        The bytes for clientId.

      • getMaxOutstandingMessages

        long getMaxOutstandingMessages()
         Flow control settings for the maximum number of outstanding messages. When
 there are `max_outstanding_messages` or more 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;
        Returns:
        The maxOutstandingMessages.

      • getMaxOutstandingBytes

        long getMaxOutstandingBytes()
         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;
        Returns:
        The maxOutstandingBytes.