Package com.google.pubsub.v1
Class Subscription.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
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. 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
-
Method Summary
Modifier and TypeMethodDescriptionaddRepeatedField
(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) build()
clear()
Optional.Optional.Optional.Optional.Optional.Optional.Optional.Optional.clearField
(com.google.protobuf.Descriptors.FieldDescriptor field) Optional.Optional.Required.clearOneof
(com.google.protobuf.Descriptors.OneofDescriptor oneof) Optional.Optional.Optional.Output only.Required.Output only.clone()
boolean
containsLabels
(String key) Optional.int
Optional.Optional.Optional.Optional.Optional.Optional.Optional.Optional.Optional.Optional.static final com.google.protobuf.Descriptors.Descriptor
com.google.protobuf.Descriptors.Descriptor
boolean
Optional.boolean
Optional.boolean
Optional.Optional.Optional.Optional.Optional.com.google.protobuf.ByteString
Optional.Deprecated.int
Optional.Optional.getLabelsOrDefault
(String key, String defaultValue) Optional.getLabelsOrThrow
(String key) Optional.com.google.protobuf.Duration
Optional.com.google.protobuf.Duration.Builder
Optional.com.google.protobuf.DurationOrBuilder
Optional.Deprecated.getName()
Required.com.google.protobuf.ByteString
Required.Optional.Optional.Optional.boolean
Optional.Optional.Optional.Optional.getState()
Output only.int
Output only.getTopic()
Required.com.google.protobuf.ByteString
Required.com.google.protobuf.Duration
Output only.com.google.protobuf.Duration.Builder
Output only.com.google.protobuf.DurationOrBuilder
Output only.boolean
Optional.boolean
Optional.boolean
Optional.boolean
Optional.boolean
Optional.boolean
Optional.boolean
Optional.boolean
Output only.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
protected com.google.protobuf.MapField
internalGetMapField
(int number) protected com.google.protobuf.MapField
internalGetMutableMapField
(int number) final boolean
Optional.Optional.Optional.Optional.mergeFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom
(com.google.protobuf.Message other) mergeFrom
(Subscription other) mergeMessageRetentionDuration
(com.google.protobuf.Duration value) Optional.mergePushConfig
(PushConfig value) Optional.mergeRetryPolicy
(RetryPolicy value) Optional.mergeTopicMessageRetentionDuration
(com.google.protobuf.Duration value) Output only.final Subscription.Builder
mergeUnknownFields
(com.google.protobuf.UnknownFieldSet unknownFields) putAllLabels
(Map<String, String> values) Optional.Optional.removeLabels
(String key) Optional.setAckDeadlineSeconds
(int value) Optional.setBigqueryConfig
(BigQueryConfig value) Optional.setBigqueryConfig
(BigQueryConfig.Builder builderForValue) Optional.Optional.setCloudStorageConfig
(CloudStorageConfig.Builder builderForValue) Optional.Optional.setDeadLetterPolicy
(DeadLetterPolicy.Builder builderForValue) Optional.setDetached
(boolean value) Optional.setEnableExactlyOnceDelivery
(boolean value) Optional.setEnableMessageOrdering
(boolean value) Optional.Optional.setExpirationPolicy
(ExpirationPolicy.Builder builderForValue) Optional.Optional.setFilterBytes
(com.google.protobuf.ByteString value) Optional.setMessageRetentionDuration
(com.google.protobuf.Duration value) Optional.setMessageRetentionDuration
(com.google.protobuf.Duration.Builder builderForValue) Optional.Required.setNameBytes
(com.google.protobuf.ByteString value) Required.setPushConfig
(PushConfig value) Optional.setPushConfig
(PushConfig.Builder builderForValue) Optional.setRepeatedField
(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) setRetainAckedMessages
(boolean value) Optional.setRetryPolicy
(RetryPolicy value) Optional.setRetryPolicy
(RetryPolicy.Builder builderForValue) Optional.setState
(Subscription.State value) Output only.setStateValue
(int value) Output only.Required.setTopicBytes
(com.google.protobuf.ByteString value) Required.setTopicMessageRetentionDuration
(com.google.protobuf.Duration value) Output only.setTopicMessageRetentionDuration
(com.google.protobuf.Duration.Builder builderForValue) Output only.final 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, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapFieldReflection, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, 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.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom
Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetMapField
protected com.google.protobuf.MapField internalGetMapField(int number) - Overrides:
internalGetMapField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>
-
internalGetMutableMapField
protected com.google.protobuf.MapField internalGetMutableMapField(int number) - Overrides:
internalGetMutableMapField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>
-
clear
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clone
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clone
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clone
in classcom.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>
-
setField
public Subscription.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
setField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>
-
clearField
- Specified by:
clearField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>
-
clearOneof
- Specified by:
clearOneof
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearOneof
in classcom.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 interfacecom.google.protobuf.Message.Builder
- Overrides:
setRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>
-
addRepeatedField
public Subscription.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
addRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>
-
mergeFrom
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<Subscription.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.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 interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<Subscription.Builder>
- Throws:
IOException
-
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 interfaceSubscriptionOrBuilder
- 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 interfaceSubscriptionOrBuilder
- Returns:
- The bytes for name.
-
setName
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
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
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
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 interfaceSubscriptionOrBuilder
- 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 interfaceSubscriptionOrBuilder
- Returns:
- The bytes for topic.
-
setTopic
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
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
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.
-
hasPushConfig
public boolean hasPushConfig()Optional. If push delivery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.PushConfig push_config = 4 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
hasPushConfig
in interfaceSubscriptionOrBuilder
- Returns:
- Whether the pushConfig field is set.
-
getPushConfig
Optional. If push delivery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.PushConfig push_config = 4 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getPushConfig
in interfaceSubscriptionOrBuilder
- Returns:
- The pushConfig.
-
setPushConfig
Optional. If push delivery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.PushConfig push_config = 4 [(.google.api.field_behavior) = OPTIONAL];
-
setPushConfig
Optional. If push delivery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.PushConfig push_config = 4 [(.google.api.field_behavior) = OPTIONAL];
-
mergePushConfig
Optional. If push delivery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.PushConfig push_config = 4 [(.google.api.field_behavior) = OPTIONAL];
-
clearPushConfig
Optional. If push delivery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.PushConfig push_config = 4 [(.google.api.field_behavior) = OPTIONAL];
-
getPushConfigBuilder
Optional. If push delivery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.PushConfig push_config = 4 [(.google.api.field_behavior) = OPTIONAL];
-
getPushConfigOrBuilder
Optional. If push delivery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.PushConfig push_config = 4 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getPushConfigOrBuilder
in interfaceSubscriptionOrBuilder
-
hasBigqueryConfig
public boolean hasBigqueryConfig()Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.BigQueryConfig bigquery_config = 18 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
hasBigqueryConfig
in interfaceSubscriptionOrBuilder
- Returns:
- Whether the bigqueryConfig field is set.
-
getBigqueryConfig
Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.BigQueryConfig bigquery_config = 18 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getBigqueryConfig
in interfaceSubscriptionOrBuilder
- Returns:
- The bigqueryConfig.
-
setBigqueryConfig
Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.BigQueryConfig bigquery_config = 18 [(.google.api.field_behavior) = OPTIONAL];
-
setBigqueryConfig
Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.BigQueryConfig bigquery_config = 18 [(.google.api.field_behavior) = OPTIONAL];
-
mergeBigqueryConfig
Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.BigQueryConfig bigquery_config = 18 [(.google.api.field_behavior) = OPTIONAL];
-
clearBigqueryConfig
Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.BigQueryConfig bigquery_config = 18 [(.google.api.field_behavior) = OPTIONAL];
-
getBigqueryConfigBuilder
Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.BigQueryConfig bigquery_config = 18 [(.google.api.field_behavior) = OPTIONAL];
-
getBigqueryConfigOrBuilder
Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.BigQueryConfig bigquery_config = 18 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getBigqueryConfigOrBuilder
in interfaceSubscriptionOrBuilder
-
hasCloudStorageConfig
public boolean hasCloudStorageConfig()Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
hasCloudStorageConfig
in interfaceSubscriptionOrBuilder
- Returns:
- Whether the cloudStorageConfig field is set.
-
getCloudStorageConfig
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getCloudStorageConfig
in interfaceSubscriptionOrBuilder
- Returns:
- The cloudStorageConfig.
-
setCloudStorageConfig
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
-
setCloudStorageConfig
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
-
mergeCloudStorageConfig
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
-
clearCloudStorageConfig
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
-
getCloudStorageConfigBuilder
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
-
getCloudStorageConfigOrBuilder
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getCloudStorageConfigOrBuilder
in interfaceSubscriptionOrBuilder
-
getAckDeadlineSeconds
public int getAckDeadlineSeconds()Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getAckDeadlineSeconds
in interfaceSubscriptionOrBuilder
- Returns:
- The ackDeadlineSeconds.
-
setAckDeadlineSeconds
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
- Parameters:
value
- The ackDeadlineSeconds to set.- Returns:
- This builder for chaining.
-
clearAckDeadlineSeconds
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
- Returns:
- This builder for chaining.
-
getRetainAckedMessages
public boolean getRetainAckedMessages()Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getRetainAckedMessages
in interfaceSubscriptionOrBuilder
- Returns:
- The retainAckedMessages.
-
setRetainAckedMessages
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
- Parameters:
value
- The retainAckedMessages to set.- Returns:
- This builder for chaining.
-
clearRetainAckedMessages
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
- Returns:
- This builder for chaining.
-
hasMessageRetentionDuration
public boolean hasMessageRetentionDuration()Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
hasMessageRetentionDuration
in interfaceSubscriptionOrBuilder
- Returns:
- Whether the messageRetentionDuration field is set.
-
getMessageRetentionDuration
public com.google.protobuf.Duration getMessageRetentionDuration()Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getMessageRetentionDuration
in interfaceSubscriptionOrBuilder
- Returns:
- The messageRetentionDuration.
-
setMessageRetentionDuration
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
-
setMessageRetentionDuration
public Subscription.Builder setMessageRetentionDuration(com.google.protobuf.Duration.Builder builderForValue) Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
-
mergeMessageRetentionDuration
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
-
clearMessageRetentionDuration
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
-
getMessageRetentionDurationBuilder
public com.google.protobuf.Duration.Builder getMessageRetentionDurationBuilder()Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
-
getMessageRetentionDurationOrBuilder
public com.google.protobuf.DurationOrBuilder getMessageRetentionDurationOrBuilder()Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getMessageRetentionDurationOrBuilder
in interfaceSubscriptionOrBuilder
-
getLabelsCount
public int getLabelsCount()Description copied from interface:SubscriptionOrBuilder
Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getLabelsCount
in interfaceSubscriptionOrBuilder
-
containsLabels
Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
containsLabels
in interfaceSubscriptionOrBuilder
-
getLabels
Deprecated.UsegetLabelsMap()
instead.- Specified by:
getLabels
in interfaceSubscriptionOrBuilder
-
getLabelsMap
Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getLabelsMap
in interfaceSubscriptionOrBuilder
-
getLabelsOrDefault
Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getLabelsOrDefault
in interfaceSubscriptionOrBuilder
-
getLabelsOrThrow
Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getLabelsOrThrow
in interfaceSubscriptionOrBuilder
-
clearLabels
-
removeLabels
Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
-
getMutableLabels
Deprecated.Use alternate mutation accessors instead. -
putLabels
Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
-
putAllLabels
Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
-
getEnableMessageOrdering
public boolean getEnableMessageOrdering()Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getEnableMessageOrdering
in interfaceSubscriptionOrBuilder
- Returns:
- The enableMessageOrdering.
-
setEnableMessageOrdering
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
- Parameters:
value
- The enableMessageOrdering to set.- Returns:
- This builder for chaining.
-
clearEnableMessageOrdering
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
- Returns:
- This builder for chaining.
-
hasExpirationPolicy
public boolean hasExpirationPolicy()Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
hasExpirationPolicy
in interfaceSubscriptionOrBuilder
- Returns:
- Whether the expirationPolicy field is set.
-
getExpirationPolicy
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getExpirationPolicy
in interfaceSubscriptionOrBuilder
- Returns:
- The expirationPolicy.
-
setExpirationPolicy
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
-
setExpirationPolicy
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
-
mergeExpirationPolicy
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
-
clearExpirationPolicy
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
-
getExpirationPolicyBuilder
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
-
getExpirationPolicyOrBuilder
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getExpirationPolicyOrBuilder
in interfaceSubscriptionOrBuilder
-
getFilter
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getFilter
in interfaceSubscriptionOrBuilder
- Returns:
- The filter.
-
getFilterBytes
public com.google.protobuf.ByteString getFilterBytes()Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getFilterBytes
in interfaceSubscriptionOrBuilder
- Returns:
- The bytes for filter.
-
setFilter
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
- Parameters:
value
- The filter to set.- Returns:
- This builder for chaining.
-
clearFilter
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
- Returns:
- This builder for chaining.
-
setFilterBytes
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
- Parameters:
value
- The bytes for filter to set.- Returns:
- This builder for chaining.
-
hasDeadLetterPolicy
public boolean hasDeadLetterPolicy()Optional. 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 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 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
hasDeadLetterPolicy
in interfaceSubscriptionOrBuilder
- Returns:
- Whether the deadLetterPolicy field is set.
-
getDeadLetterPolicy
Optional. 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 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 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getDeadLetterPolicy
in interfaceSubscriptionOrBuilder
- Returns:
- The deadLetterPolicy.
-
setDeadLetterPolicy
Optional. 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 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 [(.google.api.field_behavior) = OPTIONAL];
-
setDeadLetterPolicy
Optional. 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 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 [(.google.api.field_behavior) = OPTIONAL];
-
mergeDeadLetterPolicy
Optional. 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 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 [(.google.api.field_behavior) = OPTIONAL];
-
clearDeadLetterPolicy
Optional. 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 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 [(.google.api.field_behavior) = OPTIONAL];
-
getDeadLetterPolicyBuilder
Optional. 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 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 [(.google.api.field_behavior) = OPTIONAL];
-
getDeadLetterPolicyOrBuilder
Optional. 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 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 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getDeadLetterPolicyOrBuilder
in interfaceSubscriptionOrBuilder
-
hasRetryPolicy
public boolean hasRetryPolicy()Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
hasRetryPolicy
in interfaceSubscriptionOrBuilder
- Returns:
- Whether the retryPolicy field is set.
-
getRetryPolicy
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getRetryPolicy
in interfaceSubscriptionOrBuilder
- Returns:
- The retryPolicy.
-
setRetryPolicy
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
-
setRetryPolicy
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
-
mergeRetryPolicy
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
-
clearRetryPolicy
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
-
getRetryPolicyBuilder
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
-
getRetryPolicyOrBuilder
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getRetryPolicyOrBuilder
in interfaceSubscriptionOrBuilder
-
getDetached
public boolean getDetached()Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getDetached
in interfaceSubscriptionOrBuilder
- Returns:
- The detached.
-
setDetached
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
- Parameters:
value
- The detached to set.- Returns:
- This builder for chaining.
-
clearDetached
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
- Returns:
- This builder for chaining.
-
getEnableExactlyOnceDelivery
public boolean getEnableExactlyOnceDelivery()Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getEnableExactlyOnceDelivery
in interfaceSubscriptionOrBuilder
- Returns:
- The enableExactlyOnceDelivery.
-
setEnableExactlyOnceDelivery
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
- Parameters:
value
- The enableExactlyOnceDelivery to set.- Returns:
- This builder for chaining.
-
clearEnableExactlyOnceDelivery
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
- Returns:
- This builder for chaining.
-
hasTopicMessageRetentionDuration
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];
- Specified by:
hasTopicMessageRetentionDuration
in interfaceSubscriptionOrBuilder
- Returns:
- Whether the topicMessageRetentionDuration field is set.
-
getTopicMessageRetentionDuration
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];
- Specified by:
getTopicMessageRetentionDuration
in interfaceSubscriptionOrBuilder
- Returns:
- The topicMessageRetentionDuration.
-
setTopicMessageRetentionDuration
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];
-
setTopicMessageRetentionDuration
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];
-
mergeTopicMessageRetentionDuration
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];
-
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];
-
getTopicMessageRetentionDurationBuilder
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];
-
getTopicMessageRetentionDurationOrBuilder
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];
- Specified by:
getTopicMessageRetentionDurationOrBuilder
in interfaceSubscriptionOrBuilder
-
getStateValue
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];
- Specified by:
getStateValue
in interfaceSubscriptionOrBuilder
- Returns:
- The enum numeric value on the wire for state.
-
setStateValue
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];
- Parameters:
value
- The enum numeric value on the wire for state to set.- Returns:
- This builder for chaining.
-
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];
- Specified by:
getState
in interfaceSubscriptionOrBuilder
- Returns:
- The state.
-
setState
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];
- Parameters:
value
- The state to set.- Returns:
- This builder for chaining.
-
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];
- Returns:
- This builder for chaining.
-
setUnknownFields
public final Subscription.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
setUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>
-
mergeUnknownFields
public final Subscription.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
mergeUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>
-