com.google.pubsub.v1.SubscriptionOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-pubsub-v1 Show documentation
Show all versions of proto-google-cloud-pubsub-v1 Show documentation
PROTO library for proto-google-cloud-pubsub-v1
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/pubsub/v1/pubsub.proto
// Protobuf Java Version: 3.25.3
package com.google.pubsub.v1;
public interface SubscriptionOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.pubsub.v1.Subscription)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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];
*
* @return The name.
*/
java.lang.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];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* 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) = { ... }
*
*
* @return The topic.
*/
java.lang.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) = { ... }
*
*
* @return The bytes for topic.
*/
com.google.protobuf.ByteString getTopicBytes();
/**
*
*
*
* Optional. If push delivery is used with this subscription, this field is
* used to configure it.
*
*
* .google.pubsub.v1.PushConfig push_config = 4 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the pushConfig field is set.
*/
boolean hasPushConfig();
/**
*
*
*
* Optional. If push delivery is used with this subscription, this field is
* used to configure it.
*
*
* .google.pubsub.v1.PushConfig push_config = 4 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The pushConfig.
*/
com.google.pubsub.v1.PushConfig getPushConfig();
/**
*
*
*
* Optional. If push delivery is used with this subscription, this field is
* used to configure it.
*
*
* .google.pubsub.v1.PushConfig push_config = 4 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.pubsub.v1.PushConfigOrBuilder getPushConfigOrBuilder();
/**
*
*
*
* Optional. If delivery to BigQuery is used with this subscription, this
* field is used to configure it.
*
*
*
* .google.pubsub.v1.BigQueryConfig bigquery_config = 18 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the bigqueryConfig field is set.
*/
boolean hasBigqueryConfig();
/**
*
*
*
* Optional. If delivery to BigQuery is used with this subscription, this
* field is used to configure it.
*
*
*
* .google.pubsub.v1.BigQueryConfig bigquery_config = 18 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The bigqueryConfig.
*/
com.google.pubsub.v1.BigQueryConfig getBigqueryConfig();
/**
*
*
*
* Optional. If delivery to BigQuery is used with this subscription, this
* field is used to configure it.
*
*
*
* .google.pubsub.v1.BigQueryConfig bigquery_config = 18 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.pubsub.v1.BigQueryConfigOrBuilder getBigqueryConfigOrBuilder();
/**
*
*
*
* Optional. If delivery to Google Cloud Storage is used with this
* subscription, this field is used to configure it.
*
*
*
* .google.pubsub.v1.CloudStorageConfig cloud_storage_config = 22 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the cloudStorageConfig field is set.
*/
boolean hasCloudStorageConfig();
/**
*
*
*
* Optional. If delivery to Google Cloud Storage is used with this
* subscription, this field is used to configure it.
*
*
*
* .google.pubsub.v1.CloudStorageConfig cloud_storage_config = 22 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The cloudStorageConfig.
*/
com.google.pubsub.v1.CloudStorageConfig getCloudStorageConfig();
/**
*
*
*
* Optional. If delivery to Google Cloud Storage is used with this
* subscription, this field is used to configure it.
*
*
*
* .google.pubsub.v1.CloudStorageConfig cloud_storage_config = 22 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.pubsub.v1.CloudStorageConfigOrBuilder getCloudStorageConfigOrBuilder();
/**
*
*
*
* Optional. The approximate amount of time (on a best-effort basis) Pub/Sub
* waits for the subscriber to acknowledge receipt before resending the
* message. In the interval after the message is delivered and before it is
* acknowledged, it is considered to be _outstanding_. During that time
* period, the message will not be redelivered (on a best-effort basis).
*
* For pull subscriptions, this value is used as the initial value for the ack
* deadline. To override this value for a given message, call
* `ModifyAckDeadline` with the corresponding `ack_id` if using
* non-streaming pull or send the `ack_id` in a
* `StreamingModifyAckDeadlineRequest` if using streaming pull.
* The minimum custom deadline you can specify is 10 seconds.
* The maximum custom deadline you can specify is 600 seconds (10 minutes).
* If this parameter is 0, a default value of 10 seconds is used.
*
* For push delivery, this value is also used to set the request timeout for
* the call to the push endpoint.
*
* If the subscriber never acknowledges the message, the Pub/Sub
* system will eventually redeliver the message.
*
*
* int32 ack_deadline_seconds = 5 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The ackDeadlineSeconds.
*/
int getAckDeadlineSeconds();
/**
*
*
*
* Optional. Indicates whether to retain acknowledged messages. If true, then
* messages are not expunged from the subscription's backlog, even if they are
* acknowledged, until they fall out of the `message_retention_duration`
* window. This must be true if you would like to [`Seek` to a timestamp]
* (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in
* the past to replay previously-acknowledged messages.
*
*
* bool retain_acked_messages = 7 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The retainAckedMessages.
*/
boolean getRetainAckedMessages();
/**
*
*
*
* Optional. How long to retain unacknowledged messages in the subscription's
* backlog, from the moment a message is published. If `retain_acked_messages`
* is true, then this also configures the retention of acknowledged messages,
* and thus configures how far back in time a `Seek` can be done. Defaults to
* 7 days. Cannot be more than 7 days or less than 10 minutes.
*
*
*
* .google.protobuf.Duration message_retention_duration = 8 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the messageRetentionDuration field is set.
*/
boolean hasMessageRetentionDuration();
/**
*
*
*
* Optional. How long to retain unacknowledged messages in the subscription's
* backlog, from the moment a message is published. If `retain_acked_messages`
* is true, then this also configures the retention of acknowledged messages,
* and thus configures how far back in time a `Seek` can be done. Defaults to
* 7 days. Cannot be more than 7 days or less than 10 minutes.
*
*
*
* .google.protobuf.Duration message_retention_duration = 8 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The messageRetentionDuration.
*/
com.google.protobuf.Duration getMessageRetentionDuration();
/**
*
*
*
* Optional. How long to retain unacknowledged messages in the subscription's
* backlog, from the moment a message is published. If `retain_acked_messages`
* is true, then this also configures the retention of acknowledged messages,
* and thus configures how far back in time a `Seek` can be done. Defaults to
* 7 days. Cannot be more than 7 days or less than 10 minutes.
*
*
*
* .google.protobuf.Duration message_retention_duration = 8 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.protobuf.DurationOrBuilder getMessageRetentionDurationOrBuilder();
/**
*
*
*
* Optional. See [Creating and managing
* labels](https://cloud.google.com/pubsub/docs/labels).
*
*
* map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
*/
int getLabelsCount();
/**
*
*
*
* Optional. See [Creating and managing
* labels](https://cloud.google.com/pubsub/docs/labels).
*
*
* map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* Optional. See [Creating and managing
* labels](https://cloud.google.com/pubsub/docs/labels).
*
*
* map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
*/
java.util.Map 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();
}