add backup policy object to table class and retrieval methods

Author: kevkim-codes

google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/models/AuthorizedView.java

@@ -24,23 +24,26 @@
 import javax.annotation.Nonnull;
 
 /**
- * A class that wraps the {@link com.google.bigtable.admin.v2.AuthorizedView} protocol buffer
- * object.
+ * A class that wraps the {@link com.google.bigtable.admin.v2.AuthorizedView}
+ * protocol buffer object.
  *
- * <p>An AuthorizedView represents subsets of a particular table based on rules. The access to each
- * AuthorizedView can be configured separately from the Table.
+ * <p>
+ * An AuthorizedView represents subsets of a particular table based on rules.
+ * The access to each AuthorizedView can be configured separately from the
+ * Table.
  *
- * <p>Users can perform read/write operation on an AuthorizedView by providing an authorizedView id
- * besides a table id, in which case the semantics remain identical as reading/writing on a Table
- * except that visibility is restricted to the subset of the Table that the AuthorizedView
- * represents.
+ * <p>
+ * Users can perform read/write operation on an AuthorizedView by providing an
+ * authorizedView id besides a table id, in which case the semantics remain
+ * identical as reading/writing on a Table except that visibility is restricted
+ * to the subset of the Table that the AuthorizedView represents.
  */
 public final class AuthorizedView {
  private final com.google.bigtable.admin.v2.AuthorizedView proto;
 
  /**
- * Wraps the protobuf. This method is considered an internal implementation detail and not meant
- * to be used by applications.
+ * Wraps the protobuf. This method is considered an internal implementation
+ * detail and not meant to be used by applications.
  */
  @InternalApi
  public static AuthorizedView fromProto(
@@ -61,7 +64,7 @@ public String getId() {
  // Constructor ensures that name is not null.
  AuthorizedViewName fullName = AuthorizedViewName.parse(proto.getName());
 
- //noinspection ConstantConditions
+ // noinspection ConstantConditions
  return fullName.getAuthorizedView();
  }
 
@@ -70,7 +73,7 @@ public String getTableId() {
  // Constructor ensures that name is not null.
  AuthorizedViewName fullName = AuthorizedViewName.parse(proto.getName());
 
- //noinspection ConstantConditions
+ // noinspection ConstantConditions
  return fullName.getTable();
  }
 
@@ -79,7 +82,10 @@ public boolean isDeletionProtected() {
  return proto.getDeletionProtection();
  }
 
- /** Gets the type of this authorized view, which currently can only be a subset view. */
+ /**
+ * Gets the type of this authorized view, which currently can only be a subset
+ * view.
+ */
  public AuthorizedViewType getAuthorizedViewType() {
  if (proto.hasSubsetView()) {
  return SubsetView.fromProto(proto.getSubsetView());
@@ -90,8 +96,8 @@ public AuthorizedViewType getAuthorizedViewType() {
  }
 
  /**
- * Creates the request protobuf. This method is considered an internal implementation detail and
- * not meant to be used by applications.
+ * Creates the request protobuf. This method is considered an internal
+ * implementation detail and not meant to be used by applications.
  */
  @InternalApi
  public com.google.bigtable.admin.v2.AuthorizedView toProto() {
@@ -116,9 +122,10 @@ public int hashCode() {
  }
 
  /**
- * Represents a subset of a Table. Please check the implementations of this interface for more
- * details.
+ * Represents a subset of a Table. Please check the implementations of this
+ * interface for more details.
  */
  @InternalExtensionOnly
- public interface AuthorizedViewType {}
+ public interface AuthorizedViewType {
+ }
 }

google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/models/Table.java

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package com.google.cloud.bigtable.admin.v2.models;
 
 import com.google.api.core.InternalApi;
@@ -33,44 +34,49 @@ public enum ReplicationState {
  /** The replication state of the table is unknown in this cluster. */
  NOT_KNOWN(com.google.bigtable.admin.v2.Table.ClusterState.ReplicationState.STATE_NOT_KNOWN),
  /**
- * The cluster was recently created, and the table must finish copying over pre-existing data
- * from other clusters before it can begin receiving live replication updates and serving Data
- * API requests.
+ * The cluster was recently created, and the table must finish copying over
+ * pre-existing data from other clusters before it can begin receiving live
+ * replication updates and serving Data API requests.
  */
  INITIALIZING(com.google.bigtable.admin.v2.Table.ClusterState.ReplicationState.INITIALIZING),
  /**
- * The table is temporarily unable to serve Data API requests from this cluster due to planned
- * internal maintenance.
+ * The table is temporarily unable to serve Data API requests from this cluster
+ * due to planned internal maintenance.
  */
  PLANNED_MAINTENANCE(
  com.google.bigtable.admin.v2.Table.ClusterState.ReplicationState.PLANNED_MAINTENANCE),
  /**
- * The table is temporarily unable to serve Data API requests from this cluster due to unplanned
- * or emergency maintenance.
+ * The table is temporarily unable to serve Data API requests from this cluster
+ * due to unplanned or emergency maintenance.
  */
  UNPLANNED_MAINTENANCE(
  com.google.bigtable.admin.v2.Table.ClusterState.ReplicationState.UNPLANNED_MAINTENANCE),
  /**
- * The table can serve Data API requests from this cluster. Depending on replication delay,
- * reads may not immediately reflect the state of the table in other clusters.
+ * The table can serve Data API requests from this cluster. Depending on
+ * replication delay, reads may not immediately reflect the state of the 
+ * table in other clusters.
  */
  READY(com.google.bigtable.admin.v2.Table.ClusterState.ReplicationState.READY),
 
  /**
- * The table is fully created and ready for use after a restore, and is being optimized for
- * performance. When optimizations are complete, the table will transition to `READY` state.
+ * The table is fully created and ready for use after a restore, and is being
+ * optimized for performance. When optimizations are complete, the table will
+ * transition to`READY` state.
  */
  READY_OPTIMIZING(
  com.google.bigtable.admin.v2.Table.ClusterState.ReplicationState.READY_OPTIMIZING),
 
- /** The replication state of table is not known by this client. Please upgrade your client. */
+ /**
+ * The replication state of table is not known by this client. Please upgrade
+ * your client.
+ */
  UNRECOGNIZED(com.google.bigtable.admin.v2.Table.ClusterState.ReplicationState.UNRECOGNIZED);
 
  private final com.google.bigtable.admin.v2.Table.ClusterState.ReplicationState proto;
 
  /**
- * Wraps the protobuf. This method is considered an internal implementation detail and not meant
- * to be used by applications.
+ * Wraps the protobuf. This method is considered an internal implementation
+ * detail and not meant to be used by applications.
  */
  @InternalApi
  public static ReplicationState fromProto(
@@ -90,38 +96,40 @@ public static ReplicationState fromProto(
  }
 
  /**
- * Creates the request protobuf. This method is considered an internal implementation detail and
- * not meant to be used by applications.
+ * Creates the request protobuf. This method is considered an internal
+ * implementation detail and not meant to be used by applications.
  */
  @InternalApi
  public com.google.bigtable.admin.v2.Table.ClusterState.ReplicationState toProto() {
  return proto;
  }
  }
 
- public final class AutomatedBackupPolicy {
+ public final static class AutomatedBackupPolicy {
  private final com.google.bigtable.admin.v2.Table.AutomatedBackupPolicy proto;
 
  /**
- * Wraps the protobuf. This method is considered an internal implementation detail and not meant
- * to be used by applications.
+ * Wraps the protobuf. This method is considered an internal implementation
+ * detail and not meant to be used by applications.
  */
  @InternalApi
- public AutomatedBackupPolicy fromProto(
+ public static AutomatedBackupPolicy fromProto(
  @Nonnull com.google.bigtable.admin.v2.Table.AutomatedBackupPolicy proto) {
  return new AutomatedBackupPolicy(proto);
  }
 
- private AutomatedBackupPolicy(@Nonnull com.google.bigtable.admin.v2.Table.AutomatedBackupPolicy proto) {
+ private AutomatedBackupPolicy(
+ @Nonnull com.google.bigtable.admin.v2.Table.AutomatedBackupPolicy proto) {
  Preconditions.checkNotNull(proto);
- Preconditions.checkArgument(!proto.getRetentionPeriod().isInitialized(), "Retention Period must be set");
+ Preconditions.checkArgument(
+ !proto.getRetentionPeriod().isInitialized(), "Retention Period must be set");
  Preconditions.checkArgument(!proto.getFrequency().isInitialized(), "Frequency must be set");
  this.proto = proto;
  }
 
  /**
- * Creates the request protobuf. This method is considered an internal implementation detail and
- * not meant to be used by applications.
+ * Creates the request protobuf. This method is considered an internal
+ * implementation detail and not meant to be used by applications.
  */
  @InternalApi
  public com.google.bigtable.admin.v2.Table.AutomatedBackupPolicy toProto() {
@@ -136,52 +144,60 @@ public com.google.bigtable.admin.v2.Table.AutomatedBackupPolicy toProto() {
 
  private final Duration changeStreamRetention;
  private final boolean deletionProtection;
+ private static AutomatedBackupPolicy automatedBackupPolicy;
 
  @InternalApi
  public static Table fromProto(@Nonnull com.google.bigtable.admin.v2.Table proto) {
  ImmutableMap.Builder<String, ReplicationState> replicationStates = ImmutableMap.builder();
 
- for (Entry<String, com.google.bigtable.admin.v2.Table.ClusterState> entry :
- proto.getClusterStatesMap().entrySet()) {
+ for (Entry<String, com.google.bigtable.admin.v2.Table.ClusterState> entry : proto.getClusterStatesMap()
+ .entrySet()) {
  replicationStates.put(
  entry.getKey(), ReplicationState.fromProto(entry.getValue().getReplicationState()));
  }
 
  ImmutableList.Builder<ColumnFamily> columnFamilies = ImmutableList.builder();
 
- for (Entry<String, com.google.bigtable.admin.v2.ColumnFamily> entry :
- proto.getColumnFamiliesMap().entrySet()) {
+ for (Entry<String, com.google.bigtable.admin.v2.ColumnFamily> entry : proto.getColumnFamiliesMap().entrySet()) {
  columnFamilies.add(ColumnFamily.fromProto(entry.getKey(), entry.getValue()));
  }
 
  Duration changeStreamConfig = null;
  if (proto.hasChangeStreamConfig()) {
- changeStreamConfig =
- Duration.ofSeconds(
- proto.getChangeStreamConfig().getRetentionPeriod().getSeconds(),
- proto.getChangeStreamConfig().getRetentionPeriod().getNanos());
+ changeStreamConfig = Duration.ofSeconds(
+ proto.getChangeStreamConfig().getRetentionPeriod().getSeconds(),
+ proto.getChangeStreamConfig().getRetentionPeriod().getNanos());
+ }
+
+ if (proto.hasAutomatedBackupPolicy()) {
+ automatedBackupPolicy = AutomatedBackupPolicy.fromProto(proto.getAutomatedBackupPolicy());
+ } else {
+ automatedBackupPolicy = null;
  }
 
  return new Table(
  TableName.parse(proto.getName()),
  replicationStates.build(),
  columnFamilies.build(),
  changeStreamConfig,
- proto.getDeletionProtection());
+ proto.getDeletionProtection(), 
+ automatedBackupPolicy);
  }
 
  private Table(
  TableName tableName,
  Map<String, ReplicationState> replicationStatesByClusterId,
  List<ColumnFamily> columnFamilies,
  Duration changeStreamRetention,
- boolean deletionProtection) {
+ boolean deletionProtection,
+ AutomatedBackupPolicy automatedBackupPolicy) {
  this.instanceId = tableName.getInstance();
  this.id = tableName.getTable();
  this.replicationStatesByClusterId = replicationStatesByClusterId;
  this.columnFamilies = columnFamilies;
  this.changeStreamRetention = changeStreamRetention;
  this.deletionProtection = deletionProtection;
+ Table.automatedBackupPolicy = automatedBackupPolicy;
  }
 
  /** Gets the table's id. */
@@ -211,6 +227,16 @@ public boolean isDeletionProtected() {
  return deletionProtection;
  }
 
+ /** Returns whether this table has automated backups enabled. */
+ public boolean isAutomatedBackupEnabled() {
+ return automatedBackupPolicy == null ? false : true;
+ }
+
+ /** Returns the automated backup policy. */
+ public AutomatedBackupPolicy getAutomatedBackupPolicy() {
+ return automatedBackupPolicy;
+ }
+
  @Override
  public boolean equals(Object o) {
  if (this == o) {
@@ -225,7 +251,8 @@ public boolean equals(Object o) {
  && Objects.equal(replicationStatesByClusterId, table.replicationStatesByClusterId)
  && Objects.equal(columnFamilies, table.columnFamilies)
  && Objects.equal(changeStreamRetention, table.changeStreamRetention)
- && Objects.equal(deletionProtection, table.deletionProtection);
+ && Objects.equal(deletionProtection, table.deletionProtection)
+ && Objects.equal(automatedBackupPolicy, Table.automatedBackupPolicy);
  }
 
  @Override
@@ -236,6 +263,7 @@ public int hashCode() {
  replicationStatesByClusterId,
  columnFamilies,
  changeStreamRetention,
- deletionProtection);
+ deletionProtection,
+ automatedBackupPolicy);
  }
 }