public static final class SnapshotTableRequest.Builder extends GeneratedMessageV3.Builder<SnapshotTableRequest.Builder> implements SnapshotTableRequestOrBuilderRequest 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.BuilderImplements
SnapshotTableRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SnapshotTableRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| SnapshotTableRequest.Builder |
build()
public SnapshotTableRequest build()| Type | Description |
| SnapshotTableRequest |
buildPartial()
public SnapshotTableRequest buildPartial()| Type | Description |
| SnapshotTableRequest |
clear()
public SnapshotTableRequest.Builder clear()| Type | Description |
| SnapshotTableRequest.Builder |
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) = { ... }
| Type | Description |
| SnapshotTableRequest.Builder | This builder for chaining. |
clearDescription()
public SnapshotTableRequest.Builder clearDescription()Description of the snapshot.
string description = 5;
| Type | Description |
| SnapshotTableRequest.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public SnapshotTableRequest.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| SnapshotTableRequest.Builder |
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) = { ... }
| Type | Description |
| SnapshotTableRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public SnapshotTableRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| SnapshotTableRequest.Builder |
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];
| 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;
| Type | Description |
| SnapshotTableRequest.Builder |
clone()
public SnapshotTableRequest.Builder clone()| Type | Description |
| SnapshotTableRequest.Builder |
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) = { ... }
| 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) = { ... }
| Type | Description |
| ByteString | The bytes for cluster. |
getDefaultInstanceForType()
public SnapshotTableRequest getDefaultInstanceForType()| Type | Description |
| SnapshotTableRequest |
getDescription()
public String getDescription()Description of the snapshot.
string description = 5;
| Type | Description |
| String | The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()Description of the snapshot.
string description = 5;
| Type | Description |
| ByteString | The bytes for description. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
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) = { ... }
| 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) = { ... }
| 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];
| 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];
| 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;
| 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;
| 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;
| 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;
| Type | Description |
| boolean | Whether the ttl field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
mergeFrom(SnapshotTableRequest other)
public SnapshotTableRequest.Builder mergeFrom(SnapshotTableRequest other)| Name | Description |
| other | SnapshotTableRequest |
| Type | Description |
| SnapshotTableRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SnapshotTableRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| SnapshotTableRequest.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public SnapshotTableRequest.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| SnapshotTableRequest.Builder |
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;
| Name | Description |
| value | Duration |
| Type | Description |
| SnapshotTableRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SnapshotTableRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| SnapshotTableRequest.Builder |
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) = { ... }
| Name | Description |
| value | StringThe cluster to set. |
| 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) = { ... }
| Name | Description |
| value | ByteStringThe bytes for cluster to set. |
| Type | Description |
| SnapshotTableRequest.Builder | This builder for chaining. |
setDescription(String value)
public SnapshotTableRequest.Builder setDescription(String value)Description of the snapshot.
string description = 5;
| Name | Description |
| value | StringThe description to set. |
| Type | Description |
| SnapshotTableRequest.Builder | This builder for chaining. |
setDescriptionBytes(ByteString value)
public SnapshotTableRequest.Builder setDescriptionBytes(ByteString value)Description of the snapshot.
string description = 5;
| Name | Description |
| value | ByteStringThe bytes for description to set. |
| Type | Description |
| SnapshotTableRequest.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public SnapshotTableRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| SnapshotTableRequest.Builder |
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) = { ... }
| Name | Description |
| value | StringThe name to set. |
| 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) = { ... }
| Name | Description |
| value | ByteStringThe bytes for name to set. |
| 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)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| SnapshotTableRequest.Builder |
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];
| Name | Description |
| value | StringThe snapshotId to set. |
| 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];
| Name | Description |
| value | ByteStringThe bytes for snapshotId to set. |
| 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;
| Name | Description |
| value | Duration |
| 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;
| Name | Description |
| builderForValue | Builder |
| Type | Description |
| SnapshotTableRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final SnapshotTableRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| SnapshotTableRequest.Builder |