com.google.pubsub.v1

Interface PullRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

PullRequest, PullRequest.Builder

public interface PullRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
int	getMaxMessages() The maximum number of messages returned for this request.
boolean	getReturnImmediately() 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.
java.lang.String	getSubscription() The subscription from which messages should be pulled.
com.google.protobuf.ByteString	getSubscriptionBytes() The subscription from which messages should be pulled.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getSubscription

java.lang.String getSubscription()

 The subscription from which messages should be pulled.
 Format is `projects/{project}/subscriptions/{sub}`.
 

string subscription = 1;

getSubscriptionBytes

com.google.protobuf.ByteString getSubscriptionBytes()

 The subscription from which messages should be pulled.
 Format is `projects/{project}/subscriptions/{sub}`.
 

string subscription = 1;

getReturnImmediately

boolean getReturnImmediately()

 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;

getMaxMessages

int getMaxMessages()

 The maximum number of messages returned for this request. The Pub/Sub
 system may return fewer than the number specified.
 

int32 max_messages = 3;