Package com.google.pubsub.v1

Interface SubscriptionOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Subscription, Subscription.Builder
public interface SubscriptionOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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];
      Returns:
      The name.

    • getNameBytes

      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];
      Returns:
      The bytes for name.

    • getTopic

      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) = { ... }
      Returns:
      The topic.

    • getTopicBytes

      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) = { ... }
      Returns:
      The bytes for topic.

    • hasPushConfig

      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];
      Returns:
      Whether the pushConfig field is set.

    • getPushConfig

      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];
      Returns:
      The pushConfig.

    • getPushConfigOrBuilder

      PushConfigOrBuilder getPushConfigOrBuilder()
       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];

    • hasBigqueryConfig

      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];
      Returns:
      Whether the bigqueryConfig field is set.

    • getBigqueryConfig

      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];
      Returns:
      The bigqueryConfig.

    • getBigqueryConfigOrBuilder

      BigQueryConfigOrBuilder getBigqueryConfigOrBuilder()
       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];

    • hasCloudStorageConfig

      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];
      Returns:
      Whether the cloudStorageConfig field is set.

    • getCloudStorageConfig

      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];
      Returns:
      The cloudStorageConfig.

    • getCloudStorageConfigOrBuilder

      CloudStorageConfigOrBuilder getCloudStorageConfigOrBuilder()
       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];

    • getAckDeadlineSeconds

      int getAckDeadlineSeconds()
       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];
      Returns:
      The ackDeadlineSeconds.

    • getRetainAckedMessages

      boolean getRetainAckedMessages()
       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];
      Returns:
      The retainAckedMessages.

    • hasMessageRetentionDuration

      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];
      Returns:
      Whether the messageRetentionDuration field is set.

    • getMessageRetentionDuration

      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];
      Returns:
      The messageRetentionDuration.

    • getMessageRetentionDurationOrBuilder

      com.google.protobuf.DurationOrBuilder getMessageRetentionDurationOrBuilder()
       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];

    • getLabelsCount

      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];

    • containsLabels

      boolean containsLabels(String key)
       Optional. See [Creating and managing
 labels](https://cloud.google.com/pubsub/docs/labels).
      map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

      Map<String,String> getLabelsMap()
       Optional. See [Creating and managing
 labels](https://cloud.google.com/pubsub/docs/labels).
      map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

    • getLabelsOrDefault

      String getLabelsOrDefault(String key, 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];

    • getLabelsOrThrow

      String getLabelsOrThrow(String key)
       Optional. See [Creating and managing
 labels](https://cloud.google.com/pubsub/docs/labels).
      map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

    • getEnableMessageOrdering

      boolean getEnableMessageOrdering()
       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];
      Returns:
      The enableMessageOrdering.

    • hasExpirationPolicy

      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];
      Returns:
      Whether the expirationPolicy field is set.

    • getExpirationPolicy

      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];
      Returns:
      The expirationPolicy.

    • getExpirationPolicyOrBuilder

      ExpirationPolicyOrBuilder getExpirationPolicyOrBuilder()
       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];

    • getFilter

      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];
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       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];
      Returns:
      The bytes for filter.

    • hasDeadLetterPolicy

      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];
      Returns:
      Whether the deadLetterPolicy field is set.

    • getDeadLetterPolicy

      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];
      Returns:
      The deadLetterPolicy.

    • getDeadLetterPolicyOrBuilder

      DeadLetterPolicyOrBuilder getDeadLetterPolicyOrBuilder()
       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];

    • hasRetryPolicy

      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];
      Returns:
      Whether the retryPolicy field is set.

    • getRetryPolicy

      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];
      Returns:
      The retryPolicy.

    • getRetryPolicyOrBuilder

      RetryPolicyOrBuilder getRetryPolicyOrBuilder()
       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];

    • getDetached

      boolean getDetached()
       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];
      Returns:
      The detached.

    • getEnableExactlyOnceDelivery

      boolean getEnableExactlyOnceDelivery()
       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];
      Returns:
      The enableExactlyOnceDelivery.

    • hasTopicMessageRetentionDuration

      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];
      Returns:
      Whether the topicMessageRetentionDuration field is set.

    • getTopicMessageRetentionDuration

      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];
      Returns:
      The topicMessageRetentionDuration.

    • getTopicMessageRetentionDurationOrBuilder

      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];

    • getStateValue

      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];
      Returns:
      The enum numeric value on the wire for state.

    • getState

      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];
      Returns:
      The state.