PullRequest.Builder (proto-google-cloud-pubsub-v1 1.90.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<PullRequest.Builder>
    - - com.google.pubsub.v1.PullRequest.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, PullRequestOrBuilder, Cloneable

Enclosing class:

PullRequest
```
public static final class PullRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<PullRequest.Builder>
implements PullRequestOrBuilder
```
```
 Request for the `Pull` method.
 
```
Protobuf type google.pubsub.v1.PullRequest

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`PullRequest.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`PullRequest`	`build()`
`PullRequest`	`buildPartial()`
`PullRequest.Builder`	`clear()`
`PullRequest.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`PullRequest.Builder`	`clearMaxMessages()` Required.
`PullRequest.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`PullRequest.Builder`	`clearReturnImmediately()` Deprecated.
`PullRequest.Builder`	`clearSubscription()` Required.
`PullRequest.Builder`	`clone()`
`PullRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`int`	`getMaxMessages()` Required.
`boolean`	`getReturnImmediately()` Deprecated.
`String`	`getSubscription()` Required.
`com.google.protobuf.ByteString`	`getSubscriptionBytes()` Required.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`PullRequest.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`PullRequest.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`PullRequest.Builder`	`mergeFrom(PullRequest other)`
`PullRequest.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`PullRequest.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`PullRequest.Builder`	`setMaxMessages(int value)` Required.
`PullRequest.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`PullRequest.Builder`	`setReturnImmediately(boolean value)` Deprecated.
`PullRequest.Builder`	`setSubscription(String value)` Required.
`PullRequest.Builder`	`setSubscriptionBytes(com.google.protobuf.ByteString value)` Required.
`PullRequest.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

- Method Detail
  - getDescriptor
```
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<PullRequest.Builder>
  - clear
```
public PullRequest.Builder clear()
```
    Specified by:
    
    clear in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clear in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessageV3.Builder<PullRequest.Builder>
  - getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<PullRequest.Builder>
  - getDefaultInstanceForType
```
public PullRequest getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public PullRequest build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public PullRequest buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public PullRequest.Builder clone()
```
    Specified by:
    
    clone in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clone in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageV3.Builder<PullRequest.Builder>
  - setField
```
public PullRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                    Object value)
```
    Specified by:
    
    setField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<PullRequest.Builder>
  - clearField
```
public PullRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
    Specified by:
    
    clearField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearField in class com.google.protobuf.GeneratedMessageV3.Builder<PullRequest.Builder>
  - clearOneof
```
public PullRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
    Specified by:
    
    clearOneof in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<PullRequest.Builder>
  - setRepeatedField
```
public PullRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            int index,
                                            Object value)
```
    Specified by:
    
    setRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PullRequest.Builder>
  - addRepeatedField
```
public PullRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            Object value)
```
    Specified by:
    
    addRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PullRequest.Builder>
  - mergeFrom
```
public PullRequest.Builder mergeFrom(com.google.protobuf.Message other)
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PullRequest.Builder>
  - mergeFrom
```
public PullRequest.Builder mergeFrom(PullRequest other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<PullRequest.Builder>
  - mergeFrom
```
public PullRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    mergeFrom in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PullRequest.Builder>
    
    Throws:
    
    IOException
  - getSubscription
```
public 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) = { ... }
    Specified by:
    
    getSubscription in interface PullRequestOrBuilder
    
    Returns:
    
    The subscription.
  - getSubscriptionBytes
```
public com.google.protobuf.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) = { ... }
    Specified by:
    
    getSubscriptionBytes in interface PullRequestOrBuilder
    
    Returns:
    
    The bytes for subscription.
  - setSubscription
```
public PullRequest.Builder setSubscription(String value)
```
```
 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) = { ... }
    Parameters:
    
    value - The subscription to set.
    
    Returns:
    
    This builder for chaining.
  - clearSubscription
```
public PullRequest.Builder clearSubscription()
```
```
 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:
    
    This builder for chaining.
  - setSubscriptionBytes
```
public PullRequest.Builder setSubscriptionBytes(com.google.protobuf.ByteString value)
```
```
 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) = { ... }
    Parameters:
    
    value - The bytes for subscription to set.
    
    Returns:
    
    This builder for chaining.
  - getReturnImmediately
```
@Deprecated
public boolean getReturnImmediately()
```
    Deprecated.
```
 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];
    Specified by:
    
    getReturnImmediately in interface PullRequestOrBuilder
    
    Returns:
    
    The returnImmediately.
  - setReturnImmediately
```
@Deprecated
public PullRequest.Builder setReturnImmediately(boolean value)
```
    Deprecated.
```
 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];
    Parameters:
    
    value - The returnImmediately to set.
    
    Returns:
    
    This builder for chaining.
  - clearReturnImmediately
```
@Deprecated
public PullRequest.Builder clearReturnImmediately()
```
    Deprecated.
```
 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:
    
    This builder for chaining.
  - getMaxMessages
```
public 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];
    Specified by:
    
    getMaxMessages in interface PullRequestOrBuilder
    
    Returns:
    
    The maxMessages.
  - setMaxMessages
```
public PullRequest.Builder setMaxMessages(int value)
```
```
 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];
    Parameters:
    
    value - The maxMessages to set.
    
    Returns:
    
    This builder for chaining.
  - clearMaxMessages
```
public PullRequest.Builder clearMaxMessages()
```
```
 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:
    
    This builder for chaining.
  - setUnknownFields
```
public final PullRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PullRequest.Builder>
  - mergeUnknownFields
```
public final PullRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PullRequest.Builder>

Class PullRequest.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLite.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getSubscription

getSubscriptionBytes

setSubscription

clearSubscription

setSubscriptionBytes

getReturnImmediately

setReturnImmediately

clearReturnImmediately

getMaxMessages

setMaxMessages

clearMaxMessages

setUnknownFields

mergeUnknownFields