public interface CreateSnapshotRequestOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
containsLabels(String key)
public abstract boolean containsLabels(String key)
See <a href="https://cloud.google.com/pubsub/docs/labels">; Creating and managing labels</a>.
map<string, string> labels = 3;
Parameter | |
---|---|
Name | Description |
key | String |
Returns | |
---|---|
Type | Description |
boolean |
getLabels()
public abstract Map<String,String> getLabels()
Use #getLabelsMap() instead.
getLabelsCount()
public abstract int getLabelsCount()
See <a href="https://cloud.google.com/pubsub/docs/labels">; Creating and managing labels</a>.
map<string, string> labels = 3;
Returns | |
---|---|
Type | Description |
int |
getLabelsMap()
public abstract 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 key, String defaultValue)
public abstract 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;
Returns | |
---|---|
Type | Description |
String |
getLabelsOrThrow(String key)
public abstract String getLabelsOrThrow(String key)
See <a href="https://cloud.google.com/pubsub/docs/labels">; Creating and managing labels</a>.
map<string, string> labels = 3;
Parameter | |
---|---|
Name | Description |
key | String |
Returns | |
---|---|
Type | Description |
String |
getName()
public abstract 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 | |
---|---|
Type | Description |
String | The name. |
getNameBytes()
public abstract 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 | |
---|---|
Type | Description |
ByteString | The bytes for name. |
getSubscription()
public abstract 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 | |
---|---|
Type | Description |
String | The subscription. |
getSubscriptionBytes()
public abstract 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 | |
---|---|
Type | Description |
ByteString | The bytes for subscription. |