com.google.cloud.pubsub

Class Subscription.Builder

java.lang.Object

com.google.cloud.pubsub.SubscriptionInfo.Builder

com.google.cloud.pubsub.Subscription.Builder

Enclosing class:

Subscription

public static final class Subscription.Builder
extends SubscriptionInfo.Builder

A builder for Subscription objects.

Method Summary

Methods

Modifier and Type	Method and Description
Subscription.Builder	ackDeadLineSeconds(int ackDeadLineSeconds) Sets the maximum time after a subscriber receives a message before the subscriber should acknowledge the message.
Subscription	build() Creates a subscription object.
Subscription.Builder	name(String name) Sets the name of the subscription.
Subscription.Builder	pushConfig(PushConfig pushConfig) Sets the push configuration for the subscription.
Subscription.Builder	topic(String topic) Sets the topic the subscription refers to, given the topic name.
Subscription.Builder	topic(String project, String topic) Sets the topic the subscription refers to, given the project and topic names.
Subscription.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

Method Detail

topic

public Subscription.Builder topic(TopicId topic)

Description copied from class: SubscriptionInfo.Builder

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.

Specified by:

topic in class SubscriptionInfo.Builder

topic

public Subscription.Builder topic(String project,
                         String topic)

Description copied from class: SubscriptionInfo.Builder

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

Specified by:

topic in class SubscriptionInfo.Builder

topic

public Subscription.Builder topic(String topic)

Description copied from class: SubscriptionInfo.Builder

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

Specified by:

topic in class SubscriptionInfo.Builder

name

public Subscription.Builder name(String name)

Description copied from class: SubscriptionInfo.Builder

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.

Specified by:

name in class SubscriptionInfo.Builder

pushConfig

public Subscription.Builder pushConfig(PushConfig pushConfig)

Description copied from class: SubscriptionInfo.Builder

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.

Specified by:

pushConfig in class SubscriptionInfo.Builder

ackDeadLineSeconds

public Subscription.Builder ackDeadLineSeconds(int ackDeadLineSeconds)

Description copied from class: SubscriptionInfo.Builder

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.

Specified by:

ackDeadLineSeconds in class SubscriptionInfo.Builder

build

public Subscription build()

Description copied from class: SubscriptionInfo.Builder

Creates a subscription object.

Specified by:

build in class SubscriptionInfo.Builder