getLabelsMap();
/**
*
*
*
* Optional. See [Creating and managing
* labels](https://cloud.google.com/pubsub/docs/labels).
*
*
* map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* Optional. See [Creating and managing
* labels](https://cloud.google.com/pubsub/docs/labels).
*
*
* map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* Optional. If true, messages published with the same `ordering_key` in
* `PubsubMessage` will be delivered to the subscribers in the order in which
* they are received by the Pub/Sub system. Otherwise, they may be delivered
* in any order.
*
*
* bool enable_message_ordering = 10 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The enableMessageOrdering.
*/
boolean getEnableMessageOrdering();
/**
*
*
*
* Optional. A policy that specifies the conditions for this subscription's
* expiration. A subscription is considered active as long as any connected
* subscriber is successfully consuming messages from the subscription or is
* issuing operations on the subscription. If `expiration_policy` is not set,
* a *default policy* with `ttl` of 31 days will be used. The minimum allowed
* value for `expiration_policy.ttl` is 1 day. If `expiration_policy` is set,
* but `expiration_policy.ttl` is not set, the subscription never expires.
*
*
*
* .google.pubsub.v1.ExpirationPolicy expiration_policy = 11 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the expirationPolicy field is set.
*/
boolean hasExpirationPolicy();
/**
*
*
*
* Optional. A policy that specifies the conditions for this subscription's
* expiration. A subscription is considered active as long as any connected
* subscriber is successfully consuming messages from the subscription or is
* issuing operations on the subscription. If `expiration_policy` is not set,
* a *default policy* with `ttl` of 31 days will be used. The minimum allowed
* value for `expiration_policy.ttl` is 1 day. If `expiration_policy` is set,
* but `expiration_policy.ttl` is not set, the subscription never expires.
*
*
*
* .google.pubsub.v1.ExpirationPolicy expiration_policy = 11 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The expirationPolicy.
*/
com.google.pubsub.v1.ExpirationPolicy getExpirationPolicy();
/**
*
*
*
* Optional. A policy that specifies the conditions for this subscription's
* expiration. A subscription is considered active as long as any connected
* subscriber is successfully consuming messages from the subscription or is
* issuing operations on the subscription. If `expiration_policy` is not set,
* a *default policy* with `ttl` of 31 days will be used. The minimum allowed
* value for `expiration_policy.ttl` is 1 day. If `expiration_policy` is set,
* but `expiration_policy.ttl` is not set, the subscription never expires.
*
*
*
* .google.pubsub.v1.ExpirationPolicy expiration_policy = 11 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.pubsub.v1.ExpirationPolicyOrBuilder getExpirationPolicyOrBuilder();
/**
*
*
*
* Optional. An expression written in the Pub/Sub [filter
* language](https://cloud.google.com/pubsub/docs/filtering). If non-empty,
* then only `PubsubMessage`s whose `attributes` field matches the filter are
* delivered on this subscription. If empty, then no messages are filtered
* out.
*
*
* string filter = 12 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The filter.
*/
java.lang.String getFilter();
/**
*
*
*
* Optional. An expression written in the Pub/Sub [filter
* language](https://cloud.google.com/pubsub/docs/filtering). If non-empty,
* then only `PubsubMessage`s whose `attributes` field matches the filter are
* delivered on this subscription. If empty, then no messages are filtered
* out.
*
*
* string filter = 12 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for filter.
*/
com.google.protobuf.ByteString getFilterBytes();
/**
*
*
*
* Optional. A policy that specifies the conditions for dead lettering
* messages in this subscription. If dead_letter_policy is not set, dead
* lettering is disabled.
*
* The Pub/Sub service account associated with this subscriptions's
* parent project (i.e.,
* service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
* permission to Acknowledge() messages on this subscription.
*
*
*
* .google.pubsub.v1.DeadLetterPolicy dead_letter_policy = 13 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the deadLetterPolicy field is set.
*/
boolean hasDeadLetterPolicy();
/**
*
*
*
* Optional. A policy that specifies the conditions for dead lettering
* messages in this subscription. If dead_letter_policy is not set, dead
* lettering is disabled.
*
* The Pub/Sub service account associated with this subscriptions's
* parent project (i.e.,
* service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
* permission to Acknowledge() messages on this subscription.
*
*
*
* .google.pubsub.v1.DeadLetterPolicy dead_letter_policy = 13 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The deadLetterPolicy.
*/
com.google.pubsub.v1.DeadLetterPolicy getDeadLetterPolicy();
/**
*
*
*
* Optional. A policy that specifies the conditions for dead lettering
* messages in this subscription. If dead_letter_policy is not set, dead
* lettering is disabled.
*
* The Pub/Sub service account associated with this subscriptions's
* parent project (i.e.,
* service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
* permission to Acknowledge() messages on this subscription.
*
*
*
* .google.pubsub.v1.DeadLetterPolicy dead_letter_policy = 13 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.pubsub.v1.DeadLetterPolicyOrBuilder getDeadLetterPolicyOrBuilder();
/**
*
*
*
* Optional. A policy that specifies how Pub/Sub retries message delivery for
* this subscription.
*
* If not set, the default retry policy is applied. This generally implies
* that messages will be retried as soon as possible for healthy subscribers.
* RetryPolicy will be triggered on NACKs or acknowledgement deadline
* exceeded events for a given message.
*
*
*
* .google.pubsub.v1.RetryPolicy retry_policy = 14 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the retryPolicy field is set.
*/
boolean hasRetryPolicy();
/**
*
*
*
* Optional. A policy that specifies how Pub/Sub retries message delivery for
* this subscription.
*
* If not set, the default retry policy is applied. This generally implies
* that messages will be retried as soon as possible for healthy subscribers.
* RetryPolicy will be triggered on NACKs or acknowledgement deadline
* exceeded events for a given message.
*
*
*
* .google.pubsub.v1.RetryPolicy retry_policy = 14 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The retryPolicy.
*/
com.google.pubsub.v1.RetryPolicy getRetryPolicy();
/**
*
*
*
* Optional. A policy that specifies how Pub/Sub retries message delivery for
* this subscription.
*
* If not set, the default retry policy is applied. This generally implies
* that messages will be retried as soon as possible for healthy subscribers.
* RetryPolicy will be triggered on NACKs or acknowledgement deadline
* exceeded events for a given message.
*
*
*
* .google.pubsub.v1.RetryPolicy retry_policy = 14 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.pubsub.v1.RetryPolicyOrBuilder getRetryPolicyOrBuilder();
/**
*
*
*
* Optional. Indicates whether the subscription is detached from its topic.
* Detached subscriptions don't receive messages from their topic and don't
* retain any backlog. `Pull` and `StreamingPull` requests will return
* FAILED_PRECONDITION. If the subscription is a push subscription, pushes to
* the endpoint will not be made.
*
*
* bool detached = 15 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The detached.
*/
boolean getDetached();
/**
*
*
*
* Optional. If true, Pub/Sub provides the following guarantees for the
* delivery of a message with a given value of `message_id` on this
* subscription:
*
* * The message sent to a subscriber is guaranteed not to be resent
* before the message's acknowledgement deadline expires.
* * An acknowledged message will not be resent to a subscriber.
*
* Note that subscribers may still receive multiple copies of a message
* when `enable_exactly_once_delivery` is true if the message was published
* multiple times by a publisher client. These copies are considered distinct
* by Pub/Sub and have distinct `message_id` values.
*
*
* bool enable_exactly_once_delivery = 16 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The enableExactlyOnceDelivery.
*/
boolean getEnableExactlyOnceDelivery();
/**
*
*
*
* 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];
*
*
* @return Whether the topicMessageRetentionDuration field is set.
*/
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];
*
*
* @return The topicMessageRetentionDuration.
*/
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];
*
*/
com.google.protobuf.DurationOrBuilder getTopicMessageRetentionDurationOrBuilder();
/**
*
*
*
* 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];
*
*
* @return The enum numeric value on the wire for state.
*/
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];
*
*
* @return The state.
*/
com.google.pubsub.v1.Subscription.State getState();
/**
*
*
*
* Output only. Information about the associated Analytics Hub subscription.
* Only set if the subscritpion is created by Analytics Hub.
*
*
*
* .google.pubsub.v1.Subscription.AnalyticsHubSubscriptionInfo analytics_hub_subscription_info = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the analyticsHubSubscriptionInfo field is set.
*/
boolean hasAnalyticsHubSubscriptionInfo();
/**
*
*
*
* Output only. Information about the associated Analytics Hub subscription.
* Only set if the subscritpion is created by Analytics Hub.
*
*
*
* .google.pubsub.v1.Subscription.AnalyticsHubSubscriptionInfo analytics_hub_subscription_info = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The analyticsHubSubscriptionInfo.
*/
com.google.pubsub.v1.Subscription.AnalyticsHubSubscriptionInfo getAnalyticsHubSubscriptionInfo();
/**
*
*
*
* Output only. Information about the associated Analytics Hub subscription.
* Only set if the subscritpion is created by Analytics Hub.
*
*
*
* .google.pubsub.v1.Subscription.AnalyticsHubSubscriptionInfo analytics_hub_subscription_info = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.pubsub.v1.Subscription.AnalyticsHubSubscriptionInfoOrBuilder
getAnalyticsHubSubscriptionInfoOrBuilder();
}
