com.google.pubsub.v1

Class PullRequest.Builder

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, java.lang.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

Modifier and Type	Method and Description
PullRequest.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
PullRequest	build()
PullRequest	buildPartial()
PullRequest.Builder	clear()
PullRequest.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
PullRequest.Builder	clearMaxMessages() The maximum number of messages returned for this request.
PullRequest.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
PullRequest.Builder	clearReturnImmediately() 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.
PullRequest.Builder	clearSubscription() The subscription from which messages should be pulled.
PullRequest.Builder	clone()
PullRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
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.
SubscriptionName	getSubscriptionAsSubscriptionName()
com.google.protobuf.ByteString	getSubscriptionBytes() The subscription from which messages should be pulled.
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, java.lang.Object value)
PullRequest.Builder	setMaxMessages(int value) The maximum number of messages returned for this request.
PullRequest.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
PullRequest.Builder	setReturnImmediately(boolean value) 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.
PullRequest.Builder	setSubscription(java.lang.String value) The subscription from which messages should be pulled.
PullRequest.Builder	setSubscriptionBytes(com.google.protobuf.ByteString value) The subscription from which messages should be pulled.
PullRequest.Builder	setSubscriptionWithSubscriptionName(SubscriptionName value)
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, parseUnknownField

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, 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,
                                    java.lang.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,
                                            java.lang.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,
                                            java.lang.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 java.io.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:

java.io.IOException

getSubscription

public java.lang.String getSubscription()

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

optional string subscription = 1;

Specified by:

getSubscription in interface PullRequestOrBuilder

getSubscriptionBytes

public com.google.protobuf.ByteString getSubscriptionBytes()

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

optional string subscription = 1;

Specified by:

getSubscriptionBytes in interface PullRequestOrBuilder

setSubscription

public PullRequest.Builder setSubscription(java.lang.String value)

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

optional string subscription = 1;

clearSubscription

public PullRequest.Builder clearSubscription()

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

optional string subscription = 1;

setSubscriptionBytes

public PullRequest.Builder setSubscriptionBytes(com.google.protobuf.ByteString value)

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

optional string subscription = 1;

getReturnImmediately

public 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.
 

optional bool return_immediately = 2;

Specified by:

getReturnImmediately in interface PullRequestOrBuilder

setReturnImmediately

public PullRequest.Builder setReturnImmediately(boolean value)

 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.
 

optional bool return_immediately = 2;

clearReturnImmediately

public PullRequest.Builder clearReturnImmediately()

 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.
 

optional bool return_immediately = 2;

getMaxMessages

public int getMaxMessages()

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

optional int32 max_messages = 3;

Specified by:

getMaxMessages in interface PullRequestOrBuilder

setMaxMessages

public PullRequest.Builder setMaxMessages(int value)

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

optional int32 max_messages = 3;

clearMaxMessages

public PullRequest.Builder clearMaxMessages()

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

optional int32 max_messages = 3;

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>

setSubscriptionWithSubscriptionName

public final PullRequest.Builder setSubscriptionWithSubscriptionName(SubscriptionName value)

getSubscriptionAsSubscriptionName

public final SubscriptionName getSubscriptionAsSubscriptionName()