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

// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/pubsub/v1/pubsub.proto

package com.google.pubsub.v1;

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

  /**
   *    * The subscription from which messages should be pulled.
   * Format is `projects/{project}/subscriptions/{sub}`.
   * 
   *
   * string subscription = 1;
   */
  java.lang.String getSubscription();
  /**
   *    * The subscription from which messages should be pulled.
   * Format is `projects/{project}/subscriptions/{sub}`.
   * 
   *
   * string subscription = 1;
   */
  com.google.protobuf.ByteString
      getSubscriptionBytes();

  /**
   *    * If this field set to true, the system will respond immediately even if
   * it there are no messages available to return in the `Pull` response.
   * Otherwise, the system may wait (for a bounded amount of time) until at
   * least one message is available, rather than returning no messages. The
   * client may cancel the request if it does not wish to wait any longer for
   * the response.
   * 
   *
   * bool return_immediately = 2;
   */
  boolean getReturnImmediately();

  /**
   *    * The maximum number of messages returned for this request. The Pub/Sub
   * system may return fewer than the number specified.
   * 
   *
   * int32 max_messages = 3;
   */
  int getMaxMessages();
}