public final class Snapshot extends GeneratedMessageV3 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
Static Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DATA_SIZE_BYTES_FIELD_NUMBER
public static final int DATA_SIZE_BYTES_FIELD_NUMBER
Field Value
DELETE_TIME_FIELD_NUMBER
public static final int DELETE_TIME_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
SOURCE_TABLE_FIELD_NUMBER
public static final int SOURCE_TABLE_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Snapshot getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Snapshot.Builder newBuilder()
Returns
newBuilder(Snapshot prototype)
public static Snapshot.Builder newBuilder(Snapshot prototype)
Parameter
Returns
public static Snapshot parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Snapshot parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Snapshot parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Snapshot parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Snapshot parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Snapshot parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Snapshot parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Snapshot parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Snapshot parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Snapshot parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Snapshot parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Snapshot parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Snapshot> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getCreateTime()
public Timestamp getCreateTime()
Output only. The time when the snapshot is created.
.google.protobuf.Timestamp create_time = 4;
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time when the snapshot is created.
.google.protobuf.Timestamp create_time = 4;
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;
| Type | Description |
| long | The dataSizeBytes.
|
getDefaultInstanceForType()
public Snapshot getDefaultInstanceForType()
Returns
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;
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;
getDescription()
public String getDescription()
Output only. Description of the snapshot.
string description = 7;
| Type | Description |
| String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Output only. Description of the snapshot.
string description = 7;
| Type | Description |
| ByteString | The bytes for description.
|
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;
| Type | Description |
| 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;
getParserForType()
public Parser<Snapshot> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getSourceTable()
public Table getSourceTable()
Output only. The source table at the time the snapshot was taken.
.google.bigtable.admin.v2.Table source_table = 2;
| Type | Description |
| Table | The sourceTable.
|
getSourceTableOrBuilder()
public TableOrBuilder getSourceTableOrBuilder()
Output only. The source table at the time the snapshot was taken.
.google.bigtable.admin.v2.Table source_table = 2;
getState()
public Snapshot.State getState()
Output only. The current state of the snapshot.
.google.bigtable.admin.v2.Snapshot.State state = 6;
getStateValue()
public int getStateValue()
Output only. The current state of the snapshot.
.google.bigtable.admin.v2.Snapshot.State state = 6;
| Type | Description |
| int | The enum numeric value on the wire for state.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasCreateTime()
public boolean hasCreateTime()
Output only. The time when the snapshot is created.
.google.protobuf.Timestamp create_time = 4;
| Type | Description |
| 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;
| Type | Description |
| 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;
| Type | Description |
| boolean | Whether the sourceTable field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Snapshot.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Snapshot.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Snapshot.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
