com.google.cloud.pubsub

Class SubscriptionInfo.Builder

java.lang.Object

com.google.cloud.pubsub.SubscriptionInfo.Builder

Direct Known Subclasses:

Subscription.Builder

Enclosing class:

SubscriptionInfo

public abstract static class SubscriptionInfo.Builder
extends Object

Builder for SubscriptionInfo objects.

Constructor Summary

Constructors

Constructor and Description
SubscriptionInfo.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
abstract SubscriptionInfo.Builder	ackDeadLineSeconds(int ackDeadLineSeconds) Sets the maximum time after a subscriber receives a message before the subscriber should acknowledge the message.
abstract SubscriptionInfo	build() Creates a subscription object.
abstract SubscriptionInfo.Builder	name(String name) Sets the name of the subscription.
abstract SubscriptionInfo.Builder	pushConfig(PushConfig pushConfig) Sets the push configuration for the subscription.
abstract SubscriptionInfo.Builder	topic(String topic) Sets the topic the subscription refers to, given the topic name.
abstract SubscriptionInfo.Builder	topic(String project, String topic) Sets the topic the subscription refers to, given the project and topic names.
abstract SubscriptionInfo.Builder	topic(TopicId topic) Sets the topic the subscription refers to, given the topic identity.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SubscriptionInfo.Builder

public SubscriptionInfo.Builder()

Method Detail

name

public abstract SubscriptionInfo.Builder name(String name)

Sets the name of the subscription. The name must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9]), dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length and cannot begin with the string goog.

topic

public abstract SubscriptionInfo.Builder topic(String topic)

Sets the topic the subscription refers to, given the topic name. The topic is assumed to reside in the ServiceOptions.projectId() project.

topic

public abstract SubscriptionInfo.Builder topic(String project,
                             String topic)

Sets the topic the subscription refers to, given the project and topic names.

topic

public abstract SubscriptionInfo.Builder topic(TopicId topic)

Sets the topic the subscription refers to, given the topic identity. If topic.project() is null the topic is assumed to reside in the ServiceOptions.projectId() project.

pushConfig

public abstract SubscriptionInfo.Builder pushConfig(PushConfig pushConfig)

Sets the push configuration for the subscription. If set, the subscription will be in push mode and the pushConfig parameter provides the push endpoint. If not set, the subscription will be in pull mode.

ackDeadLineSeconds

public abstract SubscriptionInfo.Builder ackDeadLineSeconds(int ackDeadLineSeconds)

Sets the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override the ack deadline value for a given message, use PubSub.modifyAckDeadline(String, int, TimeUnit, Iterable). For push delivery, this value is used to set the request timeout for the call to the push endpoint. This value must be between 10 and 600 seconds, if not specified, 10 seconds is used.

build

public abstract SubscriptionInfo build()

Creates a subscription object.