Interface SnapshotTableRequestOrBuilder (2.12.0)

public interface SnapshotTableRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCluster()

public abstract 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
TypeDescription
String

The cluster.

getClusterBytes()

public abstract 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
TypeDescription
ByteString

The bytes for cluster.

getDescription()

public abstract String getDescription()

Description of the snapshot.

string description = 5;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Description of the snapshot.

string description = 5;

Returns
TypeDescription
ByteString

The bytes for description.

getName()

public abstract 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
TypeDescription
String

The name.

getNameBytes()

public abstract 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
TypeDescription
ByteString

The bytes for name.

getSnapshotId()

public abstract 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* rather than projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/mysnapshot.

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

Returns
TypeDescription
String

The snapshotId.

getSnapshotIdBytes()

public abstract 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* rather than projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/mysnapshot.

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

Returns
TypeDescription
ByteString

The bytes for snapshotId.

getTtl()

public abstract 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
TypeDescription
Duration

The ttl.

getTtlOrBuilder()

public abstract 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;

Returns
TypeDescription
DurationOrBuilder

hasTtl()

public abstract 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
TypeDescription
boolean

Whether the ttl field is set.