Package com.google.bigtable.admin.v2

Class Snapshot

  • All Implemented Interfaces:
    SnapshotOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Snapshot
extends com.google.protobuf.GeneratedMessageV3
implements SnapshotOrBuilder
     A snapshot of a table at a particular time. A snapshot can be used as a
 checkpoint for data restoration or a data source for a new table.

 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.Snapshot
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Snapshot.Builder
      A snapshot of a table at a particular time.
      static class  Snapshot.State
      Possible states of a snapshot.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         The unique name of the snapshot.
 Values are of the form
 `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
        string name = 1;
        Specified by:
        getName in interface SnapshotOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The unique name of the snapshot.
 Values are of the form
 `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
        string name = 1;
        Specified by:
        getNameBytes in interface SnapshotOrBuilder
        Returns:
        The bytes for name.

      • hasSourceTable

        public boolean hasSourceTable()
         Output only. The source table at the time the snapshot was taken.
        .google.bigtable.admin.v2.Table source_table = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasSourceTable in interface SnapshotOrBuilder
        Returns:
        Whether the sourceTable field is set.

      • getSourceTable

        public Table getSourceTable()
         Output only. The source table at the time the snapshot was taken.
        .google.bigtable.admin.v2.Table source_table = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSourceTable in interface SnapshotOrBuilder
        Returns:
        The sourceTable.

      • getSourceTableOrBuilder

        public TableOrBuilder getSourceTableOrBuilder()
         Output only. The source table at the time the snapshot was taken.
        .google.bigtable.admin.v2.Table source_table = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSourceTableOrBuilder in interface SnapshotOrBuilder

      • getDataSizeBytes

        public long getDataSizeBytes()
         Output only. The size of the data in the source table at the time the
 snapshot was taken. In some cases, this value may be computed
 asynchronously via a background process and a placeholder of 0 will be used
 in the meantime.
        int64 data_size_bytes = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDataSizeBytes in interface SnapshotOrBuilder
        Returns:
        The dataSizeBytes.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. The time when the snapshot is created.
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface SnapshotOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. The time when the snapshot is created.
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface SnapshotOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The time when the snapshot is created.
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface SnapshotOrBuilder

      • hasDeleteTime

        public boolean hasDeleteTime()
         The time when the snapshot will be deleted. The maximum amount of time a
 snapshot can stay active is 365 days. If 'ttl' is not specified,
 the default maximum of 365 days will be used.
        .google.protobuf.Timestamp delete_time = 5;
        Specified by:
        hasDeleteTime in interface SnapshotOrBuilder
        Returns:
        Whether the deleteTime field is set.

      • getDeleteTime

        public com.google.protobuf.Timestamp getDeleteTime()
         The time when the snapshot will be deleted. The maximum amount of time a
 snapshot can stay active is 365 days. If 'ttl' is not specified,
 the default maximum of 365 days will be used.
        .google.protobuf.Timestamp delete_time = 5;
        Specified by:
        getDeleteTime in interface SnapshotOrBuilder
        Returns:
        The deleteTime.

      • getDeleteTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder()
         The time when the snapshot will be deleted. The maximum amount of time a
 snapshot can stay active is 365 days. If 'ttl' is not specified,
 the default maximum of 365 days will be used.
        .google.protobuf.Timestamp delete_time = 5;
        Specified by:
        getDeleteTimeOrBuilder in interface SnapshotOrBuilder

      • getStateValue

        public int getStateValue()
         Output only. The current state of the snapshot.
        .google.bigtable.admin.v2.Snapshot.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateValue in interface SnapshotOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • getState

        public Snapshot.State getState()
         Output only. The current state of the snapshot.
        .google.bigtable.admin.v2.Snapshot.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getState in interface SnapshotOrBuilder
        Returns:
        The state.

      • getDescription

        public String getDescription()
         Description of the snapshot.
        string description = 7;
        Specified by:
        getDescription in interface SnapshotOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         Description of the snapshot.
        string description = 7;
        Specified by:
        getDescriptionBytes in interface SnapshotOrBuilder
        Returns:
        The bytes for description.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Snapshot parseFrom​(ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Snapshot parseFrom​(ByteBuffer data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Snapshot parseFrom​(com.google.protobuf.ByteString data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Snapshot parseFrom​(com.google.protobuf.ByteString data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Snapshot parseFrom​(byte[] data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Snapshot parseFrom​(byte[] data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Snapshot parseFrom​(com.google.protobuf.CodedInputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Snapshot.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Snapshot.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Snapshot.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Snapshot getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Snapshot> parser()

      • getParserForType

        public com.google.protobuf.Parser<Snapshot> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Snapshot getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder