Subscription.Builder (proto-google-cloud-pubsub-v1 1.87.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`	`clearDeadLetterPolicy()` A policy that specifies the conditions for dead lettering messages in this subscription.
`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`	`clearFilter()` An expression written in the Cloud Pub/Sub filter language.
`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()` Required.
`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`	`clearRetryPolicy()` A policy that specifies how Cloud Pub/Sub retries message delivery for this subscription.
`Subscription.Builder`	`clearTopic()` Required.
`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.
`DeadLetterPolicy`	`getDeadLetterPolicy()` A policy that specifies the conditions for dead lettering messages in this subscription.
`DeadLetterPolicy.Builder`	`getDeadLetterPolicyBuilder()` A policy that specifies the conditions for dead lettering messages in this subscription.
`DeadLetterPolicyOrBuilder`	`getDeadLetterPolicyOrBuilder()` A policy that specifies the conditions for dead lettering messages in this subscription.
`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.
`String`	`getFilter()` An expression written in the Cloud Pub/Sub filter language.
`com.google.protobuf.ByteString`	`getFilterBytes()` An expression written in the Cloud Pub/Sub filter language.
`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()` Required.
`com.google.protobuf.ByteString`	`getNameBytes()` Required.
`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.
`RetryPolicy`	`getRetryPolicy()` A policy that specifies how Cloud Pub/Sub retries message delivery for this subscription.
`RetryPolicy.Builder`	`getRetryPolicyBuilder()` A policy that specifies how Cloud Pub/Sub retries message delivery for this subscription.
`RetryPolicyOrBuilder`	`getRetryPolicyOrBuilder()` A policy that specifies how Cloud Pub/Sub retries message delivery for this subscription.
`String`	`getTopic()` Required.
`com.google.protobuf.ByteString`	`getTopicBytes()` Required.
`boolean`	`hasDeadLetterPolicy()` A policy that specifies the conditions for dead lettering messages in this subscription.
`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.
`boolean`	`hasRetryPolicy()` A policy that specifies how Cloud Pub/Sub retries message delivery for this subscription.
`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`	`mergeDeadLetterPolicy(DeadLetterPolicy value)` A policy that specifies the conditions for dead lettering messages in this subscription.
`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`	`mergeRetryPolicy(RetryPolicy value)` A policy that specifies how Cloud Pub/Sub retries message delivery for this subscription.
`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`	`setDeadLetterPolicy(DeadLetterPolicy.Builder builderForValue)` A policy that specifies the conditions for dead lettering messages in this subscription.
`Subscription.Builder`	`setDeadLetterPolicy(DeadLetterPolicy value)` A policy that specifies the conditions for dead lettering messages in this subscription.
`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`	`setFilter(String value)` An expression written in the Cloud Pub/Sub filter language.
`Subscription.Builder`	`setFilterBytes(com.google.protobuf.ByteString value)` An expression written in the Cloud Pub/Sub filter language.
`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)` Required.
`Subscription.Builder`	`setNameBytes(com.google.protobuf.ByteString value)` Required.
`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`	`setRetryPolicy(RetryPolicy.Builder builderForValue)` A policy that specifies how Cloud Pub/Sub retries message delivery for this subscription.
`Subscription.Builder`	`setRetryPolicy(RetryPolicy value)` A policy that specifies how Cloud Pub/Sub retries message delivery for this subscription.
`Subscription.Builder`	`setTopic(String value)` Required.
`Subscription.Builder`	`setTopicBytes(com.google.protobuf.ByteString value)` Required.
`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()

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

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:: getName in interface SubscriptionOrBuilder
Returns:: The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:: getNameBytes in interface SubscriptionOrBuilder
Returns:: The bytes for name.

setName

public Subscription.Builder setName(String value)

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

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters:: value - The name to set.
Returns:: This builder for chaining.

clearName

public Subscription.Builder clearName()

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

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:: This builder for chaining.

setNameBytes

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

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

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters:: value - The bytes for name to set.
Returns:: This builder for chaining.

getTopic

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


 string topic = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:: getTopic in interface SubscriptionOrBuilder
Returns:: The topic.

getTopicBytes

public com.google.protobuf.ByteString getTopicBytes()

 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.


 string topic = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:: getTopicBytes in interface SubscriptionOrBuilder
Returns:: The bytes for topic.

setTopic

public Subscription.Builder setTopic(String value)

 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.


 string topic = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameters:: value - The topic to set.
Returns:: This builder for chaining.

clearTopic

public Subscription.Builder clearTopic()

 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.


 string topic = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:: This builder for chaining.

setTopicBytes

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

 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.


 string topic = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameters:: value - The bytes for topic to set.
Returns:: This builder for chaining.