public static final class Subscription.Builder extends GeneratedMessageV3.Builder<Subscription.Builder> implements SubscriptionOrBuilder
A subscription resource.Protobuf type
google.pubsub.v1.Subscription| Modifier and Type | Method and Description |
|---|---|
Subscription.Builder |
addRepeatedField(Descriptors.FieldDescriptor field,
java.lang.Object value) |
Subscription |
build() |
Subscription |
buildPartial() |
Subscription.Builder |
clear() |
Subscription.Builder |
clearAckDeadlineSeconds()
This value is the maximum time after a subscriber receives a message
before the subscriber should acknowledge the message.
|
Subscription.Builder |
clearField(Descriptors.FieldDescriptor field) |
Subscription.Builder |
clearLabels() |
Subscription.Builder |
clearMessageRetentionDuration()
How long to retain unacknowledged messages in the subscription's backlog,
from the moment a message is published.
|
Subscription.Builder |
clearName()
The name of the subscription.
|
Subscription.Builder |
clearOneof(Descriptors.OneofDescriptor oneof) |
Subscription.Builder |
clearPushConfig()
If push delivery is used with this subscription, this field is
used to configure it.
|
Subscription.Builder |
clearRetainAckedMessages()
Indicates whether to retain acknowledged messages.
|
Subscription.Builder |
clearTopic()
The name of the topic from which this subscription is receiving messages.
|
Subscription.Builder |
clone() |
boolean |
containsLabels(java.lang.String key)
User labels.
|
int |
getAckDeadlineSeconds()
This value is the maximum time after a subscriber receives a message
before the subscriber should acknowledge the message.
|
Subscription |
getDefaultInstanceForType() |
static Descriptors.Descriptor |
getDescriptor() |
Descriptors.Descriptor |
getDescriptorForType() |
java.util.Map<java.lang.String,java.lang.String> |
getLabels()
Deprecated.
|
int |
getLabelsCount()
User labels.
|
java.util.Map<java.lang.String,java.lang.String> |
getLabelsMap()
User labels.
|
java.lang.String |
getLabelsOrDefault(java.lang.String key,
java.lang.String defaultValue)
User labels.
|
java.lang.String |
getLabelsOrThrow(java.lang.String key)
User labels.
|
Duration |
getMessageRetentionDuration()
How long to retain unacknowledged messages in the subscription's backlog,
from the moment a message is published.
|
Duration.Builder |
getMessageRetentionDurationBuilder()
How long to retain unacknowledged messages in the subscription's backlog,
from the moment a message is published.
|
DurationOrBuilder |
getMessageRetentionDurationOrBuilder()
How long to retain unacknowledged messages in the subscription's backlog,
from the moment a message is published.
|
java.util.Map<java.lang.String,java.lang.String> |
getMutableLabels()
Deprecated.
|
java.lang.String |
getName()
The name of the subscription.
|
ByteString |
getNameBytes()
The name of the subscription.
|
PushConfig |
getPushConfig()
If push delivery is used with this subscription, this field is
used to configure it.
|
PushConfig.Builder |
getPushConfigBuilder()
If push delivery is used with this subscription, this field is
used to configure it.
|
PushConfigOrBuilder |
getPushConfigOrBuilder()
If push delivery is used with this subscription, this field is
used to configure it.
|
boolean |
getRetainAckedMessages()
Indicates whether to retain acknowledged messages.
|
java.lang.String |
getTopic()
The name of the topic from which this subscription is receiving messages.
|
ByteString |
getTopicBytes()
The name of the topic from which this subscription is receiving messages.
|
boolean |
hasMessageRetentionDuration()
How long to retain unacknowledged messages in the subscription's backlog,
from the moment a message is published.
|
boolean |
hasPushConfig()
If push delivery is used with this subscription, this field is
used to configure it.
|
protected GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected MapField |
internalGetMapField(int number) |
protected MapField |
internalGetMutableMapField(int number) |
boolean |
isInitialized() |
Subscription.Builder |
mergeFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry) |
Subscription.Builder |
mergeFrom(Message other) |
Subscription.Builder |
mergeFrom(Subscription other) |
Subscription.Builder |
mergeMessageRetentionDuration(Duration value)
How long to retain unacknowledged messages in the subscription's backlog,
from the moment a message is published.
|
Subscription.Builder |
mergePushConfig(PushConfig value)
If push delivery is used with this subscription, this field is
used to configure it.
|
Subscription.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields) |
Subscription.Builder |
putAllLabels(java.util.Map<java.lang.String,java.lang.String> values)
User labels.
|
Subscription.Builder |
putLabels(java.lang.String key,
java.lang.String value)
User labels.
|
Subscription.Builder |
removeLabels(java.lang.String key)
User labels.
|
Subscription.Builder |
setAckDeadlineSeconds(int value)
This value is the maximum time after a subscriber receives a message
before the subscriber should acknowledge the message.
|
Subscription.Builder |
setField(Descriptors.FieldDescriptor field,
java.lang.Object value) |
Subscription.Builder |
setMessageRetentionDuration(Duration.Builder builderForValue)
How long to retain unacknowledged messages in the subscription's backlog,
from the moment a message is published.
|
Subscription.Builder |
setMessageRetentionDuration(Duration value)
How long to retain unacknowledged messages in the subscription's backlog,
from the moment a message is published.
|
Subscription.Builder |
setName(java.lang.String value)
The name of the subscription.
|
Subscription.Builder |
setNameBytes(ByteString value)
The name of the subscription.
|
Subscription.Builder |
setPushConfig(PushConfig.Builder builderForValue)
If push delivery is used with this subscription, this field is
used to configure it.
|
Subscription.Builder |
setPushConfig(PushConfig value)
If push delivery is used with this subscription, this field is
used to configure it.
|
Subscription.Builder |
setRepeatedField(Descriptors.FieldDescriptor field,
int index,
java.lang.Object value) |
Subscription.Builder |
setRetainAckedMessages(boolean value)
Indicates whether to retain acknowledged messages.
|
Subscription.Builder |
setTopic(java.lang.String value)
The name of the topic from which this subscription is receiving messages.
|
Subscription.Builder |
setTopicBytes(ByteString value)
The name of the topic from which this subscription is receiving messages.
|
Subscription.Builder |
setUnknownFields(UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofmergeFrompublic static final Descriptors.Descriptor getDescriptor()
protected MapField internalGetMapField(int number)
internalGetMapField in class GeneratedMessageV3.Builder<Subscription.Builder>protected MapField internalGetMutableMapField(int number)
internalGetMutableMapField in class GeneratedMessageV3.Builder<Subscription.Builder>protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<Subscription.Builder>public Subscription.Builder clear()
clear in interface Message.Builderclear in interface MessageLite.Builderclear in class GeneratedMessageV3.Builder<Subscription.Builder>public Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface Message.BuildergetDescriptorForType in interface MessageOrBuildergetDescriptorForType in class GeneratedMessageV3.Builder<Subscription.Builder>public Subscription getDefaultInstanceForType()
getDefaultInstanceForType in interface MessageLiteOrBuildergetDefaultInstanceForType in interface MessageOrBuilderpublic Subscription build()
build in interface Message.Builderbuild in interface MessageLite.Builderpublic Subscription buildPartial()
buildPartial in interface Message.BuilderbuildPartial in interface MessageLite.Builderpublic Subscription.Builder clone()
clone in interface Message.Builderclone in interface MessageLite.Builderclone in class GeneratedMessageV3.Builder<Subscription.Builder>public Subscription.Builder setField(Descriptors.FieldDescriptor field, java.lang.Object value)
setField in interface Message.BuildersetField in class GeneratedMessageV3.Builder<Subscription.Builder>public Subscription.Builder clearField(Descriptors.FieldDescriptor field)
clearField in interface Message.BuilderclearField in class GeneratedMessageV3.Builder<Subscription.Builder>public Subscription.Builder clearOneof(Descriptors.OneofDescriptor oneof)
clearOneof in interface Message.BuilderclearOneof in class GeneratedMessageV3.Builder<Subscription.Builder>public Subscription.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)
setRepeatedField in interface Message.BuildersetRepeatedField in class GeneratedMessageV3.Builder<Subscription.Builder>public Subscription.Builder addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)
addRepeatedField in interface Message.BuilderaddRepeatedField in class GeneratedMessageV3.Builder<Subscription.Builder>public Subscription.Builder mergeFrom(Message other)
mergeFrom in interface Message.BuildermergeFrom in class AbstractMessage.Builder<Subscription.Builder>public Subscription.Builder mergeFrom(Subscription other)
public final boolean isInitialized()
isInitialized in interface MessageLiteOrBuilderisInitialized in class GeneratedMessageV3.Builder<Subscription.Builder>public Subscription.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
mergeFrom in interface Message.BuildermergeFrom in interface MessageLite.BuildermergeFrom in class AbstractMessage.Builder<Subscription.Builder>java.io.IOExceptionpublic java.lang.String getName()
The name of the subscription. It must have the format
`"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
start with a letter, and contain only letters (`[A-Za-z]`), numbers
(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
in length, and it must not start with `"goog"`.
string name = 1;getName in interface SubscriptionOrBuilderpublic ByteString getNameBytes()
The name of the subscription. It must have the format
`"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
start with a letter, and contain only letters (`[A-Za-z]`), numbers
(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
in length, and it must not start with `"goog"`.
string name = 1;getNameBytes in interface SubscriptionOrBuilderpublic Subscription.Builder setName(java.lang.String value)
The name of the subscription. It must have the format
`"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
start with a letter, and contain only letters (`[A-Za-z]`), numbers
(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
in length, and it must not start with `"goog"`.
string name = 1;public Subscription.Builder clearName()
The name of the subscription. It must have the format
`"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
start with a letter, and contain only letters (`[A-Za-z]`), numbers
(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
in length, and it must not start with `"goog"`.
string name = 1;public Subscription.Builder setNameBytes(ByteString value)
The name of the subscription. It must have the format
`"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
start with a letter, and contain only letters (`[A-Za-z]`), numbers
(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
in length, and it must not start with `"goog"`.
string name = 1;public java.lang.String getTopic()
The name of the topic from which this subscription is receiving messages.
Format is `projects/{project}/topics/{topic}`.
The value of this field will be `_deleted-topic_` if the topic has been
deleted.
string topic = 2;getTopic in interface SubscriptionOrBuilderpublic ByteString getTopicBytes()
The name of the topic from which this subscription is receiving messages.
Format is `projects/{project}/topics/{topic}`.
The value of this field will be `_deleted-topic_` if the topic has been
deleted.
string topic = 2;getTopicBytes in interface SubscriptionOrBuilderpublic Subscription.Builder setTopic(java.lang.String value)
The name of the topic from which this subscription is receiving messages.
Format is `projects/{project}/topics/{topic}`.
The value of this field will be `_deleted-topic_` if the topic has been
deleted.
string topic = 2;public Subscription.Builder clearTopic()
The name of the topic from which this subscription is receiving messages.
Format is `projects/{project}/topics/{topic}`.
The value of this field will be `_deleted-topic_` if the topic has been
deleted.
string topic = 2;public Subscription.Builder setTopicBytes(ByteString value)
The name of the topic from which this subscription is receiving messages.
Format is `projects/{project}/topics/{topic}`.
The value of this field will be `_deleted-topic_` if the topic has been
deleted.
string topic = 2;public boolean hasPushConfig()
If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods.
.google.pubsub.v1.PushConfig push_config = 4;hasPushConfig in interface SubscriptionOrBuilderpublic PushConfig getPushConfig()
If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods.
.google.pubsub.v1.PushConfig push_config = 4;getPushConfig in interface SubscriptionOrBuilderpublic Subscription.Builder setPushConfig(PushConfig value)
If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods.
.google.pubsub.v1.PushConfig push_config = 4;public Subscription.Builder setPushConfig(PushConfig.Builder builderForValue)
If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods.
.google.pubsub.v1.PushConfig push_config = 4;public Subscription.Builder mergePushConfig(PushConfig value)
If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods.
.google.pubsub.v1.PushConfig push_config = 4;public Subscription.Builder clearPushConfig()
If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods.
.google.pubsub.v1.PushConfig push_config = 4;public PushConfig.Builder getPushConfigBuilder()
If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods.
.google.pubsub.v1.PushConfig push_config = 4;public PushConfigOrBuilder getPushConfigOrBuilder()
If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods.
.google.pubsub.v1.PushConfig push_config = 4;getPushConfigOrBuilder in interface SubscriptionOrBuilderpublic int getAckDeadlineSeconds()
This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (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 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 SubscriptionOrBuilderpublic Subscription.Builder setAckDeadlineSeconds(int value)
This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (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 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 Subscription.Builder clearAckDeadlineSeconds()
This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (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 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.
bool retain_acked_messages = 7;getRetainAckedMessages in interface SubscriptionOrBuilderpublic 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.
bool retain_acked_messages = 7;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.
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 SubscriptionOrBuilderpublic 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 SubscriptionOrBuilderpublic Subscription.Builder setMessageRetentionDuration(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(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(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 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 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 SubscriptionOrBuilderpublic int getLabelsCount()
SubscriptionOrBuilderUser labels.
map<string, string> labels = 9;getLabelsCount in interface SubscriptionOrBuilderpublic boolean containsLabels(java.lang.String key)
User labels.
map<string, string> labels = 9;containsLabels in interface SubscriptionOrBuilder@Deprecated public java.util.Map<java.lang.String,java.lang.String> getLabels()
getLabelsMap() instead.getLabels in interface SubscriptionOrBuilderpublic java.util.Map<java.lang.String,java.lang.String> getLabelsMap()
User labels.
map<string, string> labels = 9;getLabelsMap in interface SubscriptionOrBuilderpublic java.lang.String getLabelsOrDefault(java.lang.String key,
java.lang.String defaultValue)
User labels.
map<string, string> labels = 9;getLabelsOrDefault in interface SubscriptionOrBuilderpublic java.lang.String getLabelsOrThrow(java.lang.String key)
User labels.
map<string, string> labels = 9;getLabelsOrThrow in interface SubscriptionOrBuilderpublic Subscription.Builder clearLabels()
public Subscription.Builder removeLabels(java.lang.String key)
User labels.
map<string, string> labels = 9;@Deprecated public java.util.Map<java.lang.String,java.lang.String> getMutableLabels()
public Subscription.Builder putLabels(java.lang.String key, java.lang.String value)
User labels.
map<string, string> labels = 9;public Subscription.Builder putAllLabels(java.util.Map<java.lang.String,java.lang.String> values)
User labels.
map<string, string> labels = 9;public final Subscription.Builder setUnknownFields(UnknownFieldSet unknownFields)
setUnknownFields in interface Message.BuildersetUnknownFields in class GeneratedMessageV3.Builder<Subscription.Builder>public final Subscription.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
mergeUnknownFields in interface Message.BuildermergeUnknownFields in class GeneratedMessageV3.Builder<Subscription.Builder>