Class SnapshotTableRequest.Builder (2.10.2)

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public SnapshotTableRequest build()
Returns
TypeDescription
SnapshotTableRequest

buildPartial()

public SnapshotTableRequest buildPartial()
Returns
TypeDescription
SnapshotTableRequest

clear()

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

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
TypeDescription
SnapshotTableRequest.Builder

This builder for chaining.

clearDescription()

public SnapshotTableRequest.Builder clearDescription()

Description of the snapshot.

string description = 5;

Returns
TypeDescription
SnapshotTableRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

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
TypeDescription
SnapshotTableRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

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
TypeDescription
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
TypeDescription
SnapshotTableRequest.Builder

clone()

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

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
TypeDescription
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
TypeDescription
ByteString

The bytes for cluster.

getDefaultInstanceForType()

public SnapshotTableRequest getDefaultInstanceForType()
Returns
TypeDescription
SnapshotTableRequest

getDescription()

public String getDescription()

Description of the snapshot.

string description = 5;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Description of the snapshot.

string description = 5;

Returns
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the ttl field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(SnapshotTableRequest other)

public SnapshotTableRequest.Builder mergeFrom(SnapshotTableRequest other)
Parameter
NameDescription
otherSnapshotTableRequest
Returns
TypeDescription
SnapshotTableRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

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
NameDescription
valueDuration
Returns
TypeDescription
SnapshotTableRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

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
NameDescription
valueString

The cluster to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for cluster to set.

Returns
TypeDescription
SnapshotTableRequest.Builder

This builder for chaining.

setDescription(String value)

public SnapshotTableRequest.Builder setDescription(String value)

Description of the snapshot.

string description = 5;

Parameter
NameDescription
valueString

The description to set.

Returns
TypeDescription
SnapshotTableRequest.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public SnapshotTableRequest.Builder setDescriptionBytes(ByteString value)

Description of the snapshot.

string description = 5;

Parameter
NameDescription
valueByteString

The bytes for description to set.

Returns
TypeDescription
SnapshotTableRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

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
NameDescription
valueString

The name to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
SnapshotTableRequest.Builder
Overrides

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
NameDescription
valueString

The snapshotId to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for snapshotId to set.

Returns
TypeDescription
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
NameDescription
valueDuration
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
SnapshotTableRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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