diff --git a/packages/google-cloud-bigtable/google/cloud/bigtable/app_profile.py b/packages/google-cloud-bigtable/google/cloud/bigtable/app_profile.py index 12af35aa984a..badce32e982c 100644 --- a/packages/google-cloud-bigtable/google/cloud/bigtable/app_profile.py +++ b/packages/google-cloud-bigtable/google/cloud/bigtable/app_profile.py @@ -32,6 +32,9 @@ class AppProfile(object): """Representation of a Google Cloud Bigtable AppProfile. + .. deprecated:: 2.30.0 + Use :class:`google.cloud.bigtable_admin_v2.BigtableInstanceAdminClient` instead. + We can use a :class:`AppProfile` to: * :meth:`reload` itself @@ -246,6 +249,11 @@ def _to_pb(self): def reload(self): """Reload the metadata for this cluster + .. deprecated:: 2.30.0 + Use + :meth:`google.cloud.bigtable_admin_v2.BigtableInstanceAdminClient.get_app_profile` + instead. + For example: .. literalinclude:: snippets.py @@ -265,6 +273,11 @@ def reload(self): def exists(self): """Check whether the AppProfile already exists. + .. deprecated:: 2.30.0 + Use + :meth:`google.cloud.bigtable_admin_v2.BigtableInstanceAdminClient.get_app_profile` + instead. + For example: .. literalinclude:: snippets.py @@ -285,6 +298,11 @@ def exists(self): def create(self, ignore_warnings=None): """Create this AppProfile. + .. deprecated:: 2.30.0 + Use + :meth:`google.cloud.bigtable_admin_v2.BigtableInstanceAdminClient.create_app_profile` + instead. + .. note:: Uses the ``instance`` and ``app_profile_id`` on the current @@ -318,6 +336,11 @@ def create(self, ignore_warnings=None): def update(self, ignore_warnings=None): """Update this app_profile. + .. deprecated:: 2.30.0 + Use + :meth:`google.cloud.bigtable_admin_v2.BigtableInstanceAdminClient.update_app_profile` + instead. + .. note:: Update any or all of the following values: @@ -355,6 +378,11 @@ def update(self, ignore_warnings=None): def delete(self, ignore_warnings=None): """Delete this AppProfile. + .. deprecated:: 2.30.0 + Use + :meth:`google.cloud.bigtable_admin_v2.BigtableInstanceAdminClient.delete_app_profile` + instead. + For example: .. literalinclude:: snippets.py diff --git a/packages/google-cloud-bigtable/google/cloud/bigtable/cluster.py b/packages/google-cloud-bigtable/google/cloud/bigtable/cluster.py index a15b24dc1ec7..42f22fb7526a 100644 --- a/packages/google-cloud-bigtable/google/cloud/bigtable/cluster.py +++ b/packages/google-cloud-bigtable/google/cloud/bigtable/cluster.py @@ -31,6 +31,9 @@ class Cluster(object): """Representation of a Google Cloud Bigtable Cluster. + .. deprecated:: 2.30.0 + Use :class:`google.cloud.bigtable_admin_v2.BigtableInstanceAdminClient` instead. + We can use a :class:`Cluster` to: * :meth:`reload` itself @@ -300,6 +303,11 @@ def __ne__(self, other): def reload(self): """Reload the metadata for this cluster. + .. deprecated:: 2.30.0 + Use + :meth:`google.cloud.bigtable_admin_v2.BigtableInstanceAdminClient.get_cluster` + instead. + For example: .. literalinclude:: snippets.py @@ -318,6 +326,11 @@ def reload(self): def exists(self): """Check whether the cluster already exists. + .. deprecated:: 2.30.0 + Use + :meth:`google.cloud.bigtable_admin_v2.BigtableInstanceAdminClient.get_cluster` + instead. + For example: .. literalinclude:: snippets.py @@ -339,6 +352,11 @@ def exists(self): def create(self): """Create this cluster. + .. deprecated:: 2.30.0 + Use + :meth:`google.cloud.bigtable_admin_v2.BigtableInstanceAdminClient.create_cluster` + instead. + For example: .. literalinclude:: snippets.py @@ -385,6 +403,11 @@ def create(self): def update(self): """Update this cluster. + .. deprecated:: 2.30.0 + Use + :meth:`google.cloud.bigtable_admin_v2.BigtableInstanceAdminClient.partial_update_cluster` + instead. + For example: .. literalinclude:: snippets.py @@ -443,6 +466,11 @@ def disable_autoscaling(self, serve_nodes): """ Disable autoscaling by specifying the number of nodes. + .. deprecated:: 2.30.0 + Use + :meth:`google.cloud.bigtable_admin_v2.BigtableInstanceAdminClient.partial_update_cluster` + instead. + For example: .. literalinclude:: snippets.py @@ -475,6 +503,11 @@ def disable_autoscaling(self, serve_nodes): def delete(self): """Delete this cluster. + .. deprecated:: 2.30.0 + Use + :meth:`google.cloud.bigtable_admin_v2.BigtableInstanceAdminClient.delete_cluster` + instead. + For example: .. literalinclude:: snippets.py diff --git a/packages/google-cloud-bigtable/google/cloud/bigtable/column_family.py b/packages/google-cloud-bigtable/google/cloud/bigtable/column_family.py index 0adfb93fb3fb..c583a225896a 100644 --- a/packages/google-cloud-bigtable/google/cloud/bigtable/column_family.py +++ b/packages/google-cloud-bigtable/google/cloud/bigtable/column_family.py @@ -26,6 +26,9 @@ class GarbageCollectionRule(object): """Garbage collection rule for column families within a table. + .. deprecated:: 2.30.0 + Use :class:`google.cloud.bigtable_admin_v2.types.GcRule` instead. + Cells in the column family (within a table) fitting the rule will be deleted during garbage collection. @@ -44,6 +47,9 @@ class GarbageCollectionRule(object): class MaxVersionsGCRule(GarbageCollectionRule): """Garbage collection limiting the number of versions of a cell. + .. deprecated:: 2.30.0 + Use :class:`google.cloud.bigtable_admin_v2.types.GcRule` instead. + For example: .. literalinclude:: snippets_table.py @@ -78,6 +84,9 @@ def to_pb(self): class MaxAgeGCRule(GarbageCollectionRule): """Garbage collection limiting the age of a cell. + .. deprecated:: 2.30.0 + Use :class:`google.cloud.bigtable_admin_v2.types.GcRule` instead. + For example: .. literalinclude:: snippets_table.py @@ -113,6 +122,9 @@ def to_pb(self): class GCRuleUnion(GarbageCollectionRule): """Union of garbage collection rules. + .. deprecated:: 2.30.0 + Use :class:`google.cloud.bigtable_admin_v2.types.GcRule` instead. + For example: .. literalinclude:: snippets_table.py @@ -148,6 +160,9 @@ def to_pb(self): class GCRuleIntersection(GarbageCollectionRule): """Intersection of garbage collection rules. + .. deprecated:: 2.30.0 + Use :class:`google.cloud.bigtable_admin_v2.types.GcRule` instead. + For example: .. literalinclude:: snippets_table.py @@ -185,6 +200,9 @@ def to_pb(self): class ColumnFamily(object): """Representation of a Google Cloud Bigtable Column Family. + .. deprecated:: 2.30.0 + Use :class:`google.cloud.bigtable_admin_v2.BigtableTableAdminClient` instead. + We can use a :class:`ColumnFamily` to: * :meth:`create` itself @@ -259,6 +277,11 @@ def to_pb(self): def create(self): """Create this column family. + .. deprecated:: 2.30.0 + Use + :meth:`google.cloud.bigtable_admin_v2.BigtableTableAdminClient.modify_column_families` + instead. + For example: .. literalinclude:: snippets_table.py @@ -283,6 +306,11 @@ def create(self): def update(self): """Update this column family. + .. deprecated:: 2.30.0 + Use + :meth:`google.cloud.bigtable_admin_v2.BigtableTableAdminClient.modify_column_families` + instead. + For example: .. literalinclude:: snippets_table.py @@ -311,6 +339,11 @@ def update(self): def delete(self): """Delete this column family. + .. deprecated:: 2.30.0 + Use + :meth:`google.cloud.bigtable_admin_v2.BigtableTableAdminClient.modify_column_families` + instead. + For example: .. literalinclude:: snippets_table.py