com.google.pubsub.v1

Class PullRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder<BuilderType>

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessage.Builder<PullRequest.Builder>

com.google.pubsub.v1.PullRequest.Builder

All Implemented Interfaces:

Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, PullRequestOrBuilder, java.lang.Cloneable

Enclosing class:

PullRequest

public static final class PullRequest.Builder
extends GeneratedMessage.Builder<PullRequest.Builder>
implements PullRequestOrBuilder

Protobuf type google.pubsub.v1.PullRequest

 Request for the `Pull` method.
 

Method Summary

Modifier and Type	Method and Description
PullRequest	build() Constructs the message based on the state of the Builder.
PullRequest	buildPartial() Like MessageLite.Builder.build(), but does not throw an exception if the message is missing required fields.
PullRequest.Builder	clear() Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.
PullRequest.Builder	clearMaxMessages() The maximum number of messages returned for this request.
PullRequest.Builder	clearReturnImmediately() If this is specified as true the system will respond immediately even if it is not able to return a message in the `Pull` response.
PullRequest.Builder	clearSubscription() The subscription from which messages should be pulled.
PullRequest	getDefaultInstanceForType() Get an instance of the type with no fields set.
static Descriptors.Descriptor	getDescriptor()
Descriptors.Descriptor	getDescriptorForType() Get the message's type's descriptor.
int	getMaxMessages() The maximum number of messages returned for this request.
boolean	getReturnImmediately() If this is specified as true the system will respond immediately even if it is not able to return a message in the `Pull` response.
java.lang.String	getSubscription() The subscription from which messages should be pulled.
ByteString	getSubscriptionBytes() The subscription from which messages should be pulled.
boolean	isInitialized() Returns true if all required fields in the message and all embedded messages are set, false otherwise.
PullRequest.Builder	mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) Like MessageLite.Builder.mergeFrom(CodedInputStream), but also parses extensions.
PullRequest.Builder	mergeFrom(Message other) Merge other into the message being built.
PullRequest.Builder	mergeFrom(PullRequest other)
PullRequest.Builder	mergeUnknownFields(UnknownFieldSet unknownFields) Merge some unknown fields into the UnknownFieldSet for this message.
PullRequest.Builder	setMaxMessages(int value) The maximum number of messages returned for this request.
PullRequest.Builder	setReturnImmediately(boolean value) If this is specified as true the system will respond immediately even if it is not able to return a message in the `Pull` response.
PullRequest.Builder	setSubscription(java.lang.String value) The subscription from which messages should be pulled.
PullRequest.Builder	setSubscriptionBytes(ByteString value) The subscription from which messages should be pulled.
PullRequest.Builder	setUnknownFields(UnknownFieldSet unknownFields) Set the UnknownFieldSet for this message.

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

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, newBuilderForField, setField, setRepeatedField

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

findInitializationErrors, getInitializationErrorString, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, toString

Methods inherited from class java.lang.Object

equals, 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

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

clear

public PullRequest.Builder clear()

Description copied from class: GeneratedMessage.Builder

Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.

Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessage.Builder<PullRequest.Builder>

getDescriptorForType

public Descriptors.Descriptor getDescriptorForType()

Description copied from interface: Message.Builder

Get the message's type's descriptor. See MessageOrBuilder.getDescriptorForType().

Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessage.Builder<PullRequest.Builder>

getDefaultInstanceForType

public PullRequest getDefaultInstanceForType()

Description copied from interface: MessageLiteOrBuilder

Get an instance of the type with no fields set. Because no fields are set, all getters for singular fields will return default values and repeated fields will appear empty. This may or may not be a singleton. This differs from the getDefaultInstance() method of generated message classes in that this method is an abstract method of the MessageLite interface whereas getDefaultInstance() is a static method of a specific class. They return the same thing.

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build

public PullRequest build()

Description copied from interface: MessageLite.Builder

Constructs the message based on the state of the Builder. Subsequent changes to the Builder will not affect the returned message.

Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial

public PullRequest buildPartial()

Description copied from interface: MessageLite.Builder

