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 type
google.pubsub.v1.Subscription
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A subscription resource.static enum
Possible 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 Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Method Summary
Modifier and TypeMethodDescriptionboolean
containsLabels
(String key) See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).boolean
int
The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message.If delivery to BigQuery is used with this subscription, this field is used to configure it.If delivery to BigQuery is used with this subscription, this field is used to configure it.If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.A policy that specifies the conditions for dead lettering messages in this subscription.A policy that specifies the conditions for dead lettering messages in this subscription.static Subscription
static final com.google.protobuf.Descriptors.Descriptor
boolean
Indicates whether the subscription is detached from its topic.boolean
If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of `message_id` on this subscription: * The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires.boolean
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.A policy that specifies the conditions for this subscription's expiration.A policy that specifies the conditions for this subscription's expiration.An expression written in the Pub/Sub [filter language](https://cloud.google.com/pubsub/docs/filtering).com.google.protobuf.ByteString
An expression written in the Pub/Sub [filter language](https://cloud.google.com/pubsub/docs/filtering).Deprecated.int
See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).getLabelsOrDefault
(String key, String defaultValue) See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).getLabelsOrThrow
(String key) See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).com.google.protobuf.Duration
How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.com.google.protobuf.DurationOrBuilder
How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.getName()
Required.com.google.protobuf.ByteString
Required.com.google.protobuf.Parser<Subscription>
If push delivery is used with this subscription, this field is used to configure it.If push delivery is used with this subscription, this field is used to configure it.boolean
Indicates whether to retain acknowledged messages.A policy that specifies how Pub/Sub retries message delivery for this subscription.A policy that specifies how Pub/Sub retries message delivery for this subscription.int
getState()
Output only.int
Output only.getTopic()
Required.com.google.protobuf.ByteString
Required.com.google.protobuf.Duration
Output only.com.google.protobuf.DurationOrBuilder
Output only.boolean
If delivery to BigQuery is used with this subscription, this field is used to configure it.boolean
If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.boolean
A policy that specifies the conditions for dead lettering messages in this subscription.boolean
A policy that specifies the conditions for this subscription's expiration.int
hashCode()
boolean
How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.boolean
If push delivery is used with this subscription, this field is used to configure it.boolean
A policy that specifies how Pub/Sub retries message delivery for this subscription.boolean
Output only.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
protected com.google.protobuf.MapField
internalGetMapField
(int number) final boolean
static Subscription.Builder
static Subscription.Builder
newBuilder
(Subscription prototype) protected Subscription.Builder
newBuilderForType
(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected Object
newInstance
(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static Subscription
parseDelimitedFrom
(InputStream input) static Subscription
parseDelimitedFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Subscription
parseFrom
(byte[] data) static Subscription
parseFrom
(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Subscription
parseFrom
(com.google.protobuf.ByteString data) static Subscription
parseFrom
(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Subscription
parseFrom
(com.google.protobuf.CodedInputStream input) static Subscription
parseFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Subscription
parseFrom
(InputStream input) static Subscription
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Subscription
parseFrom
(ByteBuffer data) static Subscription
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<Subscription>
parser()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, 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
Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
TOPIC_FIELD_NUMBER
public static final int TOPIC_FIELD_NUMBER- See Also:
-
PUSH_CONFIG_FIELD_NUMBER
public static final int PUSH_CONFIG_FIELD_NUMBER- See Also:
-
BIGQUERY_CONFIG_FIELD_NUMBER
public static final int BIGQUERY_CONFIG_FIELD_NUMBER- See Also:
-
CLOUD_STORAGE_CONFIG_FIELD_NUMBER
public static final int CLOUD_STORAGE_CONFIG_FIELD_NUMBER- See Also:
-
ACK_DEADLINE_SECONDS_FIELD_NUMBER
public static final int ACK_DEADLINE_SECONDS_FIELD_NUMBER- See Also:
-
RETAIN_ACKED_MESSAGES_FIELD_NUMBER
public static final int RETAIN_ACKED_MESSAGES_FIELD_NUMBER- See Also:
-
MESSAGE_RETENTION_DURATION_FIELD_NUMBER
public static final int MESSAGE_RETENTION_DURATION_FIELD_NUMBER- See Also:
-
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER- See Also:
-
ENABLE_MESSAGE_ORDERING_FIELD_NUMBER
public static final int ENABLE_MESSAGE_ORDERING_FIELD_NUMBER- See Also:
-
EXPIRATION_POLICY_FIELD_NUMBER
public static final int EXPIRATION_POLICY_FIELD_NUMBER- See Also:
-
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER- See Also:
-
DEAD_LETTER_POLICY_FIELD_NUMBER
public static final int DEAD_LETTER_POLICY_FIELD_NUMBER- See Also:
-
RETRY_POLICY_FIELD_NUMBER
public static final int RETRY_POLICY_FIELD_NUMBER- See Also:
-
DETACHED_FIELD_NUMBER
public static final int DETACHED_FIELD_NUMBER- See Also:
-
ENABLE_EXACTLY_ONCE_DELIVERY_FIELD_NUMBER
public static final int ENABLE_EXACTLY_ONCE_DELIVERY_FIELD_NUMBER- See Also:
-
TOPIC_MESSAGE_RETENTION_DURATION_FIELD_NUMBER
public static final int TOPIC_MESSAGE_RETENTION_DURATION_FIELD_NUMBER- See Also:
-
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstance
in classcom.google.protobuf.GeneratedMessageV3
-
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
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3
-
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.
-
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.
-
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:
hasPushConfig
in interfaceSubscriptionOrBuilder
- Returns:
- Whether the pushConfig field is set.
-
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:
getPushConfig
in interfaceSubscriptionOrBuilder
- Returns:
- The pushConfig.
-
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:
getPushConfigOrBuilder
in 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:
hasBigqueryConfig
in interfaceSubscriptionOrBuilder
- Returns:
- Whether the bigqueryConfig field is set.
-
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:
getBigqueryConfig
in interfaceSubscriptionOrBuilder
- Returns:
- The bigqueryConfig.
-
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:
getBigqueryConfigOrBuilder
in 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:
hasCloudStorageConfig
in interfaceSubscriptionOrBuilder
- Returns:
- Whether the cloudStorageConfig field is set.
-
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:
getCloudStorageConfig
in interfaceSubscriptionOrBuilder
- Returns:
- The cloudStorageConfig.
-
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:
getCloudStorageConfigOrBuilder
in 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:
getAckDeadlineSeconds
in 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:
getRetainAckedMessages
in 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:
hasMessageRetentionDuration
in 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:
getMessageRetentionDuration
in 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:
getMessageRetentionDurationOrBuilder
in interfaceSubscriptionOrBuilder
-
getLabelsCount
public int getLabelsCount()Description copied from interface:SubscriptionOrBuilder
See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 9;
- Specified by:
getLabelsCount
in interfaceSubscriptionOrBuilder
-
containsLabels
See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 9;
- Specified by:
containsLabels
in interfaceSubscriptionOrBuilder
-
getLabels
Deprecated.UsegetLabelsMap()
instead.- Specified by:
getLabels
in interfaceSubscriptionOrBuilder
-
getLabelsMap
See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 9;
- Specified by:
getLabelsMap
in interfaceSubscriptionOrBuilder
-
getLabelsOrDefault
See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 9;
- Specified by:
getLabelsOrDefault
in interfaceSubscriptionOrBuilder
-
getLabelsOrThrow
See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 9;
- Specified by:
getLabelsOrThrow
in 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:
getEnableMessageOrdering
in 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:
hasExpirationPolicy
in interfaceSubscriptionOrBuilder
- Returns:
- Whether the expirationPolicy field is set.
-
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:
getExpirationPolicy
in interfaceSubscriptionOrBuilder
- Returns:
- The expirationPolicy.
-
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:
getExpirationPolicyOrBuilder
in interfaceSubscriptionOrBuilder
-
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:
getFilter
in 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:
getFilterBytes
in 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:
hasDeadLetterPolicy
in interfaceSubscriptionOrBuilder
- Returns:
- Whether the deadLetterPolicy field is set.
-
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:
getDeadLetterPolicy
in interfaceSubscriptionOrBuilder
- Returns:
- The deadLetterPolicy.
-
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:
getDeadLetterPolicyOrBuilder
in 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:
hasRetryPolicy
in interfaceSubscriptionOrBuilder
- Returns:
- Whether the retryPolicy field is set.
-
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:
getRetryPolicy
in interfaceSubscriptionOrBuilder
- Returns:
- The retryPolicy.
-
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:
getRetryPolicyOrBuilder
in 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:
getDetached
in 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:
getEnableExactlyOnceDelivery
in 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:
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.
-
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.
-
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.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in 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
- Throws:
IOException
-
parseFrom
public static Subscription parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static Subscription parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Subscription parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Subscription.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-