public static final class Subscription.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder> implements SubscriptionOrBuilder
A subscription resource. If none of `push_config`, `bigquery_config`, or `cloud_storage_config` is set, then the subscriber will pull and ack messages using API methods. At most one of these fields may be set.Protobuf type
google.pubsub.v1.Subscription
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 |
clearBigqueryConfig()
If delivery to BigQuery is used with this subscription, this field is
used to configure it.
|
Subscription.Builder |
clearCloudStorageConfig()
If delivery to Google Cloud Storage is used with this subscription, this
field is used to configure it.
|
Subscription.Builder |
clearDeadLetterPolicy()
A policy that specifies the conditions for dead lettering messages in
this subscription.
|
Subscription.Builder |
clearDetached()
Indicates whether the subscription is detached from its topic.
|
Subscription.Builder |
clearEnableExactlyOnceDelivery()
If true, Pub/Sub provides the following guarantees for the delivery of
a message with a given value of `message_id` on this subscription:
* The message sent to a subscriber is guaranteed not to be resent
before the message's acknowledgement deadline expires.
|
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 Pub/Sub [filter
language](https://cloud.google.com/pubsub/docs/filtering).
|
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 Pub/Sub retries message delivery for this
subscription.
|
Subscription.Builder |
clearState()
Output only.
|
Subscription.Builder |
clearTopic()
Required.
|
Subscription.Builder |
clearTopicMessageRetentionDuration()
Output only.
|
Subscription.Builder |
clone() |
boolean |
containsLabels(String key)
See [Creating and managing
labels](https://cloud.google.com/pubsub/docs/labels).
|
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.
|
BigQueryConfig |
getBigqueryConfig()
If delivery to BigQuery is used with this subscription, this field is
used to configure it.
|
BigQueryConfig.Builder |
getBigqueryConfigBuilder()
If delivery to BigQuery is used with this subscription, this field is
used to configure it.
|
BigQueryConfigOrBuilder |
getBigqueryConfigOrBuilder()
If delivery to BigQuery is used with this subscription, this field is
used to configure it.
|
CloudStorageConfig |
getCloudStorageConfig()
If delivery to Google Cloud Storage is used with this subscription, this
field is used to configure it.
|
CloudStorageConfig.Builder |
getCloudStorageConfigBuilder()
If delivery to Google Cloud Storage is used with this subscription, this
field is used to configure it.
|
CloudStorageConfigOrBuilder |
getCloudStorageConfigOrBuilder()
If delivery to Google Cloud Storage is used with this subscription, this
field is used to configure it.
|
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 |
getDetached()
Indicates whether the subscription is detached from its topic.
|
boolean |
getEnableExactlyOnceDelivery()
If true, Pub/Sub provides the following guarantees for the delivery of
a message with a given value of `message_id` on this subscription:
* The message sent to a subscriber is guaranteed not to be resent
before the message's acknowledgement deadline expires.
|
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 Pub/Sub [filter
language](https://cloud.google.com/pubsub/docs/filtering).
|
com.google.protobuf.ByteString |
getFilterBytes()
An expression written in the Pub/Sub [filter
language](https://cloud.google.com/pubsub/docs/filtering).
|
Map<String,String> |
getLabels()
Deprecated.
|
int |
getLabelsCount()
See [Creating and managing
labels](https://cloud.google.com/pubsub/docs/labels).
|
Map<String,String> |
getLabelsMap()
See [Creating and managing
labels](https://cloud.google.com/pubsub/docs/labels).
|
String |
getLabelsOrDefault(String key,
String defaultValue)
See [Creating and managing
labels](https://cloud.google.com/pubsub/docs/labels).
|
String |
getLabelsOrThrow(String key)
See [Creating and managing
labels](https://cloud.google.com/pubsub/docs/labels).
|
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 Pub/Sub retries message delivery for this
subscription.
|
RetryPolicy.Builder |
getRetryPolicyBuilder()
A policy that specifies how Pub/Sub retries message delivery for this
subscription.
|
RetryPolicyOrBuilder |
getRetryPolicyOrBuilder()
A policy that specifies how Pub/Sub retries message delivery for this
subscription.
|
Subscription.State |
getState()
Output only.
|
int |
getStateValue()
Output only.
|
String |
getTopic()
Required.
|
com.google.protobuf.ByteString |
getTopicBytes()
Required.
|
com.google.protobuf.Duration |
getTopicMessageRetentionDuration()
Output only.
|
com.google.protobuf.Duration.Builder |
getTopicMessageRetentionDurationBuilder()
Output only.
|
com.google.protobuf.DurationOrBuilder |
getTopicMessageRetentionDurationOrBuilder()
Output only.
|
boolean |
hasBigqueryConfig()
If delivery to BigQuery is used with this subscription, this field is
used to configure it.
|
boolean |
hasCloudStorageConfig()
If delivery to Google Cloud Storage is used with this subscription, this
field is used to configure it.
|
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 Pub/Sub retries message delivery for this
subscription.
|
boolean |
hasTopicMessageRetentionDuration()
Output only.
|
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 |
mergeBigqueryConfig(BigQueryConfig value)
If delivery to BigQuery is used with this subscription, this field is
used to configure it.
|
Subscription.Builder |
mergeCloudStorageConfig(CloudStorageConfig value)
If delivery to Google Cloud Storage is used with this subscription, this
field is used to configure it.
|
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 Pub/Sub retries message delivery for this
subscription.
|
Subscription.Builder |
mergeTopicMessageRetentionDuration(com.google.protobuf.Duration value)
Output only.
|
Subscription.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Subscription.Builder |
putAllLabels(Map<String,String> values)
See [Creating and managing
labels](https://cloud.google.com/pubsub/docs/labels).
|
Subscription.Builder |
putLabels(String key,
String value)
See [Creating and managing
labels](https://cloud.google.com/pubsub/docs/labels).
|
Subscription.Builder |
removeLabels(String key)
See [Creating and managing
labels](https://cloud.google.com/pubsub/docs/labels).
|
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 |
setBigqueryConfig(BigQueryConfig.Builder builderForValue)
If delivery to BigQuery is used with this subscription, this field is
used to configure it.
|
Subscription.Builder |
setBigqueryConfig(BigQueryConfig value)
If delivery to BigQuery is used with this subscription, this field is
used to configure it.
|
Subscription.Builder |
setCloudStorageConfig(CloudStorageConfig.Builder builderForValue)
If delivery to Google Cloud Storage is used with this subscription, this
field is used to configure it.
|
Subscription.Builder |
setCloudStorageConfig(CloudStorageConfig value)
If delivery to Google Cloud Storage is used with this subscription, this
field is used to configure it.
|
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 |
setDetached(boolean value)
Indicates whether the subscription is detached from its topic.
|
Subscription.Builder |
setEnableExactlyOnceDelivery(boolean value)
If true, Pub/Sub provides the following guarantees for the delivery of
a message with a given value of `message_id` on this subscription:
* The message sent to a subscriber is guaranteed not to be resent
before the message's acknowledgement deadline expires.
|
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 Pub/Sub [filter
language](https://cloud.google.com/pubsub/docs/filtering).
|
Subscription.Builder |
setFilterBytes(com.google.protobuf.ByteString value)
An expression written in the Pub/Sub [filter
language](https://cloud.google.com/pubsub/docs/filtering).
|
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 Pub/Sub retries message delivery for this
subscription.
|
Subscription.Builder |
setRetryPolicy(RetryPolicy value)
A policy that specifies how Pub/Sub retries message delivery for this
subscription.
|
Subscription.Builder |
setState(Subscription.State value)
Output only.
|
Subscription.Builder |
setStateValue(int value)
Output only.
|
Subscription.Builder |
setTopic(String value)
Required.
|
Subscription.Builder |
setTopicBytes(com.google.protobuf.ByteString value)
Required.
|
Subscription.Builder |
setTopicMessageRetentionDuration(com.google.protobuf.Duration.Builder builderForValue)
Output only.
|
Subscription.Builder |
setTopicMessageRetentionDuration(com.google.protobuf.Duration value)
Output only.
|
Subscription.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapField internalGetMapField(int number)
internalGetMapField
in class com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>
protected com.google.protobuf.MapField internalGetMutableMapField(int number)
internalGetMutableMapField
in class com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>
public Subscription.Builder clear()
clear
in interface com.google.protobuf.Message.Builder
clear
in interface com.google.protobuf.MessageLite.Builder
clear
in class com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType
in interface com.google.protobuf.Message.Builder
getDescriptorForType
in interface com.google.protobuf.MessageOrBuilder
getDescriptorForType
in class com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>
public Subscription getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder
public Subscription build()
build
in interface com.google.protobuf.Message.Builder
build
in interface com.google.protobuf.MessageLite.Builder
public Subscription buildPartial()
buildPartial
in interface com.google.protobuf.Message.Builder
buildPartial
in interface com.google.protobuf.MessageLite.Builder
public Subscription.Builder clone()
clone
in interface com.google.protobuf.Message.Builder
clone
in interface com.google.protobuf.MessageLite.Builder
clone
in class com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>
public Subscription.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField
in interface com.google.protobuf.Message.Builder
setField
in class com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>
public Subscription.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField
in interface com.google.protobuf.Message.Builder
clearField
in class com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>
public Subscription.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof
in interface com.google.protobuf.Message.Builder
clearOneof
in class com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>
public Subscription.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField
in interface com.google.protobuf.Message.Builder
setRepeatedField
in class com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>
public Subscription.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField
in interface com.google.protobuf.Message.Builder
addRepeatedField
in class com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>
public Subscription.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom
in interface com.google.protobuf.Message.Builder
mergeFrom
in class com.google.protobuf.AbstractMessage.Builder<Subscription.Builder>
public Subscription.Builder mergeFrom(Subscription other)
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>
public Subscription.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom
in interface com.google.protobuf.Message.Builder
mergeFrom
in interface com.google.protobuf.MessageLite.Builder
mergeFrom
in class com.google.protobuf.AbstractMessage.Builder<Subscription.Builder>
IOException
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];
getName
in interface SubscriptionOrBuilder
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];
getNameBytes
in interface SubscriptionOrBuilder
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];
value
- The name to set.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];
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];
value
- The bytes for name to set.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) = { ... }
getTopic
in interface SubscriptionOrBuilder
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) = { ... }
getTopicBytes
in interface SubscriptionOrBuilder
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) = { ... }
value
- The topic to set.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) = { ... }
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) = { ... }
value
- The bytes for topic to set.public boolean hasPushConfig()
If push delivery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.PushConfig push_config = 4;
hasPushConfig
in interface SubscriptionOrBuilder
public PushConfig getPushConfig()
If push delivery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.PushConfig push_config = 4;
getPushConfig
in interface SubscriptionOrBuilder
public Subscription.Builder setPushConfig(PushConfig value)
If push delivery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.PushConfig push_config = 4;
public Subscription.Builder setPushConfig(PushConfig.Builder builderForValue)
If push delivery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.PushConfig push_config = 4;
public Subscription.Builder mergePushConfig(PushConfig value)
If push delivery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.PushConfig push_config = 4;
public Subscription.Builder clearPushConfig()
If push delivery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.PushConfig push_config = 4;
public PushConfig.Builder getPushConfigBuilder()
If push delivery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.PushConfig push_config = 4;
public PushConfigOrBuilder getPushConfigOrBuilder()
If push delivery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.PushConfig push_config = 4;
getPushConfigOrBuilder
in interface SubscriptionOrBuilder
public boolean hasBigqueryConfig()
If delivery to BigQuery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.BigQueryConfig bigquery_config = 18;
hasBigqueryConfig
in interface SubscriptionOrBuilder
public BigQueryConfig getBigqueryConfig()
If delivery to BigQuery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.BigQueryConfig bigquery_config = 18;
getBigqueryConfig
in interface SubscriptionOrBuilder
public Subscription.Builder setBigqueryConfig(BigQueryConfig value)
If delivery to BigQuery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.BigQueryConfig bigquery_config = 18;
public Subscription.Builder setBigqueryConfig(BigQueryConfig.Builder builderForValue)
If delivery to BigQuery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.BigQueryConfig bigquery_config = 18;
public Subscription.Builder mergeBigqueryConfig(BigQueryConfig value)
If delivery to BigQuery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.BigQueryConfig bigquery_config = 18;
public Subscription.Builder clearBigqueryConfig()
If delivery to BigQuery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.BigQueryConfig bigquery_config = 18;
public BigQueryConfig.Builder getBigqueryConfigBuilder()
If delivery to BigQuery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.BigQueryConfig bigquery_config = 18;
public BigQueryConfigOrBuilder getBigqueryConfigOrBuilder()
If delivery to BigQuery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.BigQueryConfig bigquery_config = 18;
getBigqueryConfigOrBuilder
in interface SubscriptionOrBuilder
public boolean hasCloudStorageConfig()
If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
.google.pubsub.v1.CloudStorageConfig cloud_storage_config = 22;
hasCloudStorageConfig
in interface SubscriptionOrBuilder
public CloudStorageConfig getCloudStorageConfig()
If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
.google.pubsub.v1.CloudStorageConfig cloud_storage_config = 22;
getCloudStorageConfig
in interface SubscriptionOrBuilder
public Subscription.Builder setCloudStorageConfig(CloudStorageConfig value)
If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
.google.pubsub.v1.CloudStorageConfig cloud_storage_config = 22;
public Subscription.Builder setCloudStorageConfig(CloudStorageConfig.Builder builderForValue)
If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
.google.pubsub.v1.CloudStorageConfig cloud_storage_config = 22;
public Subscription.Builder mergeCloudStorageConfig(CloudStorageConfig value)
If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
.google.pubsub.v1.CloudStorageConfig cloud_storage_config = 22;
public Subscription.Builder clearCloudStorageConfig()
If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
.google.pubsub.v1.CloudStorageConfig cloud_storage_config = 22;
public CloudStorageConfig.Builder getCloudStorageConfigBuilder()
If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
.google.pubsub.v1.CloudStorageConfig cloud_storage_config = 22;
public CloudStorageConfigOrBuilder getCloudStorageConfigOrBuilder()
If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
.google.pubsub.v1.CloudStorageConfig cloud_storage_config = 22;
getCloudStorageConfigOrBuilder
in interface SubscriptionOrBuilder
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 _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.
int32 ack_deadline_seconds = 5;
getAckDeadlineSeconds
in interface SubscriptionOrBuilder
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 _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.
int32 ack_deadline_seconds = 5;
value
- The ackDeadlineSeconds to set.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 _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.
int32 ack_deadline_seconds = 5;
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 [`Seek` to a timestamp] (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in the past to replay previously-acknowledged messages.
bool retain_acked_messages = 7;
getRetainAckedMessages
in interface SubscriptionOrBuilder
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 [`Seek` to a timestamp] (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in the past to replay previously-acknowledged messages.
bool retain_acked_messages = 7;
value
- The retainAckedMessages to set.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 [`Seek` to a timestamp] (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in the past to replay previously-acknowledged messages.
bool retain_acked_messages = 7;
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;
hasMessageRetentionDuration
in interface SubscriptionOrBuilder
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;
getMessageRetentionDuration
in interface SubscriptionOrBuilder
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;
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;
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;
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;
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;
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;
getMessageRetentionDurationOrBuilder
in interface SubscriptionOrBuilder
public int getLabelsCount()
SubscriptionOrBuilder
See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 9;
getLabelsCount
in interface SubscriptionOrBuilder
public boolean containsLabels(String key)
See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 9;
containsLabels
in interface SubscriptionOrBuilder
@Deprecated public Map<String,String> getLabels()
getLabelsMap()
instead.getLabels
in interface SubscriptionOrBuilder
public Map<String,String> getLabelsMap()
See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 9;
getLabelsMap
in interface SubscriptionOrBuilder
public String getLabelsOrDefault(String key, String defaultValue)
See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 9;
getLabelsOrDefault
in interface SubscriptionOrBuilder
public String getLabelsOrThrow(String key)
See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 9;
getLabelsOrThrow
in interface SubscriptionOrBuilder
public Subscription.Builder clearLabels()
public Subscription.Builder removeLabels(String key)
See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 9;
@Deprecated public Map<String,String> getMutableLabels()
public Subscription.Builder putLabels(String key, String value)
See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 9;
public Subscription.Builder putAllLabels(Map<String,String> values)
See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 9;
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.
bool enable_message_ordering = 10;
getEnableMessageOrdering
in interface SubscriptionOrBuilder
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.
bool enable_message_ordering = 10;
value
- The enableMessageOrdering to set.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.
bool enable_message_ordering = 10;
public boolean hasExpirationPolicy()
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. If `expiration_policy` is set, but `expiration_policy.ttl` is not set, the subscription never expires.
.google.pubsub.v1.ExpirationPolicy expiration_policy = 11;
hasExpirationPolicy
in interface SubscriptionOrBuilder
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. If `expiration_policy` is set, but `expiration_policy.ttl` is not set, the subscription never expires.
.google.pubsub.v1.ExpirationPolicy expiration_policy = 11;
getExpirationPolicy
in interface SubscriptionOrBuilder
public Subscription.Builder setExpirationPolicy(ExpirationPolicy value)
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. If `expiration_policy` is set, but `expiration_policy.ttl` is not set, the subscription never expires.
.google.pubsub.v1.ExpirationPolicy expiration_policy = 11;
public Subscription.Builder setExpirationPolicy(ExpirationPolicy.Builder builderForValue)
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. If `expiration_policy` is set, but `expiration_policy.ttl` is not set, the subscription never expires.
.google.pubsub.v1.ExpirationPolicy expiration_policy = 11;
public Subscription.Builder mergeExpirationPolicy(ExpirationPolicy value)
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. If `expiration_policy` is set, but `expiration_policy.ttl` is not set, the subscription never expires.
.google.pubsub.v1.ExpirationPolicy expiration_policy = 11;
public Subscription.Builder clearExpirationPolicy()
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. If `expiration_policy` is set, but `expiration_policy.ttl` is not set, the subscription never expires.
.google.pubsub.v1.ExpirationPolicy expiration_policy = 11;
public ExpirationPolicy.Builder getExpirationPolicyBuilder()
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. If `expiration_policy` is set, but `expiration_policy.ttl` is not set, the subscription never expires.
.google.pubsub.v1.ExpirationPolicy expiration_policy = 11;
public ExpirationPolicyOrBuilder getExpirationPolicyOrBuilder()
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. If `expiration_policy` is set, but `expiration_policy.ttl` is not set, the subscription never expires.
.google.pubsub.v1.ExpirationPolicy expiration_policy = 11;
getExpirationPolicyOrBuilder
in interface SubscriptionOrBuilder
public String getFilter()
An expression written in the Pub/Sub [filter language](https://cloud.google.com/pubsub/docs/filtering). If non-empty, then only `PubsubMessage`s whose `attributes` field matches the filter are delivered on this subscription. If empty, then no messages are filtered out.
string filter = 12;
getFilter
in interface SubscriptionOrBuilder
public com.google.protobuf.ByteString getFilterBytes()
An expression written in the Pub/Sub [filter language](https://cloud.google.com/pubsub/docs/filtering). If non-empty, then only `PubsubMessage`s whose `attributes` field matches the filter are delivered on this subscription. If empty, then no messages are filtered out.
string filter = 12;
getFilterBytes
in interface SubscriptionOrBuilder
public Subscription.Builder setFilter(String value)
An expression written in the Pub/Sub [filter language](https://cloud.google.com/pubsub/docs/filtering). If non-empty, then only `PubsubMessage`s whose `attributes` field matches the filter are delivered on this subscription. If empty, then no messages are filtered out.
string filter = 12;
value
- The filter to set.public Subscription.Builder clearFilter()
An expression written in the Pub/Sub [filter language](https://cloud.google.com/pubsub/docs/filtering). If non-empty, then only `PubsubMessage`s whose `attributes` field matches the filter are delivered on this subscription. If empty, then no messages are filtered out.
string filter = 12;
public Subscription.Builder setFilterBytes(com.google.protobuf.ByteString value)
An expression written in the Pub/Sub [filter language](https://cloud.google.com/pubsub/docs/filtering). If non-empty, then only `PubsubMessage`s whose `attributes` field matches the filter are delivered on this subscription. If empty, then no messages are filtered out.
string filter = 12;
value
- The bytes for filter to set.public boolean hasDeadLetterPolicy()
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.
.google.pubsub.v1.DeadLetterPolicy dead_letter_policy = 13;
hasDeadLetterPolicy
in interface SubscriptionOrBuilder
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.
.google.pubsub.v1.DeadLetterPolicy dead_letter_policy = 13;
getDeadLetterPolicy
in interface SubscriptionOrBuilder
public Subscription.Builder setDeadLetterPolicy(DeadLetterPolicy value)
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.
.google.pubsub.v1.DeadLetterPolicy dead_letter_policy = 13;
public Subscription.Builder setDeadLetterPolicy(DeadLetterPolicy.Builder builderForValue)
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.
.google.pubsub.v1.DeadLetterPolicy dead_letter_policy = 13;
public Subscription.Builder mergeDeadLetterPolicy(DeadLetterPolicy value)
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.
.google.pubsub.v1.DeadLetterPolicy dead_letter_policy = 13;
public Subscription.Builder clearDeadLetterPolicy()
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.
.google.pubsub.v1.DeadLetterPolicy dead_letter_policy = 13;
public DeadLetterPolicy.Builder getDeadLetterPolicyBuilder()
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.
.google.pubsub.v1.DeadLetterPolicy dead_letter_policy = 13;
public DeadLetterPolicyOrBuilder getDeadLetterPolicyOrBuilder()
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.
.google.pubsub.v1.DeadLetterPolicy dead_letter_policy = 13;
getDeadLetterPolicyOrBuilder
in interface SubscriptionOrBuilder
public boolean hasRetryPolicy()
A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message.
.google.pubsub.v1.RetryPolicy retry_policy = 14;
hasRetryPolicy
in interface SubscriptionOrBuilder
public RetryPolicy getRetryPolicy()
A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message.
.google.pubsub.v1.RetryPolicy retry_policy = 14;
getRetryPolicy
in interface SubscriptionOrBuilder
public Subscription.Builder setRetryPolicy(RetryPolicy value)
A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message.
.google.pubsub.v1.RetryPolicy retry_policy = 14;
public Subscription.Builder setRetryPolicy(RetryPolicy.Builder builderForValue)
A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message.
.google.pubsub.v1.RetryPolicy retry_policy = 14;
public Subscription.Builder mergeRetryPolicy(RetryPolicy value)
A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message.
.google.pubsub.v1.RetryPolicy retry_policy = 14;
public Subscription.Builder clearRetryPolicy()
A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message.
.google.pubsub.v1.RetryPolicy retry_policy = 14;
public RetryPolicy.Builder getRetryPolicyBuilder()
A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message.
.google.pubsub.v1.RetryPolicy retry_policy = 14;
public RetryPolicyOrBuilder getRetryPolicyOrBuilder()
A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message.
.google.pubsub.v1.RetryPolicy retry_policy = 14;
getRetryPolicyOrBuilder
in interface SubscriptionOrBuilder
public boolean getDetached()
Indicates whether the subscription is detached from its topic. Detached subscriptions don't receive messages from their topic and don't retain any backlog. `Pull` and `StreamingPull` requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made.
bool detached = 15;
getDetached
in interface SubscriptionOrBuilder
public Subscription.Builder setDetached(boolean value)
Indicates whether the subscription is detached from its topic. Detached subscriptions don't receive messages from their topic and don't retain any backlog. `Pull` and `StreamingPull` requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made.
bool detached = 15;
value
- The detached to set.public Subscription.Builder clearDetached()
Indicates whether the subscription is detached from its topic. Detached subscriptions don't receive messages from their topic and don't retain any backlog. `Pull` and `StreamingPull` requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made.
bool detached = 15;
public boolean getEnableExactlyOnceDelivery()
If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of `message_id` on this subscription: * The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires. * An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message when `enable_exactly_once_delivery` is true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinct `message_id` values.
bool enable_exactly_once_delivery = 16;
getEnableExactlyOnceDelivery
in interface SubscriptionOrBuilder
public Subscription.Builder setEnableExactlyOnceDelivery(boolean value)
If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of `message_id` on this subscription: * The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires. * An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message when `enable_exactly_once_delivery` is true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinct `message_id` values.
bool enable_exactly_once_delivery = 16;
value
- The enableExactlyOnceDelivery to set.public Subscription.Builder clearEnableExactlyOnceDelivery()
If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of `message_id` on this subscription: * The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires. * An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message when `enable_exactly_once_delivery` is true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinct `message_id` values.
bool enable_exactly_once_delivery = 16;
public boolean hasTopicMessageRetentionDuration()
Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last `topic_message_retention_duration` are always available to subscribers. See the `message_retention_duration` field in `Topic`. This field is set only in responses from the server; it is ignored if it is set in any requests.
.google.protobuf.Duration topic_message_retention_duration = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasTopicMessageRetentionDuration
in interface SubscriptionOrBuilder
public com.google.protobuf.Duration getTopicMessageRetentionDuration()
Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last `topic_message_retention_duration` are always available to subscribers. See the `message_retention_duration` field in `Topic`. This field is set only in responses from the server; it is ignored if it is set in any requests.
.google.protobuf.Duration topic_message_retention_duration = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
getTopicMessageRetentionDuration
in interface SubscriptionOrBuilder
public Subscription.Builder setTopicMessageRetentionDuration(com.google.protobuf.Duration value)
Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last `topic_message_retention_duration` are always available to subscribers. See the `message_retention_duration` field in `Topic`. This field is set only in responses from the server; it is ignored if it is set in any requests.
.google.protobuf.Duration topic_message_retention_duration = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Subscription.Builder setTopicMessageRetentionDuration(com.google.protobuf.Duration.Builder builderForValue)
Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last `topic_message_retention_duration` are always available to subscribers. See the `message_retention_duration` field in `Topic`. This field is set only in responses from the server; it is ignored if it is set in any requests.
.google.protobuf.Duration topic_message_retention_duration = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Subscription.Builder mergeTopicMessageRetentionDuration(com.google.protobuf.Duration value)
Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last `topic_message_retention_duration` are always available to subscribers. See the `message_retention_duration` field in `Topic`. This field is set only in responses from the server; it is ignored if it is set in any requests.
.google.protobuf.Duration topic_message_retention_duration = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Subscription.Builder clearTopicMessageRetentionDuration()
Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last `topic_message_retention_duration` are always available to subscribers. See the `message_retention_duration` field in `Topic`. This field is set only in responses from the server; it is ignored if it is set in any requests.
.google.protobuf.Duration topic_message_retention_duration = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
public com.google.protobuf.Duration.Builder getTopicMessageRetentionDurationBuilder()
Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last `topic_message_retention_duration` are always available to subscribers. See the `message_retention_duration` field in `Topic`. This field is set only in responses from the server; it is ignored if it is set in any requests.
.google.protobuf.Duration topic_message_retention_duration = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
public com.google.protobuf.DurationOrBuilder getTopicMessageRetentionDurationOrBuilder()
Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last `topic_message_retention_duration` are always available to subscribers. See the `message_retention_duration` field in `Topic`. This field is set only in responses from the server; it is ignored if it is set in any requests.
.google.protobuf.Duration topic_message_retention_duration = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
getTopicMessageRetentionDurationOrBuilder
in interface SubscriptionOrBuilder
public int getStateValue()
Output only. An output-only field indicating whether or not the subscription can receive messages.
.google.pubsub.v1.Subscription.State state = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue
in interface SubscriptionOrBuilder
public Subscription.Builder setStateValue(int value)
Output only. An output-only field indicating whether or not the subscription can receive messages.
.google.pubsub.v1.Subscription.State state = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
value
- The enum numeric value on the wire for state to set.public Subscription.State getState()
Output only. An output-only field indicating whether or not the subscription can receive messages.
.google.pubsub.v1.Subscription.State state = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
getState
in interface SubscriptionOrBuilder
public Subscription.Builder setState(Subscription.State value)
Output only. An output-only field indicating whether or not the subscription can receive messages.
.google.pubsub.v1.Subscription.State state = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
value
- The state to set.public Subscription.Builder clearState()
Output only. An output-only field indicating whether or not the subscription can receive messages.
.google.pubsub.v1.Subscription.State state = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
public final Subscription.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields
in interface com.google.protobuf.Message.Builder
setUnknownFields
in class com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>
public final Subscription.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields
in interface com.google.protobuf.Message.Builder
mergeUnknownFields
in class com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>
Copyright © 2023 Google LLC. All rights reserved.