com.google.api.services.pubsub.model

Class Subscription

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

All Implemented Interfaces:

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

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

A subscription resource.

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: 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
Subscription()

Method Summary

Methods

Modifier and Type	Method and Description
Subscription	clone()
java.lang.Integer	getAckDeadlineSeconds() This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message.
java.lang.String	getName() The name of the subscription.
PushConfig	getPushConfig() If push delivery is used with this subscription, this field is used to configure it.
java.lang.String	getTopic() The name of the topic from which this subscription is receiving messages.
Subscription	set(java.lang.String fieldName, java.lang.Object value)
Subscription	setAckDeadlineSeconds(java.lang.Integer ackDeadlineSeconds) This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message.
Subscription	setName(java.lang.String name) The name of the subscription.
Subscription	setPushConfig(PushConfig pushConfig) If push delivery is used with this subscription, this field is used to configure it.
Subscription	setTopic(java.lang.String topic) The name of the topic from which this subscription is receiving messages.

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

Subscription

public Subscription()

Method Detail

getAckDeadlineSeconds

public java.lang.Integer getAckDeadlineSeconds()

This value is 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 this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using pull. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. If this parameter is not set, the default value of 10 seconds is used.

Returns:

value or null for none

setAckDeadlineSeconds

public Subscription setAckDeadlineSeconds(java.lang.Integer ackDeadlineSeconds)

This value is 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 this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using pull. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. If this parameter is not set, the default value of 10 seconds is used.

Parameters:

ackDeadlineSeconds - ackDeadlineSeconds or null for none

getName

public java.lang.String getName()

The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` 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 it must not start with `"goog"`.

Returns:

value or null for none

setName

public Subscription setName(java.lang.String name)

The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` 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 it must not start with `"goog"`.

Parameters:

name - name or null for none

getPushConfig

public PushConfig getPushConfig()

If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods.

Returns:

value or null for none

setPushConfig

public Subscription setPushConfig(PushConfig pushConfig)

If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods.

Parameters:

pushConfig - pushConfig or null for none

getTopic

public java.lang.String getTopic()

The name of the topic from which this subscription is receiving messages. The value of this field will be `_deleted-topic_` if the topic has been deleted.

Returns:

value or null for none

setTopic

public Subscription setTopic(java.lang.String topic)

The name of the topic from which this subscription is receiving messages. The value of this field will be `_deleted-topic_` if the topic has been deleted.

Parameters:

topic - topic or null for none

set

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

Overrides:

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

clone

public Subscription clone()

Overrides:

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