Package com.google.bigtable.admin.v2

Class Snapshot

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.bigtable.admin.v2.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:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Snapshot.Builder
    A snapshot of a table at a particular time.
    static enum 
    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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CREATE_TIME_FIELD_NUMBER
     
    static final int
    DATA_SIZE_BYTES_FIELD_NUMBER
     
    static final int
    DELETE_TIME_FIELD_NUMBER
     
    static final int
    DESCRIPTION_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    SOURCE_TABLE_FIELD_NUMBER
     
    static final int
    STATE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    com.google.protobuf.Timestamp
    getCreateTime()
    Output only.
    com.google.protobuf.TimestampOrBuilder
    getCreateTimeOrBuilder()
    Output only.
    long
    getDataSizeBytes()
    Output only.
    static Snapshot
    getDefaultInstance()
     
    Snapshot
    getDefaultInstanceForType()
     
    com.google.protobuf.Timestamp
    getDeleteTime()
    The time when the snapshot will be deleted.
    com.google.protobuf.TimestampOrBuilder
    getDeleteTimeOrBuilder()
    The time when the snapshot will be deleted.
    String
    getDescription()
    Description of the snapshot.
    com.google.protobuf.ByteString
    getDescriptionBytes()
    Description of the snapshot.
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getName()
    The unique name of the snapshot.
    com.google.protobuf.ByteString
    getNameBytes()
    The unique name of the snapshot.
    com.google.protobuf.Parser<Snapshot>
    getParserForType()
     
    int
    getSerializedSize()
     
    Table
    getSourceTable()
    Output only.
    TableOrBuilder
    getSourceTableOrBuilder()
    Output only.
    Snapshot.State
    getState()
    Output only.
    int
    getStateValue()
    Output only.
    boolean
    hasCreateTime()
    Output only.
    boolean
    hasDeleteTime()
    The time when the snapshot will be deleted.
    int
    hashCode()
     
    boolean
    hasSourceTable()
    Output only.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Snapshot.Builder
    newBuilder()
     
    static Snapshot.Builder
    newBuilder(Snapshot prototype)
     
    Snapshot.Builder
    newBuilderForType()
     
    protected Snapshot.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Snapshot
    parseDelimitedFrom(InputStream input)
     
    static Snapshot
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Snapshot
    parseFrom(byte[] data)
     
    static Snapshot
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Snapshot
    parseFrom(com.google.protobuf.ByteString data)
     
    static Snapshot
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Snapshot
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Snapshot
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Snapshot
    parseFrom(InputStream input)
     
    static Snapshot
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Snapshot
    parseFrom(ByteBuffer data)
     
    static Snapshot
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Snapshot>
    parser()
     
    Snapshot.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • SOURCE_TABLE_FIELD_NUMBER

      public static final int SOURCE_TABLE_FIELD_NUMBER
      See Also:

    • DATA_SIZE_BYTES_FIELD_NUMBER

      public static final int DATA_SIZE_BYTES_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • DELETE_TIME_FIELD_NUMBER

      public static final int DELETE_TIME_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

  • Method Details

    • 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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static Snapshot parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Snapshot parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • 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

    • newBuilder

      public static Snapshot.Builder newBuilder()

    • newBuilder

      public static Snapshot.Builder newBuilder(Snapshot prototype)

    • 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