Package com.google.pubsub.v1

Interface CreateSnapshotRequestOrBuilder

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

  • Method Details

    • getName

      String getName()
       Required. 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 [resource name
 rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
 Format is `projects/{project}/snapshots/{snap}`.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Required. 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 [resource name
 rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
 Format is `projects/{project}/snapshots/{snap}`.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for name.

    • getSubscription

      String getSubscription()
       Required. 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 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The subscription.

    • getSubscriptionBytes

      com.google.protobuf.ByteString getSubscriptionBytes()
       Required. 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 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for subscription.

    • getLabelsCount

      int getLabelsCount()
       Optional. See [Creating and managing
 labels](https://cloud.google.com/pubsub/docs/labels).
      map<string, string> labels = 3 [(.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 = 3 [(.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 = 3 [(.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 = 3 [(.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 = 3 [(.google.api.field_behavior) = OPTIONAL];