com.google.pubsub.v1.StreamingPullRequestOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cloud-pubsub-client
High performance Cloud Pub/Sub client library. (NOTE) This release includes only data plane operations, publishing and pulling messages, and it is based on our gRPC beta release. (ALPHA) This library uses features that are part of an invitation-only release of the underlying Cloud Pub/Sub API. The library will generate errors unless you have access to this API. This restriction should be relaxed in the near future. Please contact [email protected] with any questions in the meantime.
There is a newer version: 0.2.1-EXPERIMENTAL
Show newest version
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/pubsub/pubsub.proto

package com.google.pubsub.v1;

public interface StreamingPullRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.pubsub.v1.StreamingPullRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * 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}`.
   * 
   *
   * optional string subscription = 1;
   */
  java.lang.String getSubscription();
  /**
   *    * 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}`.
   * 
   *
   * optional string subscription = 1;
   */
  com.google.protobuf.ByteString
      getSubscriptionBytes();

  /**
   *    * 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;
   */
  java.util.List
      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;
   */
  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;
   */
  java.lang.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;
   */
  com.google.protobuf.ByteString
      getAckIdsBytes(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;
   */
  java.util.List 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;
   */
  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;
   */
  int getModifyDeadlineSeconds(int index);

  /**
   *    * List of acknowledgement IDs whose deadline will be modified based on the
   * corresponding element in `modify_deadlines`. 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;
   */
  java.util.List
      getModifyDeadlineAckIdsList();
  /**
   *    * List of acknowledgement IDs whose deadline will be modified based on the
   * corresponding element in `modify_deadlines`. 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;
   */
  int getModifyDeadlineAckIdsCount();
  /**
   *    * List of acknowledgement IDs whose deadline will be modified based on the
   * corresponding element in `modify_deadlines`. 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;
   */
  java.lang.String getModifyDeadlineAckIds(int index);
  /**
   *    * List of acknowledgement IDs whose deadline will be modified based on the
   * corresponding element in `modify_deadlines`. 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;
   */
  com.google.protobuf.ByteString
      getModifyDeadlineAckIdsBytes(int index);

  /**
   *    * 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).
   * 
   *
   * optional int32 stream_ack_deadline_seconds = 5;
   */
  int getStreamAckDeadlineSeconds();
}