Subscription.Builder (proto-google-cloud-pubsub-v1 1.60.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>
    - - com.google.pubsub.v1.Subscription.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SubscriptionOrBuilder, Cloneable

Enclosing class:

Subscription
```
public static final class Subscription.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>
implements SubscriptionOrBuilder
```
```
 A subscription resource.
 
```
Protobuf type google.pubsub.v1.Subscription

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Subscription.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Subscription`	`build()`
`Subscription`	`buildPartial()`
`Subscription.Builder`	`clear()`
`Subscription.Builder`	`clearAckDeadlineSeconds()` The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message.
`Subscription.Builder`	`clearEnableMessageOrdering()` If true, messages published with the same `ordering_key` in `PubsubMessage` will be delivered to the subscribers in the order in which they are received by the Pub/Sub system.
`Subscription.Builder`	`clearExpirationPolicy()` A policy that specifies the conditions for this subscription's expiration.
`Subscription.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`Subscription.Builder`	`clearLabels()`
`Subscription.Builder`	`clearMessageRetentionDuration()` How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.
`Subscription.Builder`	`clearName()` The name of the subscription.
`Subscription.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`Subscription.Builder`	`clearPushConfig()` If push delivery is used with this subscription, this field is used to configure it.
`Subscription.Builder`	`clearRetainAckedMessages()` Indicates whether to retain acknowledged messages.
`Subscription.Builder`	`clearTopic()` The name of the topic from which this subscription is receiving messages.
`Subscription.Builder`	`clone()`
`boolean`	`containsLabels(String key)` See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>.
`int`	`getAckDeadlineSeconds()` The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message.
`Subscription`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`boolean`	`getEnableMessageOrdering()` If true, messages published with the same `ordering_key` in `PubsubMessage` will be delivered to the subscribers in the order in which they are received by the Pub/Sub system.
`ExpirationPolicy`	`getExpirationPolicy()` A policy that specifies the conditions for this subscription's expiration.
`ExpirationPolicy.Builder`	`getExpirationPolicyBuilder()` A policy that specifies the conditions for this subscription's expiration.
`ExpirationPolicyOrBuilder`	`getExpirationPolicyOrBuilder()` A policy that specifies the conditions for this subscription's expiration.
`Map<String,String>`	`getLabels()` Deprecated.
`int`	`getLabelsCount()` See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>.
`Map<String,String>`	`getLabelsMap()` See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>.
`String`	`getLabelsOrDefault(String key, String defaultValue)` See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>.
`String`	`getLabelsOrThrow(String key)` See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>.
`com.google.protobuf.Duration`	`getMessageRetentionDuration()` How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.
`com.google.protobuf.Duration.Builder`	`getMessageRetentionDurationBuilder()` How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.
`com.google.protobuf.DurationOrBuilder`	`getMessageRetentionDurationOrBuilder()` How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.
`Map<String,String>`	`getMutableLabels()` Deprecated.
`String`	`getName()` The name of the subscription.
`com.google.protobuf.ByteString`	`getNameBytes()` The name of the subscription.
`PushConfig`	`getPushConfig()` If push delivery is used with this subscription, this field is used to configure it.
`PushConfig.Builder`	`getPushConfigBuilder()` If push delivery is used with this subscription, this field is used to configure it.
`PushConfigOrBuilder`	`getPushConfigOrBuilder()` If push delivery is used with this subscription, this field is used to configure it.
`boolean`	`getRetainAckedMessages()` Indicates whether to retain acknowledged messages.
`String`	`getTopic()` The name of the topic from which this subscription is receiving messages.
`com.google.protobuf.ByteString`	`getTopicBytes()` The name of the topic from which this subscription is receiving messages.
`boolean`	`hasExpirationPolicy()` A policy that specifies the conditions for this subscription's expiration.
`boolean`	`hasMessageRetentionDuration()` How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.
`boolean`	`hasPushConfig()` If push delivery is used with this subscription, this field is used to configure it.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapField`	`internalGetMapField(int number)`
`protected com.google.protobuf.MapField`	`internalGetMutableMapField(int number)`
`boolean`	`isInitialized()`
`Subscription.Builder`	`mergeExpirationPolicy(ExpirationPolicy value)` A policy that specifies the conditions for this subscription's expiration.
`Subscription.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`Subscription.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`Subscription.Builder`	`mergeFrom(Subscription other)`
`Subscription.Builder`	`mergeMessageRetentionDuration(com.google.protobuf.Duration value)` How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.
`Subscription.Builder`	`mergePushConfig(PushConfig value)` If push delivery is used with this subscription, this field is used to configure it.
`Subscription.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`Subscription.Builder`	`putAllLabels(Map<String,String> values)` See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>.
`Subscription.Builder`	`putLabels(String key, String value)` See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>.
`Subscription.Builder`	`removeLabels(String key)` See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>.
`Subscription.Builder`	`setAckDeadlineSeconds(int value)` The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message.
`Subscription.Builder`	`setEnableMessageOrdering(boolean value)` If true, messages published with the same `ordering_key` in `PubsubMessage` will be delivered to the subscribers in the order in which they are received by the Pub/Sub system.
`Subscription.Builder`	`setExpirationPolicy(ExpirationPolicy.Builder builderForValue)` A policy that specifies the conditions for this subscription's expiration.
`Subscription.Builder`	`setExpirationPolicy(ExpirationPolicy value)` A policy that specifies the conditions for this subscription's expiration.
`Subscription.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Subscription.Builder`	`setMessageRetentionDuration(com.google.protobuf.Duration.Builder builderForValue)` How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.
`Subscription.Builder`	`setMessageRetentionDuration(com.google.protobuf.Duration value)` How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.
`Subscription.Builder`	`setName(String value)` The name of the subscription.
`Subscription.Builder`	`setNameBytes(com.google.protobuf.ByteString value)` The name of the subscription.
`Subscription.Builder`	`setPushConfig(PushConfig.Builder builderForValue)` If push delivery is used with this subscription, this field is used to configure it.
`Subscription.Builder`	`setPushConfig(PushConfig value)` If push delivery is used with this subscription, this field is used to configure it.
`Subscription.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`Subscription.Builder`	`setRetainAckedMessages(boolean value)` Indicates whether to retain acknowledged messages.
`Subscription.Builder`	`setTopic(String value)` The name of the topic from which this subscription is receiving messages.
`Subscription.Builder`	`setTopicBytes(com.google.protobuf.ByteString value)` The name of the topic from which this subscription is receiving messages.
`Subscription.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField
```
protected com.google.protobuf.MapField internalGetMapField(int number)
```
Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>

internalGetMutableMapField
```
protected com.google.protobuf.MapField internalGetMutableMapField(int number)
```
Overrides:

internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>

clear
```
public Subscription.Builder clear()
```
Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>

getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>

getDefaultInstanceForType
```
public Subscription getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public Subscription build()
```
Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial
```
public Subscription buildPartial()
```
Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone
```
public Subscription.Builder clone()
```
Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>

setField

public Subscription.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                     Object value)

Specified by:: setField in interface com.google.protobuf.Message.Builder
Overrides:: setField in class com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>

clearField
```
public Subscription.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>

clearOneof
```
public Subscription.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>

setRepeatedField

public Subscription.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             int index,
                                             Object value)

Specified by:: setRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>

addRepeatedField

public Subscription.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             Object value)

Specified by:: addRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>

mergeFrom
```
public Subscription.Builder mergeFrom(com.google.protobuf.Message other)
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Subscription.Builder>

mergeFrom

public Subscription.Builder mergeFrom(Subscription other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>

mergeFrom
```
public Subscription.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Subscription.Builder>

Throws:

IOException

getName

public 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"`.

string name = 1;

Specified by:: getName in interface SubscriptionOrBuilder

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 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"`.

string name = 1;

Specified by:: getNameBytes in interface SubscriptionOrBuilder

setName

public Subscription.Builder setName(String value)

 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"`.

string name = 1;

clearName

public Subscription.Builder clearName()

 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"`.

string name = 1;

setNameBytes

public Subscription.Builder setNameBytes(com.google.protobuf.ByteString value)

 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"`.

string name = 1;

getTopic

public String getTopic()

 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.

string topic = 2;

Specified by:: getTopic in interface SubscriptionOrBuilder

getTopicBytes

public com.google.protobuf.ByteString getTopicBytes()

 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.

string topic = 2;

Specified by:: getTopicBytes in interface SubscriptionOrBuilder

setTopic

public Subscription.Builder setTopic(String value)

 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.

string topic = 2;

clearTopic

public Subscription.Builder clearTopic()

 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.

string topic = 2;

setTopicBytes

public Subscription.Builder setTopicBytes(com.google.protobuf.ByteString value)

 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.

string topic = 2;

hasPushConfig

public boolean hasPushConfig()

 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.

.google.pubsub.v1.PushConfig push_config = 4;

Specified by:: hasPushConfig in interface SubscriptionOrBuilder

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.

.google.pubsub.v1.PushConfig push_config = 4;

Specified by:: getPushConfig in interface SubscriptionOrBuilder

setPushConfig

public Subscription.Builder setPushConfig(PushConfig value)

 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.

.google.pubsub.v1.PushConfig push_config = 4;

setPushConfig

public Subscription.Builder setPushConfig(PushConfig.Builder builderForValue)

 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.

.google.pubsub.v1.PushConfig push_config = 4;

mergePushConfig

public Subscription.Builder mergePushConfig(PushConfig value)

 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.

.google.pubsub.v1.PushConfig push_config = 4;

clearPushConfig

public Subscription.Builder clearPushConfig()

 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.

.google.pubsub.v1.PushConfig push_config = 4;

getPushConfigBuilder

public PushConfig.Builder getPushConfigBuilder()

 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.

.google.pubsub.v1.PushConfig push_config = 4;

getPushConfigOrBuilder

public PushConfigOrBuilder getPushConfigOrBuilder()

 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.

.google.pubsub.v1.PushConfig push_config = 4;

Specified by:: getPushConfigOrBuilder in interface SubscriptionOrBuilder

getAckDeadlineSeconds

public int 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 <i>outstanding</i>. 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.

int32 ack_deadline_seconds = 5;

Specified by:: getAckDeadlineSeconds in interface SubscriptionOrBuilder

setAckDeadlineSeconds

public Subscription.Builder setAckDeadlineSeconds(int value)

 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 <i>outstanding</i>. 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.

int32 ack_deadline_seconds = 5;

clearAckDeadlineSeconds

public Subscription.Builder clearAckDeadlineSeconds()

 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 <i>outstanding</i>. 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.

int32 ack_deadline_seconds = 5;

getRetainAckedMessages

public 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
 <a
 href="https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time">
 Seek to a timestamp</a>.

bool retain_acked_messages = 7;

Specified by:: getRetainAckedMessages in interface SubscriptionOrBuilder

setRetainAckedMessages

public Subscription.Builder setRetainAckedMessages(boolean value)

 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
 <a
 href="https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time">
 Seek to a timestamp</a>.

bool retain_acked_messages = 7;

clearRetainAckedMessages

public Subscription.Builder clearRetainAckedMessages()

 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
 <a
 href="https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time">
 Seek to a timestamp</a>.

bool retain_acked_messages = 7;

hasMessageRetentionDuration

public boolean hasMessageRetentionDuration()

 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.

.google.protobuf.Duration message_retention_duration = 8;

Specified by:: hasMessageRetentionDuration in interface SubscriptionOrBuilder

getMessageRetentionDuration

public com.google.protobuf.Duration 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.

.google.protobuf.Duration message_retention_duration = 8;

Specified by:: getMessageRetentionDuration in interface SubscriptionOrBuilder

setMessageRetentionDuration

public Subscription.Builder setMessageRetentionDuration(com.google.protobuf.Duration value)

 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.

.google.protobuf.Duration message_retention_duration = 8;

setMessageRetentionDuration

public Subscription.Builder setMessageRetentionDuration(com.google.protobuf.Duration.Builder builderForValue)

 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.

.google.protobuf.Duration message_retention_duration = 8;

mergeMessageRetentionDuration

public Subscription.Builder mergeMessageRetentionDuration(com.google.protobuf.Duration value)

 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.

.google.protobuf.Duration message_retention_duration = 8;

clearMessageRetentionDuration

public Subscription.Builder clearMessageRetentionDuration()

 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.

.google.protobuf.Duration message_retention_duration = 8;

getMessageRetentionDurationBuilder

public com.google.protobuf.Duration.Builder getMessageRetentionDurationBuilder()

 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.

.google.protobuf.Duration message_retention_duration = 8;

getMessageRetentionDurationOrBuilder

public com.google.protobuf.DurationOrBuilder getMessageRetentionDurationOrBuilder()

 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.

.google.protobuf.Duration message_retention_duration = 8;

Specified by:: getMessageRetentionDurationOrBuilder in interface SubscriptionOrBuilder

getLabelsCount
```
public int getLabelsCount()
```
Description copied from interface: SubscriptionOrBuilder
```
 See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
 managing labels</a>.
 
```
map<string, string> labels = 9;
Specified by:

getLabelsCount in interface SubscriptionOrBuilder

containsLabels

public boolean containsLabels(String key)

 See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
 managing labels</a>.

map<string, string> labels = 9;

Specified by:: containsLabels in interface SubscriptionOrBuilder

getLabels
```
@Deprecated
public Map<String,String> getLabels()
```
Deprecated.

Use getLabelsMap() instead.

Specified by:

getLabels in interface SubscriptionOrBuilder

getLabelsMap

public Map<String,String> getLabelsMap()

 See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
 managing labels</a>.

map<string, string> labels = 9;

Specified by:: getLabelsMap in interface SubscriptionOrBuilder

getLabelsOrDefault

public String getLabelsOrDefault(String key,
                                 String defaultValue)

 See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
 managing labels</a>.

map<string, string> labels = 9;

Specified by:: getLabelsOrDefault in interface SubscriptionOrBuilder

getLabelsOrThrow

public String getLabelsOrThrow(String key)

 See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
 managing labels</a>.

map<string, string> labels = 9;

Specified by:: getLabelsOrThrow in interface SubscriptionOrBuilder

clearLabels

public Subscription.Builder clearLabels()

removeLabels

public Subscription.Builder removeLabels(String key)

 See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
 managing labels</a>.

map<string, string> labels = 9;

getMutableLabels
```
@Deprecated
public Map<String,String> getMutableLabels()
```
Deprecated.

Use alternate mutation accessors instead.

putLabels

public Subscription.Builder putLabels(String key,
                                      String value)

 See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
 managing labels</a>.

map<string, string> labels = 9;

putAllLabels

public Subscription.Builder putAllLabels(Map<String,String> values)

 See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
 managing labels</a>.

map<string, string> labels = 9;

getEnableMessageOrdering

public boolean getEnableMessageOrdering()

 If true, messages published with the same `ordering_key` in `PubsubMessage`
 will be delivered to the subscribers in the order in which they
 are received by the Pub/Sub system. Otherwise, they may be delivered in
 any order.
 <b>EXPERIMENTAL:</b> 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.

bool enable_message_ordering = 10;

Specified by:: getEnableMessageOrdering in interface SubscriptionOrBuilder

setEnableMessageOrdering

public Subscription.Builder setEnableMessageOrdering(boolean value)

 If true, messages published with the same `ordering_key` in `PubsubMessage`
 will be delivered to the subscribers in the order in which they
 are received by the Pub/Sub system. Otherwise, they may be delivered in
 any order.
 <b>EXPERIMENTAL:</b> 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.

bool enable_message_ordering = 10;

clearEnableMessageOrdering

public Subscription.Builder clearEnableMessageOrdering()

 If true, messages published with the same `ordering_key` in `PubsubMessage`
 will be delivered to the subscribers in the order in which they
 are received by the Pub/Sub system. Otherwise, they may be delivered in
 any order.
 <b>EXPERIMENTAL:</b> 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.

bool enable_message_ordering = 10;