com.google.pubsub.v1

Class PullRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.pubsub.v1.PullRequest

All Implemented Interfaces:

Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, PullRequestOrBuilder, java.io.Serializable

public final class PullRequest
extends GeneratedMessage
implements PullRequestOrBuilder

Protobuf type google.pubsub.v1.PullRequest

 Request for the `Pull` method.
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PullRequest.Builder Protobuf type google.pubsub.v1.PullRequest

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

GeneratedMessage.ExtendableBuilder<MessageType extends GeneratedMessage.ExtendableMessage,BuilderType extends GeneratedMessage.ExtendableBuilder>, GeneratedMessage.ExtendableMessage<MessageType extends GeneratedMessage.ExtendableMessage>, GeneratedMessage.ExtendableMessageOrBuilder<MessageType extends GeneratedMessage.ExtendableMessage>, GeneratedMessage.FieldAccessorTable, GeneratedMessage.GeneratedExtension<ContainingType extends Message,Type>

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_MESSAGES_FIELD_NUMBER
static int	RETURN_IMMEDIATELY_FIELD_NUMBER
static int	SUBSCRIPTION_FIELD_NUMBER

Method Summary

Modifier and Type	Method and Description
static PullRequest	getDefaultInstance()
PullRequest	getDefaultInstanceForType() Get an instance of the type with no fields set.
static Descriptors.Descriptor	getDescriptor()
int	getMaxMessages() The maximum number of messages returned for this request.
Parser<PullRequest>	getParserForType() Gets the parser for a message of the same type as this message.
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.
int	getSerializedSize() Get the number of bytes required to encode this message.
java.lang.String	getSubscription() The subscription from which messages should be pulled.
ByteString	getSubscriptionBytes() The subscription from which messages should be pulled.
UnknownFieldSet	getUnknownFields() Get the UnknownFieldSet for this message.
boolean	isInitialized() Returns true if all required fields in the message and all embedded messages are set, false otherwise.
static PullRequest.Builder	newBuilder()
static PullRequest.Builder	newBuilder(PullRequest prototype)
PullRequest.Builder	newBuilderForType() Constructs a new builder for a message of the same type as this message.
static PullRequest	parseDelimitedFrom(java.io.InputStream input)
static PullRequest	parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static PullRequest	parseFrom(byte[] data)
static PullRequest	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static PullRequest	parseFrom(ByteString data)
static PullRequest	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static PullRequest	parseFrom(CodedInputStream input)
static PullRequest	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static PullRequest	parseFrom(java.io.InputStream input)
static PullRequest	parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<PullRequest>	parser()
PullRequest.Builder	toBuilder() Constructs a builder initialized with the current message.
void	writeTo(CodedOutputStream output) Serializes the message and writes it to output.

Methods inherited from class com.google.protobuf.GeneratedMessage

getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, newFileScopedGeneratedExtension, newFileScopedGeneratedExtension, newMessageScopedGeneratedExtension, newMessageScopedGeneratedExtension

Methods inherited from class com.google.protobuf.AbstractMessage

equals, findInitializationErrors, getInitializationErrorString, hashCode, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

SUBSCRIPTION_FIELD_NUMBER

public static final int SUBSCRIPTION_FIELD_NUMBER

See Also:

Constant Field Values

RETURN_IMMEDIATELY_FIELD_NUMBER

public static final int RETURN_IMMEDIATELY_FIELD_NUMBER

See Also:

Constant Field Values

MAX_MESSAGES_FIELD_NUMBER

public static final int MAX_MESSAGES_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Description copied from interface: MessageOrBuilder

Get the UnknownFieldSet for this message.

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessage

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

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

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

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

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

writeTo

public void writeTo(CodedOutputStream output)
             throws java.io.IOException

Description copied from interface: MessageLite

Serializes the message and writes it to output. This does not flush or close the stream.

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessage

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Description copied from interface: MessageLite

Get the number of bytes required to encode this message. The result is only computed on the first call and memoized after that.

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessage

parseFrom

public static PullRequest parseFrom(ByteString data)
                             throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PullRequest parseFrom(ByteString data,
                                    ExtensionRegistryLite extensionRegistry)
                             throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PullRequest parseFrom(byte[] data)
                             throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PullRequest parseFrom(byte[] data,
                                    ExtensionRegistryLite extensionRegistry)
                             throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PullRequest parseFrom(java.io.InputStream input)
                             throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static PullRequest parseFrom(java.io.InputStream input,
                                    ExtensionRegistryLite extensionRegistry)
                             throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static PullRequest parseDelimitedFrom(java.io.InputStream input)
                                      throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static PullRequest parseDelimitedFrom(java.io.InputStream input,
                                             ExtensionRegistryLite extensionRegistry)
                                      throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static PullRequest parseFrom(CodedInputStream input)
                             throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static PullRequest parseFrom(CodedInputStream input,
                                    ExtensionRegistryLite extensionRegistry)
                             throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public PullRequest.Builder newBuilderForType()

Description copied from interface: MessageLite

Constructs a new builder for a message of the same type as this message.

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static PullRequest.Builder newBuilder()

newBuilder

public static PullRequest.Builder newBuilder(PullRequest prototype)

toBuilder

public PullRequest.Builder toBuilder()

Description copied from interface: MessageLite

Constructs a builder initialized with the current message. Use this to derive a new message from the current one.

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

getDefaultInstance

public static PullRequest getDefaultInstance()

parser

public static Parser<PullRequest> parser()

getParserForType

public Parser<PullRequest> getParserForType()

Description copied from interface: MessageLite

Gets the parser for a message of the same type as this message.

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessage

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