Class PullRequest (1.121.1)
Version 1.121.1keyboard_arrow_down
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
public static final int RETURN_IMMEDIATELY_FIELD_NUMBER
Field Value
SUBSCRIPTION_FIELD_NUMBER
public static final int SUBSCRIPTION_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static PullRequest getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static PullRequest . Builder newBuilder ()
Returns
newBuilder(PullRequest prototype)
public static PullRequest . Builder newBuilder ( PullRequest prototype )
Parameter
Returns
public static PullRequest parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static PullRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static PullRequest parseFrom ( byte [] data )
Parameter
Name Description
data byte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PullRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static PullRequest parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PullRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static PullRequest parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static PullRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static PullRequest parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static PullRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static PullRequest parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PullRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<PullRequest> parser ()
Returns
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
Overrides
getDefaultInstanceForType()
public PullRequest getDefaultInstanceForType ()
Returns
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
Overrides
public boolean getReturnImmediately ()
Deprecated. google.pubsub.v1.PullRequest.return_immediately is deprecated. See
google/pubsub/v1/pubsub.proto;l=1107
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
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.
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public PullRequest . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PullRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public PullRequest . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
