Class Snapshot.Builder (2.16.0)

public static final class Snapshot.Builder extends GeneratedMessageV3.Builder<Snapshot.Builder> implements SnapshotOrBuilder

A snapshot of a table at a particular time. A snapshot can be used as a checkpoint for data restoration or a data source for a new table. Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

Protobuf type google.bigtable.admin.v2.Snapshot

Implements

SnapshotOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Snapshot.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Snapshot.Builder
Overrides

build()

public Snapshot build()
Returns
TypeDescription
Snapshot

buildPartial()

public Snapshot buildPartial()
Returns
TypeDescription
Snapshot

clear()

public Snapshot.Builder clear()
Returns
TypeDescription
Snapshot.Builder
Overrides

clearCreateTime()

public Snapshot.Builder clearCreateTime()

Output only. The time when the snapshot is created.

.google.protobuf.Timestamp create_time = 4;

Returns
TypeDescription
Snapshot.Builder

clearDataSizeBytes()

public Snapshot.Builder clearDataSizeBytes()

Output only. The size of the data in the source table at the time the snapshot was taken. In some cases, this value may be computed asynchronously via a background process and a placeholder of 0 will be used in the meantime.

int64 data_size_bytes = 3;

Returns
TypeDescription
Snapshot.Builder

This builder for chaining.

clearDeleteTime()

public Snapshot.Builder clearDeleteTime()

Output only. The time when the snapshot will be deleted. The maximum amount of time a snapshot can stay active is 365 days. If 'ttl' is not specified, the default maximum of 365 days will be used.

.google.protobuf.Timestamp delete_time = 5;

Returns
TypeDescription
Snapshot.Builder

clearDescription()

public Snapshot.Builder clearDescription()

Output only. Description of the snapshot.

string description = 7;

Returns
TypeDescription
Snapshot.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Snapshot.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Snapshot.Builder
Overrides

clearName()

public Snapshot.Builder clearName()

Output only. The unique name of the snapshot. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}.

string name = 1;

Returns
TypeDescription
Snapshot.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Snapshot.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Snapshot.Builder
Overrides

clearSourceTable()

public Snapshot.Builder clearSourceTable()

Output only. The source table at the time the snapshot was taken.

.google.bigtable.admin.v2.Table source_table = 2;

Returns
TypeDescription
Snapshot.Builder

clearState()

public Snapshot.Builder clearState()

Output only. The current state of the snapshot.

.google.bigtable.admin.v2.Snapshot.State state = 6;

Returns
TypeDescription
Snapshot.Builder

This builder for chaining.

clone()

public Snapshot.Builder clone()
Returns
TypeDescription
Snapshot.Builder
Overrides

getCreateTime()

public Timestamp getCreateTime()

Output only. The time when the snapshot is created.

.google.protobuf.Timestamp create_time = 4;

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The time when the snapshot is created.

.google.protobuf.Timestamp create_time = 4;

Returns
TypeDescription
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time when the snapshot is created.

.google.protobuf.Timestamp create_time = 4;

Returns
TypeDescription
TimestampOrBuilder

getDataSizeBytes()

public long getDataSizeBytes()

Output only. The size of the data in the source table at the time the snapshot was taken. In some cases, this value may be computed asynchronously via a background process and a placeholder of 0 will be used in the meantime.

int64 data_size_bytes = 3;

Returns
TypeDescription
long

The dataSizeBytes.

getDefaultInstanceForType()

public Snapshot getDefaultInstanceForType()
Returns
TypeDescription
Snapshot

getDeleteTime()

public Timestamp getDeleteTime()

Output only. The time when the snapshot will be deleted. The maximum amount of time a snapshot can stay active is 365 days. If 'ttl' is not specified, the default maximum of 365 days will be used.

.google.protobuf.Timestamp delete_time = 5;

Returns
TypeDescription
Timestamp

The deleteTime.

getDeleteTimeBuilder()

