Package com.google.bigtable.admin.v2

Interface SnapshotOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Snapshot, Snapshot.Builder
public interface SnapshotOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.Timestamp
    getCreateTime()
    Output only.
    com.google.protobuf.TimestampOrBuilder
    getCreateTimeOrBuilder()
    Output only.
    long
    getDataSizeBytes()
    Output only.
    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.
    String
    getName()
    The unique name of the snapshot.
    com.google.protobuf.ByteString
    getNameBytes()
    The unique name of the snapshot.
    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.
    boolean
    hasSourceTable()
    Output only.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getName

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

    • getNameBytes

      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;
      Returns:
      The bytes for name.

    • hasSourceTable

      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];
      Returns:
      Whether the sourceTable field is set.

    • getSourceTable

      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];
      Returns:
      The sourceTable.

    • getSourceTableOrBuilder

      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];

    • getDataSizeBytes

      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];
      Returns:
      The dataSizeBytes.

    • hasCreateTime

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

    • getCreateTime

      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];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      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];

    • hasDeleteTime

      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;
      Returns:
      Whether the deleteTime field is set.

    • getDeleteTime

      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;
      Returns:
      The deleteTime.

    • getDeleteTimeOrBuilder

      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;

    • getStateValue

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

    • getState

      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];
      Returns:
      The state.

    • getDescription

      String getDescription()
       Description of the snapshot.
      string description = 7;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Description of the snapshot.
      string description = 7;
      Returns:
      The bytes for description.