# Interface PullRequestOrBuilder (1.151.0)

1.151.0 (latest) 1.150.1 1.149.0 1.148.0 1.147.0 1.145.0 1.143.1 1.142.0 1.141.5 1.140.2 1.139.4 1.138.0 1.137.1 1.136.1 1.135.0 1.134.2 1.133.1 1.132.2 1.131.0 1.130.0 1.129.6 1.127.3 1.126.6 1.125.13 1.123.18 1.122.2 1.121.1 1.120.24 1.119.1 1.118.0 1.117.0 1.116.4 1.115.5

    public interface PullRequestOrBuilder extends MessageOrBuilder

## Implements

[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)

## Methods

### 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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The maxMessages. |

### getReturnImmediately() (deprecated)

    public abstract boolean getReturnImmediately()

**Deprecated.** *google.pubsub.v1.PullRequest.return_immediately is deprecated. See
google/pubsub/v1/pubsub.proto;l=2180*

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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | 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** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for subscription. |