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 Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>.
Map<String,String>	getLabelsMap() See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>.
String	getLabelsOrDefault(String key, String defaultValue) See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>.
String	getLabelsOrThrow(String key) See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>.
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
String	getSubscription() Required.
com.google.protobuf.ByteString	getSubscriptionBytes() Required.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

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 <a
 href="https://cloud.google.com/pubsub/docs/admin#resource_names"> resource
 name rules</a>. 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 <a
 href="https://cloud.google.com/pubsub/docs/admin#resource_names"> resource
 name rules</a>. 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()

 See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
 managing labels</a>.
 

map<string, string> labels = 3;

containsLabels

boolean containsLabels(String key)

 See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
 managing labels</a>.
 

map<string, string> labels = 3;

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

Map<String,String> getLabelsMap()

 See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
 managing labels</a>.
 

map<string, string> labels = 3;

getLabelsOrDefault

String getLabelsOrDefault(String key,
                          String defaultValue)

 See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
 managing labels</a>.
 

map<string, string> labels = 3;

getLabelsOrThrow

String getLabelsOrThrow(String key)

 See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
 managing labels</a>.
 

map<string, string> labels = 3;