Class SnapshotTableRequest.Builder (2.17.1)

Version latest

• 2.37.0 (latest)
• 2.35.1
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.1
• 2.28.0

public static final class SnapshotTableRequest.Builder extends GeneratedMessageV3.Builder<SnapshotTableRequest.Builder> implements SnapshotTableRequestOrBuilder

Request message for google.bigtable.admin.v2.BigtableTableAdmin.SnapshotTable 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.SnapshotTableRequest

Inheritance

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

Implements

SnapshotTableRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

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.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

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)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

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)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

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

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

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

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)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
SnapshotTableRequest.Builder

Overrides

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

build()

public SnapshotTableRequest build()

Returns

Type	Description
SnapshotTableRequest

buildPartial()

public SnapshotTableRequest buildPartial()

Returns

Type	Description
SnapshotTableRequest

clear()

public SnapshotTableRequest.Builder clear()

Returns

Type	Description
SnapshotTableRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearCluster()

public SnapshotTableRequest.Builder clearCluster()

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

Type	Description
SnapshotTableRequest.Builder	This builder for chaining.

clearDescription()

public SnapshotTableRequest.Builder clearDescription()

Description of the snapshot.

string description = 5;

Returns

Type	Description
SnapshotTableRequest.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public SnapshotTableRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
SnapshotTableRequest.Builder

Overrides

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

clearName()

public SnapshotTableRequest.Builder clearName()

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

Type	Description
SnapshotTableRequest.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SnapshotTableRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
SnapshotTableRequest.Builder

Overrides

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

clearSnapshotId()

public SnapshotTableRequest.Builder clearSnapshotId()

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

Type	Description
SnapshotTableRequest.Builder	This builder for chaining.

clearTtl()

public SnapshotTableRequest.Builder clearTtl()

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

Type	Description
SnapshotTableRequest.Builder

clone()

public SnapshotTableRequest.Builder clone()

Returns

Type	Description
SnapshotTableRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getCluster()

public 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

Type	Description
String	The cluster.

getClusterBytes()

public 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

Type	Description
ByteString	The bytes for cluster.

getDefaultInstanceForType()

public SnapshotTableRequest getDefaultInstanceForType()

Returns

Type	Description
SnapshotTableRequest

getDescription()

public String getDescription()

Description of the snapshot.

string description = 5;

Returns

Type	Description
String	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Description of the snapshot.

string description = 5;

Returns

Type	Description
ByteString	The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getName()

public 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

Type	Description
String	The name.

getNameBytes()

public 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

Type	Description
ByteString	The bytes for name.

getSnapshotId()

public 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

Type	Description
String	The snapshotId.

getSnapshotIdBytes()

public 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

Type	Description
ByteString	The bytes for snapshotId.

getTtl()

public 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

Type	Description
Duration	The ttl.

getTtlBuilder()

public Duration.Builder getTtlBuilder()

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

Type	Description
Builder

getTtlOrBuilder()

public 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

Type	Description
DurationOrBuilder

hasTtl()

public 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

Type	Description
boolean	Whether the ttl 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()

mergeFrom(SnapshotTableRequest other)

public SnapshotTableRequest.Builder mergeFrom(SnapshotTableRequest other)

Parameter

Name	Description
other	SnapshotTableRequest

Returns

Type	Description
SnapshotTableRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
SnapshotTableRequest.Builder

Overrides

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

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public SnapshotTableRequest.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
SnapshotTableRequest.Builder

Overrides

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

mergeTtl(Duration value)

public SnapshotTableRequest.Builder mergeTtl(Duration value)

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;

Parameter

Name	Description
value	Duration

Returns

Type	Description
SnapshotTableRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SnapshotTableRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
SnapshotTableRequest.Builder

Overrides

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

setCluster(String value)

public SnapshotTableRequest.Builder setCluster(String value)

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) = { ... }

Parameter

Name	Description
value	String The cluster to set.

Returns

Type	Description
SnapshotTableRequest.Builder	This builder for chaining.

setClusterBytes(ByteString value)

public SnapshotTableRequest.Builder setClusterBytes(ByteString value)

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) = { ... }

Parameter

Name	Description
value	ByteString The bytes for cluster to set.

Returns

Type	Description
SnapshotTableRequest.Builder	This builder for chaining.

setDescription(String value)

public SnapshotTableRequest.Builder setDescription(String value)

Description of the snapshot.

string description = 5;

Parameter

Name	Description
value	String The description to set.

Returns

Type	Description
SnapshotTableRequest.Builder	This builder for chaining.

setDescriptionBytes(ByteString value)

public SnapshotTableRequest.Builder setDescriptionBytes(ByteString value)

Description of the snapshot.

string description = 5;

Parameter

Name	Description
value	ByteString The bytes for description to set.

Returns

Type	Description
SnapshotTableRequest.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
SnapshotTableRequest.Builder

Overrides

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

setName(String value)

public SnapshotTableRequest.Builder setName(String value)

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) = { ... }

Parameter

Name	Description
value	String The name to set.

Returns

Type	Description
SnapshotTableRequest.Builder	This builder for chaining.

setNameBytes(ByteString value)

public SnapshotTableRequest.Builder setNameBytes(ByteString value)

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) = { ... }

Parameter

Name	Description
value	ByteString The bytes for name to set.

Returns

Type	Description
SnapshotTableRequest.Builder	This builder for chaining.

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

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

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
SnapshotTableRequest.Builder

Overrides

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

setSnapshotId(String value)

public SnapshotTableRequest.Builder setSnapshotId(String value)

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];

Parameter

Name	Description
value	String The snapshotId to set.

Returns

Type	Description
SnapshotTableRequest.Builder	This builder for chaining.

setSnapshotIdBytes(ByteString value)

public SnapshotTableRequest.Builder setSnapshotIdBytes(ByteString value)

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];

Parameter

Name	Description
value	ByteString The bytes for snapshotId to set.

Returns

Type	Description
SnapshotTableRequest.Builder	This builder for chaining.

setTtl(Duration value)

public SnapshotTableRequest.Builder setTtl(Duration value)

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;

Parameter

Name	Description
value	Duration

Returns

Type	Description
SnapshotTableRequest.Builder

setTtl(Duration.Builder builderForValue)

public SnapshotTableRequest.Builder setTtl(Duration.Builder builderForValue)

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;

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
SnapshotTableRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final SnapshotTableRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
SnapshotTableRequest.Builder

Overrides

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