public Timestamp.Builder getDeleteTimeBuilder()

Output only. The time when the snapshot will be deleted. The maximum amount of time a snapshot can stay active is 365 days. If 'ttl' is not specified, the default maximum of 365 days will be used.

.google.protobuf.Timestamp delete_time = 5;

Returns
TypeDescription
Builder

getDeleteTimeOrBuilder()

public TimestampOrBuilder getDeleteTimeOrBuilder()

Output only. The time when the snapshot will be deleted. The maximum amount of time a snapshot can stay active is 365 days. If 'ttl' is not specified, the default maximum of 365 days will be used.

.google.protobuf.Timestamp delete_time = 5;

Returns
TypeDescription
TimestampOrBuilder

getDescription()

public String getDescription()

Output only. Description of the snapshot.

string description = 7;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Output only. Description of the snapshot.

string description = 7;

Returns
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getName()

public String getName()

Output only. The unique name of the snapshot. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The unique name of the snapshot. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getSourceTable()

public Table getSourceTable()

Output only. The source table at the time the snapshot was taken.

.google.bigtable.admin.v2.Table source_table = 2;

Returns
TypeDescription
Table

The sourceTable.

getSourceTableBuilder()

public Table.Builder getSourceTableBuilder()

Output only. The source table at the time the snapshot was taken.

.google.bigtable.admin.v2.Table source_table = 2;

Returns
TypeDescription
Table.Builder

getSourceTableOrBuilder()

public TableOrBuilder getSourceTableOrBuilder()

Output only. The source table at the time the snapshot was taken.

.google.bigtable.admin.v2.Table source_table = 2;

Returns
TypeDescription
TableOrBuilder

getState()

public Snapshot.State getState()

Output only. The current state of the snapshot.

.google.bigtable.admin.v2.Snapshot.State state = 6;

Returns
TypeDescription
Snapshot.State

The state.

getStateValue()

public int getStateValue()

Output only. The current state of the snapshot.

.google.bigtable.admin.v2.Snapshot.State state = 6;

Returns
TypeDescription
int

The enum numeric value on the wire for state.

hasCreateTime()

public boolean hasCreateTime()

Output only. The time when the snapshot is created.

.google.protobuf.Timestamp create_time = 4;

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasDeleteTime()

public boolean hasDeleteTime()

Output only. The time when the snapshot will be deleted. The maximum amount of time a snapshot can stay active is 365 days. If 'ttl' is not specified, the default maximum of 365 days will be used.

.google.protobuf.Timestamp delete_time = 5;

Returns
TypeDescription
boolean

Whether the deleteTime field is set.

hasSourceTable()

public boolean hasSourceTable()

Output only. The source table at the time the snapshot was taken.

.google.bigtable.admin.v2.Table source_table = 2;

Returns
TypeDescription
boolean

Whether the sourceTable field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeCreateTime(Timestamp value)

public Snapshot.Builder mergeCreateTime(Timestamp value)

Output only. The time when the snapshot is created.

.google.protobuf.Timestamp create_time = 4;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Snapshot.Builder

mergeDeleteTime(Timestamp value)

public Snapshot.Builder mergeDeleteTime(Timestamp value)

Output only. The time when the snapshot will be deleted. The maximum amount of time a snapshot can stay active is 365 days. If 'ttl' is not specified, the default maximum of 365 days will be used.

.google.protobuf.Timestamp delete_time = 5;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Snapshot.Builder

mergeFrom(Snapshot other)

public Snapshot.Builder mergeFrom(Snapshot other)
Parameter
NameDescription
otherSnapshot
Returns
TypeDescription
Snapshot.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Snapshot.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Snapshot.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Snapshot.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Snapshot.Builder
Overrides

mergeSourceTable(Table value)

public Snapshot.Builder mergeSourceTable(Table value)

Output only. The source table at the time the snapshot was taken.

.google.bigtable.admin.v2.Table source_table = 2;

