com.google.pubsub.v1.TopicOrBuilder Maven / Gradle / Ivy

Go to download
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/pubsub/v1/pubsub.proto

package com.google.pubsub.v1;

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

  /**
   *
   *
   *    * The name of the topic. It must have the format
   * `"projects/{project}/topics/{topic}"`. `{topic}` 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 topic. It must have the format
   * `"projects/{project}/topics/{topic}"`. `{topic}` 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();

  /**
   *
   *
   *    * See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
   * managing labels</a>.
   * 
   *
   * map<string, string> labels = 2;
   */
  int getLabelsCount();
  /**
   *
   *
   *    * See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
   * managing labels</a>.
   * 
   *
   * map<string, string> labels = 2;
   */
  boolean containsLabels(java.lang.String key);
  /** Use {@link #getLabelsMap()} instead. */
  @java.lang.Deprecated
  java.util.Map getLabels();
  /**
   *
   *
   *    * See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
   * managing labels</a>.
   * 
   *
   * map<string, string> labels = 2;
   */
  java.util.Map getLabelsMap();
  /**
   *
   *
   *    * See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
   * managing labels</a>.
   * 
   *
   * map<string, string> labels = 2;
   */
  java.lang.String getLabelsOrDefault(java.lang.String key, java.lang.String defaultValue);
  /**
   *
   *
   *    * See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
   * managing labels</a>.
   * 
   *
   * map<string, string> labels = 2;
   */
  java.lang.String getLabelsOrThrow(java.lang.String key);

  /**
   *
   *
   *    * Policy constraining the set of Google Cloud Platform regions where messages
   * published to the topic may be stored. If not present, then no constraints
   * are in effect.
   * 
   *
   * .google.pubsub.v1.MessageStoragePolicy message_storage_policy = 3;
   */
  boolean hasMessageStoragePolicy();
  /**
   *
   *
   *    * Policy constraining the set of Google Cloud Platform regions where messages
   * published to the topic may be stored. If not present, then no constraints
   * are in effect.
   * 
   *
   * .google.pubsub.v1.MessageStoragePolicy message_storage_policy = 3;
   */
  com.google.pubsub.v1.MessageStoragePolicy getMessageStoragePolicy();
  /**
   *
   *
   *    * Policy constraining the set of Google Cloud Platform regions where messages
   * published to the topic may be stored. If not present, then no constraints
   * are in effect.
   * 
   *
   * .google.pubsub.v1.MessageStoragePolicy message_storage_policy = 3;
   */
  com.google.pubsub.v1.MessageStoragePolicyOrBuilder getMessageStoragePolicyOrBuilder();

  /**
   *
   *
   *    * The resource name of the Cloud KMS CryptoKey to be used to protect access
   * to messages published on this topic.
   * The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
   * 
   *
   * string kms_key_name = 5;
   */
  java.lang.String getKmsKeyName();
  /**
   *
   *
   *    * The resource name of the Cloud KMS CryptoKey to be used to protect access
   * to messages published on this topic.
   * The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
   * 
   *
   * string kms_key_name = 5;
   */
  com.google.protobuf.ByteString getKmsKeyNameBytes();
}