public static final class Snapshot.Builder extends com.google.protobuf.GeneratedMessage.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| Modifier and Type | Method and Description |
|---|---|
Snapshot |
build() |
Snapshot |
buildPartial() |
Snapshot.Builder |
clear() |
Snapshot.Builder |
clearCreateTime()
Output only.
|
Snapshot.Builder |
clearDataSizeBytes()
Output only.
|
Snapshot.Builder |
clearDeleteTime()
The time when the snapshot will be deleted.
|
Snapshot.Builder |
clearDescription()
Description of the snapshot.
|
Snapshot.Builder |
clearName()
The unique name of the snapshot.
|
Snapshot.Builder |
clearSourceTable()
Output only.
|
Snapshot.Builder |
clearState()
Output only.
|
com.google.protobuf.Timestamp |
getCreateTime()
Output only.
|
com.google.protobuf.Timestamp.Builder |
getCreateTimeBuilder()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getCreateTimeOrBuilder()
Output only.
|
long |
getDataSizeBytes()
Output only.
|
Snapshot |
getDefaultInstanceForType() |
com.google.protobuf.Timestamp |
getDeleteTime()
The time when the snapshot will be deleted.
|
com.google.protobuf.Timestamp.Builder |
getDeleteTimeBuilder()
The time when the snapshot will be deleted.
|
com.google.protobuf.TimestampOrBuilder |
getDeleteTimeOrBuilder()
The time when the snapshot will be deleted.
|
String |
getDescription()
Description of the snapshot.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
Description of the snapshot.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
String |
getName()
The unique name of the snapshot.
|
com.google.protobuf.ByteString |
getNameBytes()
The unique name of the snapshot.
|
Table |
getSourceTable()
Output only.
|
Table.Builder |
getSourceTableBuilder()
Output only.
|
TableOrBuilder |
getSourceTableOrBuilder()
Output only.
|
Snapshot.State |
getState()
Output only.
|
int |
getStateValue()
Output only.
|
boolean |
hasCreateTime()
Output only.
|
boolean |
hasDeleteTime()
The time when the snapshot will be deleted.
|
boolean |
hasSourceTable()
Output only.
|
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
Snapshot.Builder |
mergeCreateTime(com.google.protobuf.Timestamp value)
Output only.
|
Snapshot.Builder |
mergeDeleteTime(com.google.protobuf.Timestamp value)
The time when the snapshot will be deleted.
|
Snapshot.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
Snapshot.Builder |
mergeFrom(com.google.protobuf.Message other) |
Snapshot.Builder |
mergeFrom(Snapshot other) |
Snapshot.Builder |
mergeSourceTable(Table value)
Output only.
|
Snapshot.Builder |
setCreateTime(com.google.protobuf.Timestamp.Builder builderForValue)
Output only.
|
Snapshot.Builder |
setCreateTime(com.google.protobuf.Timestamp value)
Output only.
|
Snapshot.Builder |
setDataSizeBytes(long value)
Output only.
|
Snapshot.Builder |
setDeleteTime(com.google.protobuf.Timestamp.Builder builderForValue)
The time when the snapshot will be deleted.
|
Snapshot.Builder |
setDeleteTime(com.google.protobuf.Timestamp value)
The time when the snapshot will be deleted.
|
Snapshot.Builder |
setDescription(String value)
Description of the snapshot.
|
Snapshot.Builder |
setDescriptionBytes(com.google.protobuf.ByteString value)
Description of the snapshot.
|
Snapshot.Builder |
setName(String value)
The unique name of the snapshot.
|
Snapshot.Builder |
setNameBytes(com.google.protobuf.ByteString value)
The unique name of the snapshot.
|
Snapshot.Builder |
setSourceTable(Table.Builder builderForValue)
Output only.
|
Snapshot.Builder |
setSourceTable(Table value)
Output only.
|
Snapshot.Builder |
setState(Snapshot.State value)
Output only.
|
Snapshot.Builder |
setStateValue(int value)
Output only.
|
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Snapshot.Builder>public Snapshot.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessage.Builder<Snapshot.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Snapshot.Builder>public Snapshot getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic Snapshot build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic Snapshot buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic Snapshot.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Snapshot.Builder>public Snapshot.Builder mergeFrom(Snapshot other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessage.Builder<Snapshot.Builder>public Snapshot.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Snapshot.Builder>IOExceptionpublic String getName()
The unique name of the snapshot.
Values are of the form
`projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
string name = 1;getName in interface SnapshotOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
The unique name of the snapshot.
Values are of the form
`projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
string name = 1;getNameBytes in interface SnapshotOrBuilderpublic Snapshot.Builder setName(String value)
The unique name of the snapshot.
Values are of the form
`projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
string name = 1;value - The name to set.public Snapshot.Builder clearName()
The unique name of the snapshot.
Values are of the form
`projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
string name = 1;public Snapshot.Builder setNameBytes(com.google.protobuf.ByteString value)
The unique name of the snapshot.
Values are of the form
`projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
string name = 1;value - The bytes for name to set.public boolean hasSourceTable()
Output only. The source table at the time the snapshot was taken.
.google.bigtable.admin.v2.Table source_table = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasSourceTable in interface SnapshotOrBuilderpublic Table getSourceTable()
Output only. The source table at the time the snapshot was taken.
.google.bigtable.admin.v2.Table source_table = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSourceTable in interface SnapshotOrBuilderpublic 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 [(.google.api.field_behavior) = OUTPUT_ONLY];
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 [(.google.api.field_behavior) = OUTPUT_ONLY];
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 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Snapshot.Builder clearSourceTable()
Output only. The source table at the time the snapshot was taken.
.google.bigtable.admin.v2.Table source_table = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Table.Builder getSourceTableBuilder()
Output only. The source table at the time the snapshot was taken.
.google.bigtable.admin.v2.Table source_table = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public TableOrBuilder getSourceTableOrBuilder()
Output only. The source table at the time the snapshot was taken.
.google.bigtable.admin.v2.Table source_table = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSourceTableOrBuilder in interface SnapshotOrBuilderpublic 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 [(.google.api.field_behavior) = OUTPUT_ONLY];getDataSizeBytes in interface SnapshotOrBuilderpublic 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 [(.google.api.field_behavior) = OUTPUT_ONLY];value - The dataSizeBytes to set.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 [(.google.api.field_behavior) = OUTPUT_ONLY];public boolean hasCreateTime()
Output only. The time when the snapshot is created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime in interface SnapshotOrBuilderpublic com.google.protobuf.Timestamp getCreateTime()
Output only. The time when the snapshot is created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTime in interface SnapshotOrBuilderpublic Snapshot.Builder setCreateTime(com.google.protobuf.Timestamp value)
Output only. The time when the snapshot is created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Snapshot.Builder setCreateTime(com.google.protobuf.Timestamp.Builder builderForValue)
Output only. The time when the snapshot is created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Snapshot.Builder mergeCreateTime(com.google.protobuf.Timestamp value)
Output only. The time when the snapshot is created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Snapshot.Builder clearCreateTime()
Output only. The time when the snapshot is created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder()
Output only. The time when the snapshot is created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time when the snapshot is created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder in interface SnapshotOrBuilderpublic boolean hasDeleteTime()
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;hasDeleteTime in interface SnapshotOrBuilderpublic com.google.protobuf.Timestamp getDeleteTime()
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;getDeleteTime in interface SnapshotOrBuilderpublic Snapshot.Builder setDeleteTime(com.google.protobuf.Timestamp value)
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;public Snapshot.Builder setDeleteTime(com.google.protobuf.Timestamp.Builder builderForValue)
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;public Snapshot.Builder mergeDeleteTime(com.google.protobuf.Timestamp value)
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;public Snapshot.Builder clearDeleteTime()
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;public com.google.protobuf.Timestamp.Builder getDeleteTimeBuilder()
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;public com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder()
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;getDeleteTimeOrBuilder in interface SnapshotOrBuilderpublic int getStateValue()
Output only. The current state of the snapshot.
.google.bigtable.admin.v2.Snapshot.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue in interface SnapshotOrBuilderpublic Snapshot.Builder setStateValue(int value)
Output only. The current state of the snapshot.
.google.bigtable.admin.v2.Snapshot.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
value - The enum numeric value on the wire for state to set.public Snapshot.State getState()
Output only. The current state of the snapshot.
.google.bigtable.admin.v2.Snapshot.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getState in interface SnapshotOrBuilderpublic Snapshot.Builder setState(Snapshot.State value)
Output only. The current state of the snapshot.
.google.bigtable.admin.v2.Snapshot.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
value - The state to set.public Snapshot.Builder clearState()
Output only. The current state of the snapshot.
.google.bigtable.admin.v2.Snapshot.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
public String getDescription()
Description of the snapshot.
string description = 7;getDescription in interface SnapshotOrBuilderpublic com.google.protobuf.ByteString getDescriptionBytes()
Description of the snapshot.
string description = 7;getDescriptionBytes in interface SnapshotOrBuilderpublic Snapshot.Builder setDescription(String value)
Description of the snapshot.
string description = 7;value - The description to set.public Snapshot.Builder clearDescription()
Description of the snapshot.
string description = 7;public Snapshot.Builder setDescriptionBytes(com.google.protobuf.ByteString value)
Description of the snapshot.
string description = 7;value - The bytes for description to set.Copyright © 2026 Google LLC. All rights reserved.