Like MessageLite.Builder.build(), but does not throw an exception if the message is missing required fields. Instead, a partial message is returned. Subsequent changes to the Builder will not affect the returned message.

Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

mergeFrom

public PullRequest.Builder mergeFrom(Message other)

Description copied from interface: Message.Builder

Merge other into the message being built. other must have the exact same type as this (i.e. getDescriptorForType() == other.getDescriptorForType()). Merging occurs as follows. For each field:
* For singular primitive fields, if the field is set in other, then other's value overwrites the value in this message.
* For singular message fields, if the field is set in other, it is merged into the corresponding sub-message of this message using the same merging rules.
* For repeated fields, the elements in other are concatenated with the elements in this message. * For oneof groups, if the other message has one of the fields set, the group of this message is cleared and replaced by the field of the other message, so that the oneof constraint is preserved. This is equivalent to the Message::MergeFrom method in C++.

Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<PullRequest.Builder>

mergeFrom

public PullRequest.Builder mergeFrom(PullRequest other)

isInitialized

public final boolean isInitialized()

Description copied from interface: MessageLiteOrBuilder

Returns true if all required fields in the message and all embedded messages are set, false otherwise.

See also: MessageOrBuilder.getInitializationErrorString()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessage.Builder<PullRequest.Builder>

mergeFrom

public PullRequest.Builder mergeFrom(CodedInputStream input,
                                     ExtensionRegistryLite extensionRegistry)
                              throws java.io.IOException

Description copied from interface: MessageLite.Builder

Like MessageLite.Builder.mergeFrom(CodedInputStream), but also parses extensions. The extensions that you want to be able to parse must be registered in extensionRegistry. Extensions not in the registry will be treated as unknown fields.

Specified by:

mergeFrom in interface Message.Builder

Specified by:

mergeFrom in interface MessageLite.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<PullRequest.Builder>

Throws:

java.io.IOException

getSubscription

public java.lang.String getSubscription()

 The subscription from which messages should be pulled.
 

Specified by:

getSubscription in interface PullRequestOrBuilder

getSubscriptionBytes

public ByteString getSubscriptionBytes()

 The subscription from which messages should be pulled.
 

Specified by:

getSubscriptionBytes in interface PullRequestOrBuilder

setSubscription

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

 The subscription from which messages should be pulled.
 

clearSubscription

public PullRequest.Builder clearSubscription()

 The subscription from which messages should be pulled.
 

setSubscriptionBytes

public PullRequest.Builder setSubscriptionBytes(ByteString value)

 The subscription from which messages should be pulled.
 

getReturnImmediately

public boolean getReturnImmediately()

 If this is specified as true the system will respond immediately even if
 it is not able to return a message in the `Pull` response. Otherwise the
 system is allowed to wait until at least one message is available rather
 than returning no messages.
 

Specified by:

getReturnImmediately in interface PullRequestOrBuilder

setReturnImmediately

public PullRequest.Builder setReturnImmediately(boolean value)

 If this is specified as true the system will respond immediately even if
 it is not able to return a message in the `Pull` response. Otherwise the
 system is allowed to wait until at least one message is available rather
 than returning no messages.
 

clearReturnImmediately

public PullRequest.Builder clearReturnImmediately()

 If this is specified as true the system will respond immediately even if
 it is not able to return a message in the `Pull` response. Otherwise the
 system is allowed to wait until at least one message is available rather
 than returning no messages.
 

getMaxMessages

public int getMaxMessages()

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

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.
 

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.
 

setUnknownFields

public final PullRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Description copied from interface: Message.Builder

Set the UnknownFieldSet for this message.

Specified by:

setUnknownFields in interface Message.Builder

Overrides:

setUnknownFields in class GeneratedMessage.Builder<PullRequest.Builder>

mergeUnknownFields

public final PullRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Description copied from interface: Message.Builder

Merge some unknown fields into the UnknownFieldSet for this message.

Specified by:

mergeUnknownFields in interface Message.Builder

Overrides:

mergeUnknownFields in class GeneratedMessage.Builder<PullRequest.Builder>