com.google.api.services.pubsub.model

Class PullBatchRequest

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.PullBatchRequest

All Implemented Interfaces:

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

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

Request for the PullBatch 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 Google Cloud Pub/Sub API. For a detailed explanation see: http://code.google.com/p/google-http-java-client/wiki/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
PullBatchRequest()

Method Summary

Methods

Modifier and Type	Method and Description
PullBatchRequest	clone()
java.lang.Integer	getMaxEvents() The maximum number of PubsubEvents returned for this request.
java.lang.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.
PullBatchRequest	set(java.lang.String fieldName, java.lang.Object value)
PullBatchRequest	setMaxEvents(java.lang.Integer maxEvents) The maximum number of PubsubEvents returned for this request.
PullBatchRequest	setReturnImmediately(java.lang.Boolean returnImmediately) 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.
PullBatchRequest	setSubscription(java.lang.String subscription) The subscription from which messages should be pulled.

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

Constructor Detail

PullBatchRequest

public PullBatchRequest()

Method Detail

getMaxEvents

public java.lang.Integer getMaxEvents()

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

Returns:

value or null for none

setMaxEvents

public PullBatchRequest setMaxEvents(java.lang.Integer maxEvents)

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

Parameters:

maxEvents - maxEvents or null for none

getReturnImmediately

public java.lang.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. The client may cancel the request if it does not wish to wait any longer for the response.

Returns:

value or null for none

setReturnImmediately

public PullBatchRequest setReturnImmediately(java.lang.Boolean returnImmediately)

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. The client may cancel the request if it does not wish to wait any longer for the response.

Parameters:

returnImmediately - returnImmediately or null for none

getSubscription

public java.lang.String getSubscription()

The subscription from which messages should be pulled.

Returns:

value or null for none

setSubscription

public PullBatchRequest setSubscription(java.lang.String subscription)

The subscription from which messages should be pulled.

Parameters:

subscription - subscription or null for none

set

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

Overrides:

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

clone

public PullBatchRequest clone()

Overrides:

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