com.google.pubsub.v1.CreateSnapshotRequestOrBuilder 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 CreateSnapshotRequestOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.pubsub.v1.CreateSnapshotRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Optional user-provided name for this snapshot.
   * If the name is not provided in the request, the server will assign a random
   * name for this snapshot on the same project as the subscription.
   * Note that for REST API requests, you must specify a name.  See the
   * <a href="https://cloud.google.com/pubsub/docs/admin#resource_names">
   * resource name rules</a>.
   * Format is `projects/{project}/snapshots/{snap}`.
   * 
   *
   * string name = 1;
   */
  java.lang.String getName();
  /**
   *
   *
   *    * Optional user-provided name for this snapshot.
   * If the name is not provided in the request, the server will assign a random
   * name for this snapshot on the same project as the subscription.
   * Note that for REST API requests, you must specify a name.  See the
   * <a href="https://cloud.google.com/pubsub/docs/admin#resource_names">
   * resource name rules</a>.
   * Format is `projects/{project}/snapshots/{snap}`.
   * 
   *
   * string name = 1;
   */
  com.google.protobuf.ByteString getNameBytes();

  /**
   *
   *
   *    * The subscription whose backlog the snapshot retains.
   * Specifically, the created snapshot is guaranteed to retain:
   *  (a) The existing backlog on the subscription. More precisely, this is
   *      defined as the messages in the subscription's backlog that are
   *      unacknowledged upon the successful completion of the
   *      `CreateSnapshot` request; as well as:
   *  (b) Any messages published to the subscription's topic following the
   *      successful completion of the CreateSnapshot request.
   * Format is `projects/{project}/subscriptions/{sub}`.
   * 
   *
   * string subscription = 2;
   */
  java.lang.String getSubscription();
  /**
   *
   *
   *    * The subscription whose backlog the snapshot retains.
   * Specifically, the created snapshot is guaranteed to retain:
   *  (a) The existing backlog on the subscription. More precisely, this is
   *      defined as the messages in the subscription's backlog that are
   *      unacknowledged upon the successful completion of the
   *      `CreateSnapshot` request; as well as:
   *  (b) Any messages published to the subscription's topic following the
   *      successful completion of the CreateSnapshot request.
   * Format is `projects/{project}/subscriptions/{sub}`.
   * 
   *
   * string subscription = 2;
   */
  com.google.protobuf.ByteString getSubscriptionBytes();

  /**
   *
   *
   *    * See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
   * managing labels</a>.
   * 
   *
   * map<string, string> labels = 3;
   */
  int getLabelsCount();
  /**
   *
   *
   *    * See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
   * managing labels</a>.
   * 
   *
   * map<string, string> labels = 3;
   */
  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 = 3;
   */
  java.util.Map getLabelsMap();
  /**
   *
   *
   *    * See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
   * managing labels</a>.
   * 
   *
   * map<string, string> labels = 3;
   */
  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 = 3;
   */
  java.lang.String getLabelsOrThrow(java.lang.String key);
}