Subscription (Cloud Pub/Sub API v1 (Rev. 452) 1.25.0)

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

Constructors
Constructor and Description
`Subscription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Subscription`	`clone()`
`java.lang.Integer`	`getAckDeadlineSeconds()` The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message.
`DeadLetterPolicy`	`getDeadLetterPolicy()` A policy that specifies the conditions for dead lettering messages in this subscription.
`ExpirationPolicy`	`getExpirationPolicy()` A policy that specifies the conditions for this subscription's expiration.
`java.util.Map<java.lang.String,java.lang.String>`	`getLabels()` See Creating and managing labels.
`java.lang.String`	`getMessageRetentionDuration()` How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.
`java.lang.String`	`getName()` Required.
`PushConfig`	`getPushConfig()` If push delivery is used with this subscription, this field is used to configure it.
`java.lang.Boolean`	`getRetainAckedMessages()` Indicates whether to retain acknowledged messages.
`java.lang.String`	`getTopic()` Required.
`Subscription`	`set(java.lang.String fieldName, java.lang.Object value)`
`Subscription`	`setAckDeadlineSeconds(java.lang.Integer ackDeadlineSeconds)` The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message.
`Subscription`	`setDeadLetterPolicy(DeadLetterPolicy deadLetterPolicy)` A policy that specifies the conditions for dead lettering messages in this subscription.
`Subscription`	`setExpirationPolicy(ExpirationPolicy expirationPolicy)` A policy that specifies the conditions for this subscription's expiration.
`Subscription`	`setLabels(java.util.Map<java.lang.String,java.lang.String> labels)` See Creating and managing labels.
`Subscription`	`setMessageRetentionDuration(java.lang.String messageRetentionDuration)` How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.
`Subscription`	`setName(java.lang.String name)` Required.
`Subscription`	`setPushConfig(PushConfig pushConfig)` If push delivery is used with this subscription, this field is used to configure it.
`Subscription`	`setRetainAckedMessages(java.lang.Boolean retainAckedMessages)` Indicates whether to retain acknowledged messages.
`Subscription`	`setTopic(java.lang.String topic)` Required.

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

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Subscription
```
public Subscription()
```
- Method Detail
  - getAckDeadlineSeconds
```
public java.lang.Integer getAckDeadlineSeconds()
```
    The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be outstanding. During that time period, the message will not be redelivered (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 non-streaming pull or send the `ack_id` in a `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. 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.
    
    Returns:
    
    value or null for none
  - setAckDeadlineSeconds
```
public Subscription setAckDeadlineSeconds(java.lang.Integer ackDeadlineSeconds)
```
    The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be outstanding. During that time period, the message will not be redelivered (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 non-streaming pull or send the `ack_id` in a `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. 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.
    
    Parameters:
    
    ackDeadlineSeconds - ackDeadlineSeconds or null for none
  - getDeadLetterPolicy
```
public DeadLetterPolicy getDeadLetterPolicy()
```
    A policy that specifies the conditions for dead lettering messages in this subscription. If dead_letter_policy is not set, dead lettering is disabled. The Cloud Pub/Sub service account associated with this subscriptions's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription. EXPERIMENTAL: This feature is part of a closed alpha release. This API might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
    
    Returns:
    
    value or null for none
  - setDeadLetterPolicy
```
public Subscription setDeadLetterPolicy(DeadLetterPolicy deadLetterPolicy)
```
    A policy that specifies the conditions for dead lettering messages in this subscription. If dead_letter_policy is not set, dead lettering is disabled. The Cloud Pub/Sub service account associated with this subscriptions's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription. EXPERIMENTAL: This feature is part of a closed alpha release. This API might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
    
    Parameters:
    
    deadLetterPolicy - deadLetterPolicy or null for none
  - getExpirationPolicy
```
public ExpirationPolicy getExpirationPolicy()
```
    A policy that specifies the conditions for this subscription's expiration. A subscription is considered active as long as any connected subscriber is successfully consuming messages from the subscription or is issuing operations on the subscription. If `expiration_policy` is not set, a *default policy* with `ttl` of 31 days will be used. The minimum allowed value for `expiration_policy.ttl` is 1 day.
    
    Returns:
    
    value or null for none
  - setExpirationPolicy
```
public Subscription setExpirationPolicy(ExpirationPolicy expirationPolicy)
```
    A policy that specifies the conditions for this subscription's expiration. A subscription is considered active as long as any connected subscriber is successfully consuming messages from the subscription or is issuing operations on the subscription. If `expiration_policy` is not set, a *default policy* with `ttl` of 31 days will be used. The minimum allowed value for `expiration_policy.ttl` is 1 day.
    
    Parameters:
    
    expirationPolicy - expirationPolicy or null for none
  - getLabels
```
public java.util.Map<java.lang.String,java.lang.String> getLabels()
```
    See Creating and managing labels.
    
    Returns:
    
    value or null for none
  - setLabels
```
public Subscription setLabels(java.util.Map<java.lang.String,java.lang.String> labels)
```
    See Creating and managing labels.
    
    Parameters:
    
    labels - labels or null for none
  - getMessageRetentionDuration
```
public java.lang.String getMessageRetentionDuration()
```
    How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes.
    
    Returns:
    
    value or null for none
  - setMessageRetentionDuration
```
public Subscription setMessageRetentionDuration(java.lang.String messageRetentionDuration)
```
    How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes.
    
    Parameters:
    
    messageRetentionDuration - messageRetentionDuration or null for none
  - getName
```
public java.lang.String getName()
```
    Required. 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)
```
    Required. 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
  - getRetainAckedMessages
```
public java.lang.Boolean getRetainAckedMessages()
```
    Indicates whether to retain acknowledged messages. If true, then messages are not expunged from the subscription's backlog, even if they are acknowledged, until they fall out of the `message_retention_duration` window. This must be true if you would like to Seek to a timestamp.
    
    Returns:
    
    value or null for none
  - setRetainAckedMessages
```
public Subscription setRetainAckedMessages(java.lang.Boolean retainAckedMessages)
```
    Indicates whether to retain acknowledged messages. If true, then messages are not expunged from the subscription's backlog, even if they are acknowledged, until they fall out of the `message_retention_duration` window. This must be true if you would like to Seek to a timestamp.
    
    Parameters:
    
    retainAckedMessages - retainAckedMessages or null for none
  - getTopic
```
public java.lang.String getTopic()
```
    Required. The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. 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)
```
    Required. The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. 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

Cloud Pub/Sub API v1 (revision 452)

Class Subscription

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Subscription

Method Detail

getAckDeadlineSeconds

setAckDeadlineSeconds

getDeadLetterPolicy

setDeadLetterPolicy

getExpirationPolicy

setExpirationPolicy

getLabels

setLabels

getMessageRetentionDuration

setMessageRetentionDuration

getName

setName

getPushConfig

setPushConfig

getRetainAckedMessages

setRetainAckedMessages

getTopic

setTopic

set

clone