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
PROTO library for proto-google-cloud-pubsub-v1
There is a newer version: 1.116.2
Show newest version
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/pubsub/v1/pubsub.proto

package com.google.pubsub.v1;

public interface SubscriptionOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.pubsub.v1.Subscription)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * 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;
   */
  java.lang.String getName();
  /**
   *    * 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;
   */
  com.google.protobuf.ByteString
      getNameBytes();

  /**
   *    * 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;
   */
  java.lang.String getTopic();
  /**
   *    * 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;
   */
  com.google.protobuf.ByteString
      getTopicBytes();

  /**
   *    * If push delivery is used with this subscription, this field is
   * used to configure it. An empty `pushConfig` signifies that the subscriber
   * will pull and ack messages using API methods.
   * 
   *
   * .google.pubsub.v1.PushConfig push_config = 4;
   */
  boolean hasPushConfig();
  /**
   *    * If push delivery is used with this subscription, this field is
   * used to configure it. An empty `pushConfig` signifies that the subscriber
   * will pull and ack messages using API methods.
   * 
   *
   * .google.pubsub.v1.PushConfig push_config = 4;
   */
  com.google.pubsub.v1.PushConfig getPushConfig();
  /**
   *    * If push delivery is used with this subscription, this field is
   * used to configure it. An empty `pushConfig` signifies that the subscriber
   * will pull and ack messages using API methods.
   * 
   *
   * .google.pubsub.v1.PushConfig push_config = 4;
   */
  com.google.pubsub.v1.PushConfigOrBuilder getPushConfigOrBuilder();

  /**
   *    * This value is the maximum time after a subscriber receives a message
   * before the subscriber should acknowledge the message. After message
   * delivery but before the ack deadline expires and before the message is
   * acknowledged, it is an outstanding message and will not be delivered
   * again during that time (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;
   */
  int getAckDeadlineSeconds();

  /**
   *    * 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.<br><br>
   * <b>ALPHA:</b> This feature is part of an alpha release. This API might be
   * changed in backward-incompatible ways and is not recommended for production
   * use. It is not subject to any SLA or deprecation policy.
   * 
   *
   * bool retain_acked_messages = 7;
   */
  boolean getRetainAckedMessages();

  /**
   *    * 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.<br><br>
   * <b>ALPHA:</b> This feature is part of an alpha release. This API might be
   * changed in backward-incompatible ways and is not recommended for production
   * use. It is not subject to any SLA or deprecation policy.
   * 
   *
   * .google.protobuf.Duration message_retention_duration = 8;
   */
  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.<br><br>
   * <b>ALPHA:</b> This feature is part of an alpha release. This API might be
   * changed in backward-incompatible ways and is not recommended for production
   * use. It is not subject to any SLA or deprecation policy.
   * 
   *
   * .google.protobuf.Duration message_retention_duration = 8;
   */
  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.<br><br>
   * <b>ALPHA:</b> This feature is part of an alpha release. This API might be
   * changed in backward-incompatible ways and is not recommended for production
   * use. It is not subject to any SLA or deprecation policy.
   * 
   *
   * .google.protobuf.Duration message_retention_duration = 8;
   */
  com.google.protobuf.DurationOrBuilder getMessageRetentionDurationOrBuilder();

  /**
   *    * User labels.
   * 
   *
   * map<string, string> labels = 9;
   */
  int getLabelsCount();
  /**
   *    * User labels.
   * 
   *
   * map<string, string> labels = 9;
   */
  boolean containsLabels(
      java.lang.String key);
  /**
   * Use {@link #getLabelsMap()} instead.
   */
  @java.lang.Deprecated
  java.util.Map
  getLabels();
  /**
   *    * User labels.
   * 
   *
   * map<string, string> labels = 9;
   */
  java.util.Map
  getLabelsMap();
  /**
   *    * User labels.
   * 
   *
   * map<string, string> labels = 9;
   */

  java.lang.String getLabelsOrDefault(
      java.lang.String key,
      java.lang.String defaultValue);
  /**
   *    * User labels.
   * 
   *
   * map<string, string> labels = 9;
   */

  java.lang.String getLabelsOrThrow(
      java.lang.String key);
}