com.google.cloud.pubsub

Class PubSub.PullOption

java.lang.Object

com.google.cloud.pubsub.PubSub.PullOption

All Implemented Interfaces:

Serializable

Enclosing interface:

PubSub

public static final class PubSub.PullOption
extends Object

Class for specifying options for pulling messages.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
static PubSub.PullOption	executorFactory(GrpcServiceOptions.ExecutorFactory executorFactory) Returns an option to specify the executor used to execute message processor callbacks.
int	hashCode()
static PubSub.PullOption	maxQueuedCallbacks(int maxQueuedCallbacks) Returns an option to specify the maximum number of messages that can be queued in the message consumer at any time.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

maxQueuedCallbacks

public static PubSub.PullOption maxQueuedCallbacks(int maxQueuedCallbacks)

Returns an option to specify the maximum number of messages that can be queued in the message consumer at any time. Queued messages are already pulled messages that are either waiting to be processed or being processed. Queued messages will have their acknowledge deadline renewed until they are acknowledged or "nacked". If not provided, at most 100 messages can be in the queue.

executorFactory

public static PubSub.PullOption executorFactory(GrpcServiceOptions.ExecutorFactory executorFactory)

Returns an option to specify the executor used to execute message processor callbacks. The executor determines the number of messages that can be processed at the same time. If not provided, a single-threaded executor is used to execute message processor callbacks.

The GrpcServiceOptions.ExecutorFactory object can be used to handle creation and release of the executor, possibly reusing existing executors. GrpcServiceOptions.ExecutorFactory.get() is called when the message consumer is created. GrpcServiceOptions.ExecutorFactory.release(ExecutorService) is called when the message consumer is closed.

For the created option to be serializable, the provided executor factory should implement Serializable.

Parameters:

executorFactory - the executor factory.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object