Class Snapshot.Builder (2.3.1)

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Snapshot.Builder

Implements

SnapshotOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Snapshot.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
Snapshot.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public Snapshot build()

Returns

Type	Description
Snapshot

buildPartial()

public Snapshot buildPartial()

Returns

Type	Description
Snapshot

clear()

public Snapshot.Builder clear()

Returns

Type	Description
Snapshot.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearCreateTime()

public Snapshot.Builder clearCreateTime()

Output only. The time when the snapshot is created.

.google.protobuf.Timestamp create_time = 4;

Returns

Type	Description
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

Type	Description
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

Type	Description
Snapshot.Builder

clearDescription()

public Snapshot.Builder clearDescription()

Output only. Description of the snapshot.

string description = 7;

Returns

Type	Description
Snapshot.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Snapshot.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	`FieldDescriptor`

Returns

Type	Description
Snapshot.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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

Type	Description
Snapshot.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Snapshot.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	`OneofDescriptor`

Returns

Type	Description
Snapshot.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

Type	Description
Snapshot.Builder

clearState()

public Snapshot.Builder clearState()

Output only. The current state of the snapshot.

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

Returns

Type	Description
Snapshot.Builder	This builder for chaining.

clone()

public Snapshot.Builder clone()

Returns

Type	Description
Snapshot.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getCreateTime()

public Timestamp getCreateTime()

Output only. The time when the snapshot is created.

.google.protobuf.Timestamp create_time = 4;

Returns

Type	Description
Timestamp	The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The time when the snapshot is created.

.google.protobuf.Timestamp create_time = 4;

Returns

Type	Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time when the snapshot is created.

.google.protobuf.Timestamp create_time = 4;

Returns

Type	Description
TimestampOrBuilder

getDataSizeBytes()

public long getDataSizeBytes()

int64 data_size_bytes = 3;

Returns

Type	Description
long	The dataSizeBytes.

getDefaultInstanceForType()

public Snapshot getDefaultInstanceForType()

Returns

Type	Description
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

Type	Description
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

Type	Description
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

Type	Description
TimestampOrBuilder

getDescription()

public String getDescription()

Output only. Description of the snapshot.

string description = 7;

Returns

Type	Description
String	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Output only. Description of the snapshot.

string description = 7;

Returns

Type	Description
ByteString	The bytes for description.

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

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;

Returns

Type	Description
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

Type	Description
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

Type	Description
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

Type	Description
TableOrBuilder

getState()

public Snapshot.State getState()

Output only. The current state of the snapshot.

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

Returns

Type	Description
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

Type	Description
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

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;

Returns

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;

Returns

Type	Description
boolean	Whether the sourceTable field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

Name	Description
value	`Timestamp`

Returns

Type	Description
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

Name	Description
value	`Timestamp`

Returns

Type	Description
Snapshot.Builder

mergeFrom(Snapshot other)

public Snapshot.Builder mergeFrom(Snapshot other)

Parameter

Name	Description
other	`Snapshot`

Returns

Type	Description
Snapshot.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Snapshot.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	`CodedInputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
Snapshot.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public Snapshot.Builder mergeFrom(Message other)

Parameter

Name	Description
other	`Message`

Returns

Type	Description
Snapshot.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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

Name	Description
value	`Table`

Returns

Type	Description
Snapshot.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Snapshot.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
Snapshot.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

Name	Description
value	`Timestamp`

Returns

Type	Description
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

Name	Description
builderForValue	`Builder`

Returns

Type	Description
Snapshot.Builder

setDataSizeBytes(long value)

public Snapshot.Builder setDataSizeBytes(long value)

int64 data_size_bytes = 3;

Parameter

Name	Description
value	`long` The dataSizeBytes to set.

Returns

Type	Description
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

Name	Description
value	`Timestamp`

Returns

Type	Description
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

Name	Description
builderForValue	`Builder`

Returns

Type	Description
Snapshot.Builder

setDescription(String value)

public Snapshot.Builder setDescription(String value)

Output only. Description of the snapshot.

string description = 7;

Parameter

Name	Description
value	`String` The description to set.

Returns

Type	Description
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

Name	Description
value	`ByteString` The bytes for description to set.

Returns

Type	Description
Snapshot.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Snapshot.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
Snapshot.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

Name	Description
value	`String` The name to set.

Returns

Type	Description
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

Name	Description
value	`ByteString` The bytes for name to set.

Returns

Type	Description
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

Name	Description
field	`FieldDescriptor`
index	`int`
value	`Object`

Returns

Type	Description
Snapshot.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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

Name	Description
value	`Table`

Returns

Type	Description
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

Name	Description
builderForValue	`Table.Builder`

Returns

Type	Description
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

Name	Description
value	`Snapshot.State` The state to set.

Returns

Type	Description
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

Name	Description
value	`int` The enum numeric value on the wire for state to set.

Returns

Type	Description
Snapshot.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Snapshot.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
Snapshot.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)