Package com.google.pubsub.v1
Class Subscription
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.pubsub.v1.Subscription
-
- All Implemented Interfaces:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,SubscriptionOrBuilder,Serializable
public final class Subscription extends com.google.protobuf.GeneratedMessageV3 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 typegoogle.pubsub.v1.Subscription- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classSubscription.BuilderA subscription resource.static classSubscription.StatePossible states for a subscription.-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description static intACK_DEADLINE_SECONDS_FIELD_NUMBERstatic intBIGQUERY_CONFIG_FIELD_NUMBERstatic intCLOUD_STORAGE_CONFIG_FIELD_NUMBERstatic intDEAD_LETTER_POLICY_FIELD_NUMBERstatic intDETACHED_FIELD_NUMBERstatic intENABLE_EXACTLY_ONCE_DELIVERY_FIELD_NUMBERstatic intENABLE_MESSAGE_ORDERING_FIELD_NUMBERstatic intEXPIRATION_POLICY_FIELD_NUMBERstatic intFILTER_FIELD_NUMBERstatic intLABELS_FIELD_NUMBERstatic intMESSAGE_RETENTION_DURATION_FIELD_NUMBERstatic intNAME_FIELD_NUMBERstatic intPUSH_CONFIG_FIELD_NUMBERstatic intRETAIN_ACKED_MESSAGES_FIELD_NUMBERstatic intRETRY_POLICY_FIELD_NUMBERstatic intSTATE_FIELD_NUMBERstatic intTOPIC_FIELD_NUMBERstatic intTOPIC_MESSAGE_RETENTION_DURATION_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description booleancontainsLabels(String key)See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).booleanequals(Object obj)intgetAckDeadlineSeconds()The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message.BigQueryConfiggetBigqueryConfig()If delivery to BigQuery is used with this subscription, this field is used to configure it.BigQueryConfigOrBuildergetBigqueryConfigOrBuilder()If delivery to BigQuery is used with this subscription, this field is used to configure it.CloudStorageConfiggetCloudStorageConfig()If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.CloudStorageConfigOrBuildergetCloudStorageConfigOrBuilder()If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.DeadLetterPolicygetDeadLetterPolicy()A policy that specifies the conditions for dead lettering messages in this subscription.DeadLetterPolicyOrBuildergetDeadLetterPolicyOrBuilder()A policy that specifies the conditions for dead lettering messages in this subscription.static SubscriptiongetDefaultInstance()SubscriptiongetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()booleangetDetached()Indicates whether the subscription is detached from its topic.booleangetEnableExactlyOnceDelivery()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.booleangetEnableMessageOrdering()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.ExpirationPolicygetExpirationPolicy()A policy that specifies the conditions for this subscription's expiration.ExpirationPolicyOrBuildergetExpirationPolicyOrBuilder()A policy that specifies the conditions for this subscription's expiration.StringgetFilter()An expression written in the Pub/Sub [filter language](https://cloud.google.com/pubsub/docs/filtering).com.google.protobuf.ByteStringgetFilterBytes()An expression written in the Pub/Sub [filter language](https://cloud.google.com/pubsub/docs/filtering).Map<String,String>getLabels()Deprecated.intgetLabelsCount()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).StringgetLabelsOrDefault(String key, String defaultValue)See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).StringgetLabelsOrThrow(String key)See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).com.google.protobuf.DurationgetMessageRetentionDuration()How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.com.google.protobuf.DurationOrBuildergetMessageRetentionDurationOrBuilder()How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.StringgetName()Required.com.google.protobuf.ByteStringgetNameBytes()Required.com.google.protobuf.Parser<Subscription>getParserForType()PushConfiggetPushConfig()If push delivery is used with this subscription, this field is used to configure it.PushConfigOrBuildergetPushConfigOrBuilder()If push delivery is used with this subscription, this field is used to configure it.booleangetRetainAckedMessages()Indicates whether to retain acknowledged messages.RetryPolicygetRetryPolicy()A policy that specifies how Pub/Sub retries message delivery for this subscription.RetryPolicyOrBuildergetRetryPolicyOrBuilder()A policy that specifies how Pub/Sub retries message delivery for this subscription.intgetSerializedSize()Subscription.StategetState()Output only.intgetStateValue()Output only.StringgetTopic()Required.com.google.protobuf.ByteStringgetTopicBytes()Required.com.google.protobuf.DurationgetTopicMessageRetentionDuration()Output only.com.google.protobuf.DurationOrBuildergetTopicMessageRetentionDurationOrBuilder()Output only.booleanhasBigqueryConfig()If delivery to BigQuery is used with this subscription, this field is used to configure it.booleanhasCloudStorageConfig()If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.booleanhasDeadLetterPolicy()A policy that specifies the conditions for dead lettering messages in this subscription.booleanhasExpirationPolicy()A policy that specifies the conditions for this subscription's expiration.inthashCode()booleanhasMessageRetentionDuration()How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.booleanhasPushConfig()If push delivery is used with this subscription, this field is used to configure it.booleanhasRetryPolicy()A policy that specifies how Pub/Sub retries message delivery for this subscription.booleanhasTopicMessageRetentionDuration()Output only.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()protected com.google.protobuf.MapFieldinternalGetMapField(int number)booleanisInitialized()static Subscription.BuildernewBuilder()static Subscription.BuildernewBuilder(Subscription prototype)Subscription.BuildernewBuilderForType()protected Subscription.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)static SubscriptionparseDelimitedFrom(InputStream input)static SubscriptionparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static SubscriptionparseFrom(byte[] data)static SubscriptionparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static SubscriptionparseFrom(com.google.protobuf.ByteString data)static SubscriptionparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static SubscriptionparseFrom(com.google.protobuf.CodedInputStream input)static SubscriptionparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static SubscriptionparseFrom(InputStream input)static SubscriptionparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static SubscriptionparseFrom(ByteBuffer data)static SubscriptionparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static com.google.protobuf.Parser<Subscription>parser()Subscription.BuildertoBuilder()voidwriteTo(com.google.protobuf.CodedOutputStream output)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TOPIC_FIELD_NUMBER
public static final int TOPIC_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PUSH_CONFIG_FIELD_NUMBER
public static final int PUSH_CONFIG_FIELD_NUMBER
- See Also:
- Constant Field Values
-
BIGQUERY_CONFIG_FIELD_NUMBER
public static final int BIGQUERY_CONFIG_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CLOUD_STORAGE_CONFIG_FIELD_NUMBER
public static final int CLOUD_STORAGE_CONFIG_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ACK_DEADLINE_SECONDS_FIELD_NUMBER
public static final int ACK_DEADLINE_SECONDS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
RETAIN_ACKED_MESSAGES_FIELD_NUMBER
public static final int RETAIN_ACKED_MESSAGES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
MESSAGE_RETENTION_DURATION_FIELD_NUMBER
public static final int MESSAGE_RETENTION_DURATION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ENABLE_MESSAGE_ORDERING_FIELD_NUMBER
public static final int ENABLE_MESSAGE_ORDERING_FIELD_NUMBER
- See Also:
- Constant Field Values
-
EXPIRATION_POLICY_FIELD_NUMBER
public static final int EXPIRATION_POLICY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DEAD_LETTER_POLICY_FIELD_NUMBER
public static final int DEAD_LETTER_POLICY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
RETRY_POLICY_FIELD_NUMBER
public static final int RETRY_POLICY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DETACHED_FIELD_NUMBER
public static final int DETACHED_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ENABLE_EXACTLY_ONCE_DELIVERY_FIELD_NUMBER
public static final int ENABLE_EXACTLY_ONCE_DELIVERY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TOPIC_MESSAGE_RETENTION_DURATION_FIELD_NUMBER
public static final int TOPIC_MESSAGE_RETENTION_DURATION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetMapField
protected com.google.protobuf.MapField internalGetMapField(int number)
- Overrides:
internalGetMapFieldin classcom.google.protobuf.GeneratedMessageV3
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
getName
public String getName()
Required. The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.string name = 1 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getNamein 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:
getNameBytesin interfaceSubscriptionOrBuilder- Returns:
- The bytes for name.
-
getTopic
public String getTopic()
Required. The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. The value of this field will be `_deleted-topic_` if the topic has been deleted.string topic = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }- Specified by:
getTopicin 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:
getTopicBytesin interfaceSubscriptionOrBuilder- Returns:
- The bytes for topic.
-
hasPushConfig
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;- Specified by:
hasPushConfigin interfaceSubscriptionOrBuilder- Returns:
- Whether the pushConfig field is set.
-
getPushConfig
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;- Specified by:
getPushConfigin interfaceSubscriptionOrBuilder- Returns:
- The pushConfig.
-
getPushConfigOrBuilder
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;- Specified by:
getPushConfigOrBuilderin interfaceSubscriptionOrBuilder
-
hasBigqueryConfig
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;- Specified by:
hasBigqueryConfigin interfaceSubscriptionOrBuilder- Returns:
- Whether the bigqueryConfig field is set.
-
getBigqueryConfig
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;- Specified by:
getBigqueryConfigin interfaceSubscriptionOrBuilder- Returns:
- The bigqueryConfig.
-
getBigqueryConfigOrBuilder
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;- Specified by:
getBigqueryConfigOrBuilderin interfaceSubscriptionOrBuilder
-
hasCloudStorageConfig
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;- Specified by:
hasCloudStorageConfigin interfaceSubscriptionOrBuilder- Returns:
- Whether the cloudStorageConfig field is set.
-
getCloudStorageConfig
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;- Specified by:
getCloudStorageConfigin interfaceSubscriptionOrBuilder- Returns:
- The cloudStorageConfig.
-
getCloudStorageConfigOrBuilder
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;- Specified by:
getCloudStorageConfigOrBuilderin interfaceSubscriptionOrBuilder
-
getAckDeadlineSeconds
public int getAckDeadlineSeconds()
The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be _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;- Specified by:
getAckDeadlineSecondsin interfaceSubscriptionOrBuilder- Returns:
- The ackDeadlineSeconds.
-
getRetainAckedMessages
public boolean getRetainAckedMessages()
Indicates whether to retain acknowledged messages. If true, then messages are not expunged from the subscription's backlog, even if they are acknowledged, until they fall out of the `message_retention_duration` window. This must be true if you would like to [`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;- Specified by:
getRetainAckedMessagesin interfaceSubscriptionOrBuilder- Returns:
- The retainAckedMessages.
-
hasMessageRetentionDuration
public boolean hasMessageRetentionDuration()
How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes.
.google.protobuf.Duration message_retention_duration = 8;- Specified by:
hasMessageRetentionDurationin interfaceSubscriptionOrBuilder- Returns:
- Whether the messageRetentionDuration field is set.
-
getMessageRetentionDuration
public com.google.protobuf.Duration getMessageRetentionDuration()
How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes.
.google.protobuf.Duration message_retention_duration = 8;- Specified by:
getMessageRetentionDurationin interfaceSubscriptionOrBuilder- Returns:
- The messageRetentionDuration.
-
getMessageRetentionDurationOrBuilder
public com.google.protobuf.DurationOrBuilder getMessageRetentionDurationOrBuilder()
How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes.
.google.protobuf.Duration message_retention_duration = 8;- Specified by:
getMessageRetentionDurationOrBuilderin interfaceSubscriptionOrBuilder
-
getLabelsCount
public int getLabelsCount()
Description copied from interface:SubscriptionOrBuilderSee [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 9;- Specified by:
getLabelsCountin interfaceSubscriptionOrBuilder
-
containsLabels
public boolean containsLabels(String key)
See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 9;- Specified by:
containsLabelsin interfaceSubscriptionOrBuilder
-
getLabels
@Deprecated public Map<String,String> getLabels()
Deprecated.UsegetLabelsMap()instead.- Specified by:
getLabelsin interfaceSubscriptionOrBuilder
-
getLabelsMap
public Map<String,String> getLabelsMap()
See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 9;- Specified by:
getLabelsMapin interfaceSubscriptionOrBuilder
-
getLabelsOrDefault
public String getLabelsOrDefault(String key, String defaultValue)
See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 9;- Specified by:
getLabelsOrDefaultin interfaceSubscriptionOrBuilder
-
getLabelsOrThrow
public String getLabelsOrThrow(String key)
See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 9;- Specified by:
getLabelsOrThrowin interfaceSubscriptionOrBuilder
-
getEnableMessageOrdering
public boolean getEnableMessageOrdering()
If true, messages published with the same `ordering_key` in `PubsubMessage` will be delivered to the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they may be delivered in any order.
bool enable_message_ordering = 10;- Specified by:
getEnableMessageOrderingin interfaceSubscriptionOrBuilder- Returns:
- The enableMessageOrdering.
-
hasExpirationPolicy
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;- Specified by:
hasExpirationPolicyin interfaceSubscriptionOrBuilder- Returns:
- Whether the expirationPolicy field is set.
-
getExpirationPolicy
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;- Specified by:
getExpirationPolicyin interfaceSubscriptionOrBuilder- Returns:
- The expirationPolicy.
-
getExpirationPolicyOrBuilder
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;- Specified by:
getExpirationPolicyOrBuilderin interfaceSubscriptionOrBuilder
-
getFilter
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;- Specified by:
getFilterin interfaceSubscriptionOrBuilder- Returns:
- The filter.
-
getFilterBytes
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;- Specified by:
getFilterBytesin interfaceSubscriptionOrBuilder- Returns:
- The bytes for filter.
-
hasDeadLetterPolicy
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;- Specified by:
hasDeadLetterPolicyin interfaceSubscriptionOrBuilder- Returns:
- Whether the deadLetterPolicy field is set.
-
getDeadLetterPolicy
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;- Specified by:
getDeadLetterPolicyin interfaceSubscriptionOrBuilder- Returns:
- The deadLetterPolicy.
-
getDeadLetterPolicyOrBuilder
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;- Specified by:
getDeadLetterPolicyOrBuilderin interfaceSubscriptionOrBuilder
-
hasRetryPolicy
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;- Specified by:
hasRetryPolicyin interfaceSubscriptionOrBuilder- Returns:
- Whether the retryPolicy field is set.
-
getRetryPolicy
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;- Specified by:
getRetryPolicyin interfaceSubscriptionOrBuilder- Returns:
- The retryPolicy.
-
getRetryPolicyOrBuilder
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;- Specified by:
getRetryPolicyOrBuilderin interfaceSubscriptionOrBuilder
-
getDetached
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;- Specified by:
getDetachedin interfaceSubscriptionOrBuilder- Returns:
- The detached.
-
getEnableExactlyOnceDelivery
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;- Specified by:
getEnableExactlyOnceDeliveryin interfaceSubscriptionOrBuilder- Returns:
- The enableExactlyOnceDelivery.
-
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:
hasTopicMessageRetentionDurationin 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:
getTopicMessageRetentionDurationin interfaceSubscriptionOrBuilder- Returns:
- The topicMessageRetentionDuration.
-
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:
getTopicMessageRetentionDurationOrBuilderin 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:
getStateValuein interfaceSubscriptionOrBuilder- Returns:
- The enum numeric value on the wire for state.
-
getState
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];- Specified by:
getStatein interfaceSubscriptionOrBuilder- Returns:
- The state.
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Subscription parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Subscription parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Subscription parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Subscription parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Subscription parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Subscription parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Subscription parseFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static Subscription parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static Subscription parseDelimitedFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static Subscription parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseFrom
public static Subscription parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static Subscription parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
newBuilderForType
public Subscription.Builder newBuilderForType()
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
public static Subscription.Builder newBuilder()
-
newBuilder
public static Subscription.Builder newBuilder(Subscription prototype)
-
toBuilder
public Subscription.Builder toBuilder()
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Subscription.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static Subscription getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<Subscription> parser()
-
getParserForType
public com.google.protobuf.Parser<Subscription> getParserForType()
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public Subscription getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
-