diff --git a/google/cloud/bigtable/app_profile.py b/google/cloud/bigtable/app_profile.py index cb04ebfc7..8b36eaede 100644 --- a/google/cloud/bigtable/app_profile.py +++ b/google/cloud/bigtable/app_profile.py @@ -95,6 +95,7 @@ def name(self): .. literalinclude:: snippets.py :start-after: [START bigtable_app_profile_name] :end-before: [END bigtable_app_profile_name] + :dedent: 4 The AppProfile name is of the form ``"projects/../instances/../app_profile/{app_profile_id}"`` @@ -238,6 +239,7 @@ def reload(self): .. literalinclude:: snippets.py :start-after: [START bigtable_reload_app_profile] :end-before: [END bigtable_reload_app_profile] + :dedent: 4 """ app_profile_pb = self.instance_admin_client.get_app_profile(self.name) @@ -254,6 +256,7 @@ def exists(self): .. literalinclude:: snippets.py :start-after: [START bigtable_app_profile_exists] :end-before: [END bigtable_app_profile_exists] + :dedent: 4 :rtype: bool :returns: True if the AppProfile exists, else False. @@ -280,6 +283,7 @@ def create(self, ignore_warnings=None): .. literalinclude:: snippets.py :start-after: [START bigtable_create_app_profile] :end-before: [END bigtable_create_app_profile] + :dedent: 4 :type: ignore_warnings: bool :param: ignore_warnings: (Optional) If true, ignore safety checks when @@ -311,6 +315,7 @@ def update(self, ignore_warnings=None): .. literalinclude:: snippets.py :start-after: [START bigtable_update_app_profile] :end-before: [END bigtable_update_app_profile] + :dedent: 4 """ update_mask_pb = field_mask_pb2.FieldMask() @@ -336,6 +341,7 @@ def delete(self, ignore_warnings=None): .. literalinclude:: snippets.py :start-after: [START bigtable_delete_app_profile] :end-before: [END bigtable_delete_app_profile] + :dedent: 4 :type: ignore_warnings: bool :param: ignore_warnings: If true, ignore safety checks when deleting diff --git a/google/cloud/bigtable/batcher.py b/google/cloud/bigtable/batcher.py index 3a649049b..0994e289d 100644 --- a/google/cloud/bigtable/batcher.py +++ b/google/cloud/bigtable/batcher.py @@ -73,6 +73,7 @@ def mutate(self, row): .. literalinclude:: snippets.py :start-after: [START bigtable_batcher_mutate] :end-before: [END bigtable_batcher_mutate] + :dedent: 4 :type row: class :param row: class:`~google.cloud.bigtable.row.DirectRow`. @@ -112,6 +113,7 @@ def mutate_rows(self, rows): .. literalinclude:: snippets.py :start-after: [START bigtable_batcher_mutate_rows] :end-before: [END bigtable_batcher_mutate_rows] + :dedent: 4 :type rows: list:[`~google.cloud.bigtable.row.DirectRow`] :param rows: list:[`~google.cloud.bigtable.row.DirectRow`]. @@ -134,6 +136,7 @@ def flush(self): .. literalinclude:: snippets.py :start-after: [START bigtable_batcher_flush] :end-before: [END bigtable_batcher_flush] + :dedent: 4 """ if len(self.rows) != 0: diff --git a/google/cloud/bigtable/client.py b/google/cloud/bigtable/client.py index 8a8315623..935a0a3b6 100644 --- a/google/cloud/bigtable/client.py +++ b/google/cloud/bigtable/client.py @@ -206,6 +206,7 @@ def project_path(self): .. literalinclude:: snippets.py :start-after: [START bigtable_project_path] :end-before: [END bigtable_project_path] + :dedent: 4 The project name is of the form @@ -225,6 +226,7 @@ def table_data_client(self): .. literalinclude:: snippets.py :start-after: [START bigtable_table_data_client] :end-before: [END bigtable_table_data_client] + :dedent: 4 :rtype: :class:`.bigtable_v2.BigtableClient` :returns: A BigtableClient object. @@ -245,6 +247,7 @@ def table_admin_client(self): .. literalinclude:: snippets.py :start-after: [START bigtable_table_admin_client] :end-before: [END bigtable_table_admin_client] + :dedent: 4 :rtype: :class:`.bigtable_admin_pb2.BigtableTableAdmin` :returns: A BigtableTableAdmin instance. @@ -271,6 +274,7 @@ def instance_admin_client(self): .. literalinclude:: snippets.py :start-after: [START bigtable_instance_admin_client] :end-before: [END bigtable_instance_admin_client] + :dedent: 4 :rtype: :class:`.bigtable_admin_pb2.BigtableInstanceAdmin` :returns: A BigtableInstanceAdmin instance. @@ -296,6 +300,7 @@ def instance(self, instance_id, display_name=None, instance_type=None, labels=No .. literalinclude:: snippets.py :start-after: [START bigtable_create_prod_instance] :end-before: [END bigtable_create_prod_instance] + :dedent: 4 :type instance_id: str :param instance_id: The ID of the instance. @@ -345,6 +350,7 @@ def list_instances(self): .. literalinclude:: snippets.py :start-after: [START bigtable_list_instances] :end-before: [END bigtable_list_instances] + :dedent: 4 :rtype: tuple :returns: @@ -365,6 +371,7 @@ def list_clusters(self): .. literalinclude:: snippets.py :start-after: [START bigtable_list_clusters_in_project] :end-before: [END bigtable_list_clusters_in_project] + :dedent: 4 :rtype: tuple :returns: diff --git a/google/cloud/bigtable/cluster.py b/google/cloud/bigtable/cluster.py index b573705c0..b2957bc2a 100644 --- a/google/cloud/bigtable/cluster.py +++ b/google/cloud/bigtable/cluster.py @@ -99,6 +99,7 @@ def from_pb(cls, cluster_pb, instance): .. literalinclude:: snippets.py :start-after: [START bigtable_cluster_from_pb] :end-before: [END bigtable_cluster_from_pb] + :dedent: 4 :type cluster_pb: :class:`instance_pb2.Cluster` :param cluster_pb: An instance protobuf object. @@ -159,6 +160,7 @@ def name(self): .. literalinclude:: snippets.py :start-after: [START bigtable_cluster_name] :end-before: [END bigtable_cluster_name] + :dedent: 4 The cluster name is of the form @@ -180,6 +182,7 @@ def state(self): .. literalinclude:: snippets.py :start-after: [START bigtable_cluster_state] :end-before: [END bigtable_cluster_state] + :dedent: 4 """ return self._state @@ -206,6 +209,7 @@ def reload(self): .. literalinclude:: snippets.py :start-after: [START bigtable_reload_cluster] :end-before: [END bigtable_reload_cluster] + :dedent: 4 """ cluster_pb = self._instance._client.instance_admin_client.get_cluster(self.name) @@ -221,6 +225,7 @@ def exists(self): .. literalinclude:: snippets.py :start-after: [START bigtable_check_cluster_exists] :end-before: [END bigtable_check_cluster_exists] + :dedent: 4 :rtype: bool :returns: True if the table exists, else False. @@ -241,6 +246,7 @@ def create(self): .. literalinclude:: snippets.py :start-after: [START bigtable_create_cluster] :end-before: [END bigtable_create_cluster] + :dedent: 4 .. note:: @@ -274,6 +280,7 @@ def update(self): .. literalinclude:: snippets.py :start-after: [START bigtable_update_cluster] :end-before: [END bigtable_update_cluster] + :dedent: 4 .. note:: @@ -306,6 +313,7 @@ def delete(self): .. literalinclude:: snippets.py :start-after: [START bigtable_delete_cluster] :end-before: [END bigtable_delete_cluster] + :dedent: 4 Marks a cluster and all of its tables for permanent deletion in 7 days. diff --git a/google/cloud/bigtable/column_family.py b/google/cloud/bigtable/column_family.py index 8b536992f..0e884fa89 100644 --- a/google/cloud/bigtable/column_family.py +++ b/google/cloud/bigtable/column_family.py @@ -48,6 +48,7 @@ class MaxVersionsGCRule(GarbageCollectionRule): .. literalinclude:: snippets_table.py :start-after: [START bigtable_create_family_gc_max_versions] :end-before: [END bigtable_create_family_gc_max_versions] + :dedent: 4 :type max_num_versions: int :param max_num_versions: The maximum number of versions @@ -81,6 +82,7 @@ class MaxAgeGCRule(GarbageCollectionRule): .. literalinclude:: snippets_table.py :start-after: [START bigtable_create_family_gc_max_age] :end-before: [END bigtable_create_family_gc_max_age] + :dedent: 4 :type max_age: :class:`datetime.timedelta` :param max_age: The maximum age allowed for a cell in the table. @@ -115,6 +117,7 @@ class GCRuleUnion(GarbageCollectionRule): .. literalinclude:: snippets_table.py :start-after: [START bigtable_create_family_gc_union] :end-before: [END bigtable_create_family_gc_union] + :dedent: 4 :type rules: list :param rules: List of :class:`GarbageCollectionRule`. @@ -149,6 +152,7 @@ class GCRuleIntersection(GarbageCollectionRule): .. literalinclude:: snippets_table.py :start-after: [START bigtable_create_family_gc_intersection] :end-before: [END bigtable_create_family_gc_intersection] + :dedent: 4 :type rules: list :param rules: List of :class:`GarbageCollectionRule`. @@ -212,6 +216,7 @@ def name(self): .. literalinclude:: snippets_table.py :start-after: [START bigtable_column_family_name] :end-before: [END bigtable_column_family_name] + :dedent: 4 .. note:: @@ -258,6 +263,7 @@ def create(self): .. literalinclude:: snippets_table.py :start-after: [START bigtable_create_column_family] :end-before: [END bigtable_create_column_family] + :dedent: 4 """ column_family = self.to_pb() @@ -280,6 +286,7 @@ def update(self): .. literalinclude:: snippets_table.py :start-after: [START bigtable_update_column_family] :end-before: [END bigtable_update_column_family] + :dedent: 4 .. note:: @@ -306,6 +313,7 @@ def delete(self): .. literalinclude:: snippets_table.py :start-after: [START bigtable_delete_column_family] :end-before: [END bigtable_delete_column_family] + :dedent: 4 """ modification = table_admin_v2_pb2.ModifyColumnFamiliesRequest.Modification( diff --git a/google/cloud/bigtable/instance.py b/google/cloud/bigtable/instance.py index 0c8b81fa3..c5d3ce8b6 100644 --- a/google/cloud/bigtable/instance.py +++ b/google/cloud/bigtable/instance.py @@ -134,6 +134,7 @@ def from_pb(cls, instance_pb, client): .. literalinclude:: snippets.py :start-after: [START bigtable_instance_from_pb] :end-before: [END bigtable_instance_from_pb] + :dedent: 4 :type instance_pb: :class:`instance_pb2.Instance` :param instance_pb: An instance protobuf object. @@ -178,6 +179,7 @@ def name(self): .. literalinclude:: snippets.py :start-after: [START bigtable_instance_name] :end-before: [END bigtable_instance_name] + :dedent: 4 The instance name is of the form @@ -199,6 +201,7 @@ def state(self): .. literalinclude:: snippets.py :start-after: [START bigtable_instance_state] :end-before: [END bigtable_instance_state] + :dedent: 4 """ return self._state @@ -231,6 +234,7 @@ def create( .. literalinclude:: snippets.py :start-after: [START bigtable_create_prod_instance] :end-before: [END bigtable_create_prod_instance] + :dedent: 4 .. note:: @@ -331,6 +335,7 @@ def exists(self): .. literalinclude:: snippets.py :start-after: [START bigtable_check_instance_exists] :end-before: [END bigtable_check_instance_exists] + :dedent: 4 :rtype: bool :returns: True if the table exists, else False. @@ -350,6 +355,7 @@ def reload(self): .. literalinclude:: snippets.py :start-after: [START bigtable_reload_instance] :end-before: [END bigtable_reload_instance] + :dedent: 4 """ instance_pb = self._client.instance_admin_client.get_instance(self.name) @@ -365,6 +371,7 @@ def update(self): .. literalinclude:: snippets.py :start-after: [START bigtable_update_instance] :end-before: [END bigtable_update_instance] + :dedent: 4 .. note:: @@ -411,6 +418,7 @@ def delete(self): .. literalinclude:: snippets.py :start-after: [START bigtable_delete_instance] :end-before: [END bigtable_delete_instance] + :dedent: 4 Marks an instance and all of its tables for permanent deletion in 7 days. @@ -441,6 +449,7 @@ def get_iam_policy(self, requested_policy_version=None): .. literalinclude:: snippets.py :start-after: [START bigtable_get_iam_policy] :end-before: [END bigtable_get_iam_policy] + :dedent: 4 :type requested_policy_version: int or ``NoneType`` :param requested_policy_version: Optional. The version of IAM policies to request. @@ -480,6 +489,7 @@ class `google.cloud.bigtable.policy.Policy` .. literalinclude:: snippets.py :start-after: [START bigtable_set_iam_policy] :end-before: [END bigtable_set_iam_policy] + :dedent: 4 :type policy: :class:`google.cloud.bigtable.policy.Policy` :param policy: A new IAM policy to replace the current IAM policy @@ -503,6 +513,7 @@ def test_iam_permissions(self, permissions): .. literalinclude:: snippets.py :start-after: [START bigtable_test_iam_permissions] :end-before: [END bigtable_test_iam_permissions] + :dedent: 4 :type permissions: list :param permissions: The set of permissions to check for @@ -532,6 +543,7 @@ def cluster( .. literalinclude:: snippets.py :start-after: [START bigtable_create_cluster] :end-before: [END bigtable_create_cluster] + :dedent: 4 :type cluster_id: str :param cluster_id: The ID of the cluster. @@ -575,6 +587,7 @@ def list_clusters(self): .. literalinclude:: snippets.py :start-after: [START bigtable_list_clusters_on_instance] :end-before: [END bigtable_list_clusters_on_instance] + :dedent: 4 :rtype: tuple :returns: @@ -595,6 +608,7 @@ def table(self, table_id, mutation_timeout=None, app_profile_id=None): .. literalinclude:: snippets.py :start-after: [START bigtable_create_table] :end-before: [END bigtable_create_table] + :dedent: 4 :type table_id: str :param table_id: The ID of the table. @@ -620,6 +634,7 @@ def list_tables(self): .. literalinclude:: snippets.py :start-after: [START bigtable_list_tables] :end-before: [END bigtable_list_tables] + :dedent: 4 :rtype: list of :class:`Table ` :returns: The list of tables owned by the instance. @@ -655,6 +670,7 @@ def app_profile( .. literalinclude:: snippets.py :start-after: [START bigtable_create_app_profile] :end-before: [END bigtable_create_app_profile] + :dedent: 4 :type app_profile_id: str :param app_profile_id: The ID of the AppProfile. Must be of the form @@ -701,6 +717,7 @@ def list_app_profiles(self): .. literalinclude:: snippets.py :start-after: [START bigtable_list_app_profiles] :end-before: [END bigtable_list_app_profiles] + :dedent: 4 :rtype: :list:[`~google.cloud.bigtable.app_profile.AppProfile`] :returns: A :list:[`~google.cloud.bigtable.app_profile.AppProfile`]. diff --git a/google/cloud/bigtable/policy.py b/google/cloud/bigtable/policy.py index 65be0158a..1fd749424 100644 --- a/google/cloud/bigtable/policy.py +++ b/google/cloud/bigtable/policy.py @@ -106,6 +106,7 @@ def bigtable_admins(self): .. literalinclude:: snippets.py :start-after: [START bigtable_admins_policy] :end-before: [END bigtable_admins_policy] + :dedent: 4 """ result = set() for member in self.get(BIGTABLE_ADMIN_ROLE, ()): @@ -123,6 +124,7 @@ def bigtable_readers(self): .. literalinclude:: snippets.py :start-after: [START bigtable_readers_policy] :end-before: [END bigtable_readers_policy] + :dedent: 4 """ result = set() for member in self.get(BIGTABLE_READER_ROLE, ()): @@ -140,6 +142,7 @@ def bigtable_users(self): .. literalinclude:: snippets.py :start-after: [START bigtable_users_policy] :end-before: [END bigtable_users_policy] + :dedent: 4 """ result = set() for member in self.get(BIGTABLE_USER_ROLE, ()): @@ -157,6 +160,7 @@ def bigtable_viewers(self): .. literalinclude:: snippets.py :start-after: [START bigtable_viewers_policy] :end-before: [END bigtable_viewers_policy] + :dedent: 4 """ result = set() for member in self.get(BIGTABLE_VIEWER_ROLE, ()): diff --git a/google/cloud/bigtable/row.py b/google/cloud/bigtable/row.py index 079ba6c8f..92f5b818b 100644 --- a/google/cloud/bigtable/row.py +++ b/google/cloud/bigtable/row.py @@ -61,6 +61,7 @@ def row_key(self): .. literalinclude:: snippets_table.py :start-after: [START bigtable_row_row_key] :end-before: [END bigtable_row_row_key] + :dedent: 4 :rtype: bytes :returns: The key for the current row. @@ -76,6 +77,7 @@ def table(self): .. literalinclude:: snippets_table.py :start-after: [START bigtable_row_table] :end-before: [END bigtable_row_table] + :dedent: 4 :rtype: table: :class:`Table ` :returns: table: The table that owns the row. @@ -300,7 +302,7 @@ def get_mutations_size(self): .. literalinclude:: snippets_table.py :start-after: [START bigtable_row_get_mutations_size] :end-before: [END bigtable_row_get_mutations_size] - + :dedent: 4 """ mutation_size = 0 @@ -328,6 +330,7 @@ def set_cell(self, column_family_id, column, value, timestamp=None): .. literalinclude:: snippets_table.py :start-after: [START bigtable_row_set_cell] :end-before: [END bigtable_row_set_cell] + :dedent: 4 :type column_family_id: str :param column_family_id: The column family that contains the column. @@ -363,7 +366,7 @@ def delete(self): .. literalinclude:: snippets_table.py :start-after: [START bigtable_row_delete] :end-before: [END bigtable_row_delete] - + :dedent: 4 """ self._delete(state=None) @@ -382,6 +385,7 @@ def delete_cell(self, column_family_id, column, time_range=None): .. literalinclude:: snippets_table.py :start-after: [START bigtable_row_delete_cell] :end-before: [END bigtable_row_delete_cell] + :dedent: 4 :type column_family_id: str :param column_family_id: The column family that contains the column @@ -415,6 +419,7 @@ def delete_cells(self, column_family_id, columns, time_range=None): .. literalinclude:: snippets_table.py :start-after: [START bigtable_row_delete_cells] :end-before: [END bigtable_row_delete_cells] + :dedent: 4 :type column_family_id: str :param column_family_id: The column family that contains the column @@ -450,6 +455,7 @@ def commit(self): .. literalinclude:: snippets_table.py :start-after: [START bigtable_row_commit] :end-before: [END bigtable_row_commit] + :dedent: 4 :raises: :exc:`~.table.TooManyMutationsError` if the number of mutations is greater than 100,000. @@ -465,7 +471,7 @@ def clear(self): .. literalinclude:: snippets_table.py :start-after: [START bigtable_row_clear] :end-before: [END bigtable_row_clear] - + :dedent: 4 """ del self._pb_mutations[:] @@ -557,6 +563,7 @@ def commit(self): .. literalinclude:: snippets_table.py :start-after: [START bigtable_row_commit] :end-before: [END bigtable_row_commit] + :dedent: 4 :rtype: bool :returns: Flag indicating if the filter was matched (which also @@ -610,6 +617,7 @@ def set_cell(self, column_family_id, column, value, timestamp=None, state=True): .. literalinclude:: snippets_table.py :start-after: [START bigtable_row_set_cell] :end-before: [END bigtable_row_set_cell] + :dedent: 4 :type column_family_id: str :param column_family_id: The column family that contains the column. @@ -651,6 +659,7 @@ def delete(self, state=True): .. literalinclude:: snippets_table.py :start-after: [START bigtable_row_delete] :end-before: [END bigtable_row_delete] + :dedent: 4 :type state: bool :param state: (Optional) The state that the mutation should be @@ -673,6 +682,7 @@ def delete_cell(self, column_family_id, column, time_range=None, state=True): .. literalinclude:: snippets_table.py :start-after: [START bigtable_row_delete_cell] :end-before: [END bigtable_row_delete_cell] + :dedent: 4 :type column_family_id: str :param column_family_id: The column family that contains the column @@ -710,6 +720,7 @@ def delete_cells(self, column_family_id, columns, time_range=None, state=True): .. literalinclude:: snippets_table.py :start-after: [START bigtable_row_delete_cells] :end-before: [END bigtable_row_delete_cells] + :dedent: 4 :type column_family_id: str :param column_family_id: The column family that contains the column @@ -744,7 +755,7 @@ def clear(self): .. literalinclude:: snippets_table.py :start-after: [START bigtable_row_clear] :end-before: [END bigtable_row_clear] - + :dedent: 4 """ del self._true_pb_mutations[:] del self._false_pb_mutations[:] @@ -783,7 +794,7 @@ def clear(self): .. literalinclude:: snippets_table.py :start-after: [START bigtable_row_clear] :end-before: [END bigtable_row_clear] - + :dedent: 4 """ del self._rule_pb_list[:] @@ -802,6 +813,7 @@ def append_cell_value(self, column_family_id, column, value): .. literalinclude:: snippets_table.py :start-after: [START bigtable_row_append_cell_value] :end-before: [END bigtable_row_append_cell_value] + :dedent: 4 :type column_family_id: str :param column_family_id: The column family that contains the column. @@ -842,6 +854,7 @@ def increment_cell_value(self, column_family_id, column, int_value): .. literalinclude:: snippets_table.py :start-after: [START bigtable_row_increment_cell_value] :end-before: [END bigtable_row_increment_cell_value] + :dedent: 4 :type column_family_id: str :param column_family_id: The column family that contains the column. @@ -888,6 +901,7 @@ def commit(self): .. literalinclude:: snippets_table.py :start-after: [START bigtable_row_commit] :end-before: [END bigtable_row_commit] + :dedent: 4 :rtype: dict :returns: The new contents of all modified cells. Returned as a diff --git a/google/cloud/bigtable/row_data.py b/google/cloud/bigtable/row_data.py index 24078b849..38bf85956 100644 --- a/google/cloud/bigtable/row_data.py +++ b/google/cloud/bigtable/row_data.py @@ -184,6 +184,7 @@ def cells(self): .. literalinclude:: snippets_table.py :start-after: [START bigtable_row_data_cells] :end-before: [END bigtable_row_data_cells] + :dedent: 4 :rtype: dict :returns: Dictionary of the :class:`Cell` objects accumulated. This @@ -210,6 +211,7 @@ def find_cells(self, column_family_id, column): .. literalinclude:: snippets_table.py :start-after: [START bigtable_row_find_cells] :end-before: [END bigtable_row_find_cells] + :dedent: 4 Args: column_family_id (str): The ID of the column family. Must be of the @@ -247,6 +249,7 @@ def cell_value(self, column_family_id, column, index=0): .. literalinclude:: snippets_table.py :start-after: [START bigtable_row_cell_value] :end-before: [END bigtable_row_cell_value] + :dedent: 4 Args: column_family_id (str): The ID of the column family. Must be of the @@ -288,6 +291,7 @@ def cell_values(self, column_family_id, column, max_count=None): .. literalinclude:: snippets_table.py :start-after: [START bigtable_row_cell_values] :end-before: [END bigtable_row_cell_values] + :dedent: 4 Args: column_family_id (str): The ID of the column family. Must be of the diff --git a/google/cloud/bigtable/row_set.py b/google/cloud/bigtable/row_set.py index 0cb6443b0..aa3e5eb92 100644 --- a/google/cloud/bigtable/row_set.py +++ b/google/cloud/bigtable/row_set.py @@ -58,6 +58,7 @@ def add_row_key(self, row_key): .. literalinclude:: snippets_table.py :start-after: [START bigtable_add_row_key] :end-before: [END bigtable_add_row_key] + :dedent: 4 :type row_key: bytes :param row_key: The key of a row to read @@ -72,6 +73,7 @@ def add_row_range(self, row_range): .. literalinclude:: snippets_table.py :start-after: [START bigtable_add_row_range] :end-before: [END bigtable_add_row_range] + :dedent: 4 :type row_range: class:`RowRange` :param row_range: The row range object having start and end key @@ -88,6 +90,7 @@ def add_row_range_from_keys( .. literalinclude:: snippets_table.py :start-after: [START bigtable_row_range_from_keys] :end-before: [END bigtable_row_range_from_keys] + :dedent: 4 :type start_key: bytes :param start_key: (Optional) Start key of the row range. If left empty, diff --git a/google/cloud/bigtable/table.py b/google/cloud/bigtable/table.py index 9d2dc1acc..199269013 100644 --- a/google/cloud/bigtable/table.py +++ b/google/cloud/bigtable/table.py @@ -121,6 +121,7 @@ def name(self): .. literalinclude:: snippets_table.py :start-after: [START bigtable_table_name] :end-before: [END bigtable_table_name] + :dedent: 4 .. note:: @@ -149,6 +150,7 @@ def get_iam_policy(self): .. literalinclude:: snippets_table.py :start-after: [START bigtable_table_get_iam_policy] :end-before: [END bigtable_table_get_iam_policy] + :dedent: 4 :rtype: :class:`google.cloud.bigtable.policy.Policy` :returns: The current IAM policy of this table. @@ -169,6 +171,7 @@ class `google.cloud.bigtable.policy.Policy` .. literalinclude:: snippets_table.py :start-after: [START bigtable_table_set_iam_policy] :end-before: [END bigtable_table_set_iam_policy] + :dedent: 4 :type policy: :class:`google.cloud.bigtable.policy.Policy` :param policy: A new IAM policy to replace the current IAM policy @@ -190,6 +193,7 @@ def test_iam_permissions(self, permissions): .. literalinclude:: snippets_table.py :start-after: [START bigtable_table_test_iam_permissions] :end-before: [END bigtable_table_test_iam_permissions] + :dedent: 4 :type permissions: list :param permissions: The set of permissions to check for @@ -217,6 +221,7 @@ def column_family(self, column_family_id, gc_rule=None): .. literalinclude:: snippets_table.py :start-after: [START bigtable_table_column_family] :end-before: [END bigtable_table_column_family] + :dedent: 4 :type column_family_id: str :param column_family_id: The ID of the column family. Must be of the @@ -239,6 +244,7 @@ def row(self, row_key, filter_=None, append=False): .. literalinclude:: snippets_table.py :start-after: [START bigtable_table_row] :end-before: [END bigtable_table_row] + :dedent: 4 .. warning:: @@ -286,6 +292,7 @@ def append_row(self, row_key): .. literalinclude:: snippets_table.py :start-after: [START bigtable_table_append_row] :end-before: [END bigtable_table_append_row] + :dedent: 4 Args: row_key (bytes): The key for the row being created. @@ -303,6 +310,7 @@ def direct_row(self, row_key): .. literalinclude:: snippets_table.py :start-after: [START bigtable_table_direct_row] :end-before: [END bigtable_table_direct_row] + :dedent: 4 Args: row_key (bytes): The key for the row being created. @@ -320,6 +328,7 @@ def conditional_row(self, row_key, filter_): .. literalinclude:: snippets_table.py :start-after: [START bigtable_table_conditional_row] :end-before: [END bigtable_table_conditional_row] + :dedent: 4 Args: row_key (bytes): The key for the row being created. @@ -348,6 +357,7 @@ def create(self, initial_split_keys=[], column_families={}): .. literalinclude:: snippets_table.py :start-after: [START bigtable_create_table] :end-before: [END bigtable_create_table] + :dedent: 4 .. note:: @@ -392,6 +402,7 @@ def exists(self): .. literalinclude:: snippets_table.py :start-after: [START bigtable_check_table_exists] :end-before: [END bigtable_check_table_exists] + :dedent: 4 :rtype: bool :returns: True if the table exists, else False. @@ -411,7 +422,7 @@ def delete(self): .. literalinclude:: snippets_table.py :start-after: [START bigtable_delete_table] :end-before: [END bigtable_delete_table] - + :dedent: 4 """ table_client = self._instance._client.table_admin_client table_client.delete_table(name=self.name) @@ -424,6 +435,7 @@ def list_column_families(self): .. literalinclude:: snippets_table.py :start-after: [START bigtable_list_column_families] :end-before: [END bigtable_list_column_families] + :dedent: 4 :rtype: dict :returns: Dictionary of column families attached to this table. Keys @@ -451,6 +463,7 @@ def get_cluster_states(self): .. literalinclude:: snippets_table.py :start-after: [START bigtable_get_cluster_states] :end-before: [END bigtable_get_cluster_states] + :dedent: 4 :rtype: dict :returns: Dictionary of cluster states for this table. @@ -475,6 +488,7 @@ def read_row(self, row_key, filter_=None): .. literalinclude:: snippets_table.py :start-after: [START bigtable_read_row] :end-before: [END bigtable_read_row] + :dedent: 4 :type row_key: bytes :param row_key: The key of the row to read from. @@ -514,6 +528,7 @@ def read_rows( .. literalinclude:: snippets_table.py :start-after: [START bigtable_read_rows] :end-before: [END bigtable_read_rows] + :dedent: 4 :type start_key: bytes :param start_key: (Optional) The beginning of a range of row keys to @@ -617,6 +632,7 @@ def mutate_rows(self, rows, retry=DEFAULT_RETRY): .. literalinclude:: snippets_table.py :start-after: [START bigtable_mutate_rows] :end-before: [END bigtable_mutate_rows] + :dedent: 4 The method tries to update all specified rows. If some of the rows weren't updated, it would not remove mutations. @@ -661,6 +677,7 @@ def sample_row_keys(self): .. literalinclude:: snippets_table.py :start-after: [START bigtable_sample_row_keys] :end-before: [END bigtable_sample_row_keys] + :dedent: 4 The returned row keys will delimit contiguous sections of the table of approximately equal size, which can be used to break up the data for @@ -705,6 +722,7 @@ def truncate(self, timeout=None): .. literalinclude:: snippets_table.py :start-after: [START bigtable_truncate_table] :end-before: [END bigtable_truncate_table] + :dedent: 4 :type timeout: float :param timeout: (Optional) The amount of time, in seconds, to wait @@ -735,6 +753,7 @@ def drop_by_prefix(self, row_key_prefix, timeout=None): .. literalinclude:: snippets_table.py :start-after: [START bigtable_drop_by_prefix] :end-before: [END bigtable_drop_by_prefix] + :dedent: 4 :type row_key_prefix: bytes :param row_key_prefix: Delete all rows that start with this row key @@ -769,6 +788,7 @@ def mutations_batcher(self, flush_count=FLUSH_COUNT, max_row_bytes=MAX_ROW_BYTES .. literalinclude:: snippets_table.py :start-after: [START bigtable_mutations_batcher] :end-before: [END bigtable_mutations_batcher] + :dedent: 4 :type flush_count: int :param flush_count: (Optional) Maximum number of rows per batch. If it