public interface PullRequestOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getMaxMessages()
public abstract int getMaxMessages()
Required. The maximum number of messages to return for this request. Must be a positive integer. The Pub/Sub system may return fewer than the number specified.
int32 max_messages = 3 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
int | The maxMessages. |
getReturnImmediately() (deprecated)
public abstract boolean getReturnImmediately()
Deprecated. google.pubsub.v1.PullRequest.return_immediately is deprecated. See google/pubsub/v1/pubsub.proto;l=1358
Optional. 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.
Warning: setting this field to true
is discouraged because it adversely
impacts the performance of Pull
operations. We recommend that users do
not set this field.
bool return_immediately = 2 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean | The returnImmediately. |
getSubscription()
public abstract String getSubscription()
Required. The subscription from which messages should be pulled.
Format is projects/{project}/subscriptions/{sub}
.
string subscription = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
String | The subscription. |
getSubscriptionBytes()
public abstract ByteString getSubscriptionBytes()
Required. The subscription from which messages should be pulled.
Format is projects/{project}/subscriptions/{sub}
.
string subscription = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ByteString | The bytes for subscription. |