Parameter
NameDescription
valueTable
Returns
TypeDescription
Snapshot.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Snapshot.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Snapshot.Builder
Overrides

setCreateTime(Timestamp value)

public Snapshot.Builder setCreateTime(Timestamp value)

Output only. The time when the snapshot is created.

.google.protobuf.Timestamp create_time = 4;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Snapshot.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Snapshot.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The time when the snapshot is created.

.google.protobuf.Timestamp create_time = 4;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Snapshot.Builder

setDataSizeBytes(long value)

public Snapshot.Builder setDataSizeBytes(long value)

Output only. The size of the data in the source table at the time the snapshot was taken. In some cases, this value may be computed asynchronously via a background process and a placeholder of 0 will be used in the meantime.

int64 data_size_bytes = 3;

Parameter
NameDescription
valuelong

The dataSizeBytes to set.

Returns
TypeDescription
Snapshot.Builder

This builder for chaining.

setDeleteTime(Timestamp value)

public Snapshot.Builder setDeleteTime(Timestamp value)

Output only. The time when the snapshot will be deleted. The maximum amount of time a snapshot can stay active is 365 days. If 'ttl' is not specified, the default maximum of 365 days will be used.

.google.protobuf.Timestamp delete_time = 5;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Snapshot.Builder

setDeleteTime(Timestamp.Builder builderForValue)

public Snapshot.Builder setDeleteTime(Timestamp.Builder builderForValue)

Output only. The time when the snapshot will be deleted. The maximum amount of time a snapshot can stay active is 365 days. If 'ttl' is not specified, the default maximum of 365 days will be used.

.google.protobuf.Timestamp delete_time = 5;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Snapshot.Builder

setDescription(String value)

public Snapshot.Builder setDescription(String value)

Output only. Description of the snapshot.

string description = 7;

Parameter
NameDescription
valueString

The description to set.

Returns
TypeDescription
Snapshot.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Snapshot.Builder setDescriptionBytes(ByteString value)

Output only. Description of the snapshot.

string description = 7;

Parameter
NameDescription
valueByteString

The bytes for description to set.

Returns
TypeDescription
Snapshot.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Snapshot.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Snapshot.Builder
Overrides

setName(String value)

public Snapshot.Builder setName(String value)

Output only. The unique name of the snapshot. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}.

string name = 1;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Snapshot.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Snapshot.Builder setNameBytes(ByteString value)

Output only. The unique name of the snapshot. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}.

string name = 1;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Snapshot.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Snapshot.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Snapshot.Builder
Overrides

setSourceTable(Table value)

public Snapshot.Builder setSourceTable(Table value)

Output only. The source table at the time the snapshot was taken.

.google.bigtable.admin.v2.Table source_table = 2;

Parameter
NameDescription
valueTable
Returns
TypeDescription
Snapshot.Builder

setSourceTable(Table.Builder builderForValue)

public Snapshot.Builder setSourceTable(Table.Builder builderForValue)

Output only. The source table at the time the snapshot was taken.

.google.bigtable.admin.v2.Table source_table = 2;

Parameter
NameDescription
builderForValueTable.Builder
Returns
TypeDescription
Snapshot.Builder

setState(Snapshot.State value)

public Snapshot.Builder setState(Snapshot.State value)

Output only. The current state of the snapshot.

.google.bigtable.admin.v2.Snapshot.State state = 6;

Parameter
NameDescription
valueSnapshot.State

The state to set.

Returns
TypeDescription
Snapshot.Builder

This builder for chaining.

setStateValue(int value)

public Snapshot.Builder setStateValue(int value)

Output only. The current state of the snapshot.

.google.bigtable.admin.v2.Snapshot.State state = 6;

Parameter
NameDescription
valueint

The enum numeric value on the wire for state to set.

Returns
TypeDescription
Snapshot.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Snapshot.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Snapshot.Builder
Overrides