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) User labels.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() User labels.
Map<String,String>	getLabelsMap() User labels.
String	getLabelsOrDefault(String key, String defaultValue) User labels.
String	getLabelsOrThrow(String key) User labels.
String	getName() Optional user-provided name for this snapshot.
com.google.protobuf.ByteString	getNameBytes() Optional user-provided name for this snapshot.
String	getSubscription() The subscription whose backlog the snapshot retains.
com.google.protobuf.ByteString	getSubscriptionBytes() The subscription whose backlog the snapshot retains.

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()

 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.
 Format is `projects/{project}/snapshots/{snap}`.
 

string name = 1;

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 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.
 Format is `projects/{project}/snapshots/{snap}`.
 

string name = 1;

getSubscription

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;

getSubscriptionBytes

com.google.protobuf.ByteString getSubscriptionBytes()

 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;

getLabelsCount

int getLabelsCount()

 User labels.
 

map<string, string> labels = 3;

containsLabels

boolean containsLabels(String key)

 User labels.
 

map<string, string> labels = 3;

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

Map<String,String> getLabelsMap()

 User labels.
 

map<string, string> labels = 3;

getLabelsOrDefault

String getLabelsOrDefault(String key,
                          String defaultValue)

 User labels.
 

map<string, string> labels = 3;

getLabelsOrThrow

String getLabelsOrThrow(String key)

 User labels.
 

map<string, string> labels = 3;