public final class SnapshotTableRequest extends GeneratedMessageV3 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
Fields
CLUSTER_FIELD_NUMBER
public static final int CLUSTER_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
SNAPSHOT_ID_FIELD_NUMBER
public static final int SNAPSHOT_ID_FIELD_NUMBER
Field Value
TTL_FIELD_NUMBER
public static final int TTL_FIELD_NUMBER
Field Value
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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) = { ... }
| 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) = { ... }
getDefaultInstance()
public static SnapshotTableRequest getDefaultInstance()
Returns
getDefaultInstanceForType()
public SnapshotTableRequest getDefaultInstanceForType()
Returns
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.
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
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) = { ... }
getParserForType()
public Parser<SnapshotTableRequest> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
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()
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;
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;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilder()
public static SnapshotTableRequest.Builder newBuilder()
Returns
newBuilder(SnapshotTableRequest prototype)
public static SnapshotTableRequest.Builder newBuilder(SnapshotTableRequest prototype)
Parameter
Returns
newBuilderForType()
public SnapshotTableRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SnapshotTableRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static SnapshotTableRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static SnapshotTableRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static SnapshotTableRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SnapshotTableRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static SnapshotTableRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SnapshotTableRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SnapshotTableRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static SnapshotTableRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SnapshotTableRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static SnapshotTableRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static SnapshotTableRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SnapshotTableRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<SnapshotTableRequest> parser()
Returns
toBuilder()
public SnapshotTableRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
