com.google.bigtable.admin.v2

Interface SnapshotTableRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

SnapshotTableRequest, SnapshotTableRequest.Builder

public interface SnapshotTableRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getCluster() Required.
com.google.protobuf.ByteString	getClusterBytes() Required.
String	getDescription() Description of the snapshot.
com.google.protobuf.ByteString	getDescriptionBytes() Description of the snapshot.
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
String	getSnapshotId() Required.
com.google.protobuf.ByteString	getSnapshotIdBytes() Required.
com.google.protobuf.Duration	getTtl() The amount of time that the new snapshot can stay active after it is created.
com.google.protobuf.DurationOrBuilder	getTtlOrBuilder() The amount of time that the new snapshot can stay active after it is created.
boolean	hasTtl() The amount of time that the new snapshot can stay active after it is created.

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. The unique name of the table to have the snapshot taken.
 Values are of the form
 `projects/{project}/instances/{instance}/tables/{table}`.
 

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Required. The unique name of the table to have the snapshot taken.
 Values are of the form
 `projects/{project}/instances/{instance}/tables/{table}`.
 

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The bytes for name.

getCluster

String getCluster()

 Required. The name of the cluster where the snapshot will be created in.
 Values are of the form
 `projects/{project}/instances/{instance}/clusters/{cluster}`.
 

string cluster = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The cluster.

getClusterBytes

com.google.protobuf.ByteString getClusterBytes()

 Required. The name of the cluster where the snapshot will be created in.
 Values are of the form
 `projects/{project}/instances/{instance}/clusters/{cluster}`.
 

string cluster = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The bytes for cluster.

getSnapshotId

String getSnapshotId()

 Required. The ID by which the new snapshot should be referred to within the parent
 cluster, e.g., `mysnapshot` of the form: `[_a-zA-Z0-9][-_.a-zA-Z0-9]*`
 rather than
 `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/mysnapshot`.
 

string snapshot_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns:

The snapshotId.

getSnapshotIdBytes

com.google.protobuf.ByteString getSnapshotIdBytes()

 Required. The ID by which the new snapshot should be referred to within the parent
 cluster, e.g., `mysnapshot` of the form: `[_a-zA-Z0-9][-_.a-zA-Z0-9]*`
 rather than
 `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/mysnapshot`.
 

string snapshot_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns:

The bytes for snapshotId.

hasTtl

boolean hasTtl()

 The amount of time that the new snapshot can stay active after it is
 created. Once 'ttl' expires, the snapshot will get deleted. The maximum
 amount of time a snapshot can stay active is 7 days. If 'ttl' is not
 specified, the default value of 24 hours will be used.
 

.google.protobuf.Duration ttl = 4;

Returns:

Whether the ttl field is set.

getTtl

com.google.protobuf.Duration getTtl()

 The amount of time that the new snapshot can stay active after it is
 created. Once 'ttl' expires, the snapshot will get deleted. The maximum
 amount of time a snapshot can stay active is 7 days. If 'ttl' is not
 specified, the default value of 24 hours will be used.
 

.google.protobuf.Duration ttl = 4;

Returns:

The ttl.

getTtlOrBuilder

com.google.protobuf.DurationOrBuilder getTtlOrBuilder()

 The amount of time that the new snapshot can stay active after it is
 created. Once 'ttl' expires, the snapshot will get deleted. The maximum
 amount of time a snapshot can stay active is 7 days. If 'ttl' is not
 specified, the default value of 24 hours will be used.
 

.google.protobuf.Duration ttl = 4;

getDescription

String getDescription()

 Description of the snapshot.
 

string description = 5;

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

 Description of the snapshot.
 

string description = 5;

Returns:

The bytes for description.