com.google.api.services.pubsub.model

Class PullRequest

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.pubsub.model.PullRequest

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class PullRequest
extends com.google.api.client.json.GenericJson

Request for the `Pull` method.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Pub/Sub API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
PullRequest()

Method Summary

Modifier and Type	Method and Description
PullRequest	clone()
java.lang.Integer	getMaxMessages() Required.
java.lang.Boolean	getReturnImmediately() Optional.
PullRequest	set(java.lang.String fieldName, java.lang.Object value)
PullRequest	setMaxMessages(java.lang.Integer maxMessages) Required.
PullRequest	setReturnImmediately(java.lang.Boolean returnImmediately) Optional.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

PullRequest

public PullRequest()

Method Detail

getMaxMessages

public java.lang.Integer 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.

Returns:

value or null for none

setMaxMessages

public PullRequest setMaxMessages(java.lang.Integer maxMessages)

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.

Parameters:

maxMessages - maxMessages or null for none

getReturnImmediately

public java.lang.Boolean getReturnImmediately()

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.

Returns:

value or null for none

setReturnImmediately

public PullRequest setReturnImmediately(java.lang.Boolean returnImmediately)

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.

Parameters:

returnImmediately - returnImmediately or null for none

set

public PullRequest set(java.lang.String fieldName,
                       java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public PullRequest clone()

Overrides:

clone in class com.google.api.client.json.GenericJson