Class SnapshotTableRequest (2.15.0) 

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

Inheritance

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

Static Fields

CLUSTER_FIELD_NUMBER

public static final int CLUSTER_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

SNAPSHOT_ID_FIELD_NUMBER

public static final int SNAPSHOT_ID_FIELD_NUMBER
Field Value
TypeDescription
int

TTL_FIELD_NUMBER

public static final int TTL_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SnapshotTableRequest getDefaultInstance()
Returns
TypeDescription
SnapshotTableRequest

getDescriptor()

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

newBuilder()

public static SnapshotTableRequest.Builder newBuilder()
Returns
TypeDescription
SnapshotTableRequest.Builder

newBuilder(SnapshotTableRequest prototype)

public static SnapshotTableRequest.Builder newBuilder(SnapshotTableRequest prototype)
Parameter
NameDescription
prototypeSnapshotTableRequest
Returns
TypeDescription
SnapshotTableRequest.Builder

parseDelimitedFrom(InputStream input)

public static SnapshotTableRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SnapshotTableRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SnapshotTableRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SnapshotTableRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SnapshotTableRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SnapshotTableRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SnapshotTableRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SnapshotTableRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SnapshotTableRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SnapshotTableRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SnapshotTableRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SnapshotTableRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SnapshotTableRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SnapshotTableRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SnapshotTableRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SnapshotTableRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SnapshotTableRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SnapshotTableRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SnapshotTableRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SnapshotTableRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SnapshotTableRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SnapshotTableRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SnapshotTableRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SnapshotTableRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SnapshotTableRequest> parser()
Returns
TypeDescription
Parser<SnapshotTableRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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.

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.

getParserForType()

public Parser<SnapshotTableRequest> getParserForType()
Returns
TypeDescription
Parser<SnapshotTableRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
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];

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.

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

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SnapshotTableRequest.Builder newBuilderForType()
Returns
TypeDescription
SnapshotTableRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SnapshotTableRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SnapshotTableRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SnapshotTableRequest.Builder toBuilder()
Returns
TypeDescription
SnapshotTableRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException