Class PullRequest (1.131.0)

public final class PullRequest extends GeneratedMessageV3 implements PullRequestOrBuilder

Request for the Pull method.

Protobuf type google.pubsub.v1.PullRequest

Static Fields

MAX_MESSAGES_FIELD_NUMBER

public static final int MAX_MESSAGES_FIELD_NUMBER
Field Value
Type Description
int

RETURN_IMMEDIATELY_FIELD_NUMBER

public static final int RETURN_IMMEDIATELY_FIELD_NUMBER
Field Value
Type Description
int

SUBSCRIPTION_FIELD_NUMBER

public static final int SUBSCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PullRequest getDefaultInstance()
Returns
Type Description
PullRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PullRequest.Builder newBuilder()
Returns
Type Description
PullRequest.Builder

newBuilder(PullRequest prototype)

public static PullRequest.Builder newBuilder(PullRequest prototype)
Parameter
Name Description
prototype PullRequest
Returns
Type Description
PullRequest.Builder

parseDelimitedFrom(InputStream input)

public static PullRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PullRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PullRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PullRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PullRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PullRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PullRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PullRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PullRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PullRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PullRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PullRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PullRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PullRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PullRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PullRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PullRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PullRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PullRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PullRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PullRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PullRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PullRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PullRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PullRequest> parser()
Returns
Type Description
Parser<PullRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public PullRequest getDefaultInstanceForType()
Returns
Type Description
PullRequest

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];

Returns
Type Description
int

The maxMessages.

getParserForType()

public Parser<PullRequest> getParserForType()
Returns
Type Description
Parser<PullRequest>
Overrides

getReturnImmediately() (deprecated)

public boolean getReturnImmediately()

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

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
boolean

The returnImmediately.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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) = { ... }

Returns
Type Description
String

The subscription.

getSubscriptionBytes()

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

The bytes for subscription.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PullRequest.Builder newBuilderForType()
Returns
Type Description
PullRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PullRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PullRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PullRequest.Builder toBuilder()
Returns
Type Description
PullRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException