Fixed docstrings and skipped system tests on emulator.

Author: gkevinzheng

google/cloud/bigtable/backup.py

@@ -226,7 +226,7 @@ def size_bytes(self):
     def state(self):
         """The current state of this Backup.
 
-        :rtype: :class:`~google.cloud.bigtable.admin_v2.types.table.Backup.State`
+        :rtype: :class:`~google.cloud.bigtable_admin_v2.types.table.Backup.State`
         :returns: The current state of this Backup.
         """
         return self._state
@@ -342,7 +342,7 @@ def get(self):
         """Retrieves metadata of a pending or completed Backup.
 
         :returns: An instance of
-                 :class:`~google.cloud.bigtable.admin_v2.types.Backup`
+                 :class:`~google.cloud.bigtable_admin_v2.types.Backup`
 
         :raises google.api_core.exceptions.GoogleAPICallError: If the request
                 failed for any reason.

google/cloud/bigtable_admin_v2/overlay/services/bigtable_table_admin/async_client.py

@@ -144,15 +144,15 @@ async def restore_table(
     ) -> async_restore_table.AsyncRestoreTableOperation:
         r"""Create a new table by restoring from a completed backup. The
         returned table :class:`long-running operation
-        <google.cloud.bigtable.admin_v2.overlay.types.restore_table.RestoreTableOperation>`
+        <google.cloud.bigtable_admin_v2.overlay.types.restore_table.RestoreTableOperation>`
         can be used to track the progress of the operation, and to cancel it. The
         :attr:`metadata <google.api_core.operation.Operation.metadata>` field type is
-        :class:`RestoreTableMetadata <google.cloud.bigtable.admin_v2.types.RestoreTableMetadata>`.
+        :class:`RestoreTableMetadata <google.cloud.bigtable_admin_v2.types.RestoreTableMetadata>`.
         The :meth:`response <google.api_core.operation.Operation.result>` type is
-        :class:`google.cloud.bigtable.admin_v2.types.Table`, if successful.
+        :class:`google.cloud.bigtable_admin_v2.types.Table`, if successful.
 
-        Additionally, the returned :class:`long-running-operation <google.cloud.bigtable.admin_v2.overlay.types.async_restore_table.AsyncRestoreTableOperation>`
-        provides a method, :meth:`google.cloud.bigtable.admin_v2.overlay.types.async_restore_table.AsyncRestoreTableOperation.optimize_restore_table_operation` that
+        Additionally, the returned :class:`long-running-operation <google.cloud.bigtable_admin_v2.overlay.types.async_restore_table.AsyncRestoreTableOperation>`
+        provides a method, :meth:`google.cloud.bigtable_admin_v2.overlay.types.async_restore_table.AsyncRestoreTableOperation.optimize_restore_table_operation` that
         provides access to a :class:`google.api_core.operation_async.AsyncOperation` object representing the OptimizeRestoreTable long-running-operation
         after the current one has completed.
 
@@ -197,7 +197,7 @@ async def sample_restore_table():
                     response = await optimize_operation.result()
 
         Args:
-            request (Union[google.cloud.bigtable.admin_v2.types.RestoreTableRequest, dict]):
+            request (Union[google.cloud.bigtable_admin_v2.types.RestoreTableRequest, dict]):
                 The request object. The request for
                 [RestoreTable][google.bigtable.admin.v2.BigtableTableAdmin.RestoreTable].
             retry (google.api_core.retry.Retry): Designation of what errors, if any,
@@ -209,10 +209,10 @@ async def sample_restore_table():
                 be of type `bytes`.
 
         Returns:
-            google.cloud.bigtable.admin_v2.overlay.types.async_restore_table.AsyncRestoreTableOperation:
+            google.cloud.bigtable_admin_v2.overlay.types.async_restore_table.AsyncRestoreTableOperation:
                 An object representing a long-running operation.
 
-                The result type for the operation will be :class:`google.cloud.bigtable.admin_v2.types.Table` A collection of user data indexed by row, column, and timestamp.
+                The result type for the operation will be :class:`google.cloud.bigtable_admin_v2.types.Table` A collection of user data indexed by row, column, and timestamp.
                    Each table is served using the resources of its
                    parent cluster.
         """
@@ -273,7 +273,7 @@ async def sample_wait_for_consistency():
                 print(response)
 
         Args:
-            request (Union[google.cloud.bigtable.admin_v2.overlay.types.WaitForConsistencyRequest, dict]):
+            request (Union[google.cloud.bigtable_admin_v2.overlay.types.WaitForConsistencyRequest, dict]):
                 The request object.
             name (str):
                 Required. The unique name of the Table for which to

google/cloud/bigtable_admin_v2/overlay/services/bigtable_table_admin/client.py

@@ -144,15 +144,15 @@ def restore_table(
     ) -> restore_table.RestoreTableOperation:
         r"""Create a new table by restoring from a completed backup. The
         returned table :class:`long-running operation
-        <google.cloud.bigtable.admin_v2.overlay.types.restore_table.RestoreTableOperation>`
+        <google.cloud.bigtable_admin_v2.overlay.types.restore_table.RestoreTableOperation>`
         can be used to track the progress of the operation, and to cancel it. The
         :attr:`metadata <google.api_core.operation.Operation.metadata>` field type is
-        :class:`RestoreTableMetadata <google.cloud.bigtable.admin_v2.types.RestoreTableMetadata>`.
+        :class:`RestoreTableMetadata <google.cloud.bigtable_admin_v2.types.RestoreTableMetadata>`.
         The :meth:`response <google.api_core.operation.Operation.result>` type is
-        :class:`google.cloud.bigtable.admin_v2.types.Table`, if successful.
+        :class:`google.cloud.bigtable_admin_v2.types.Table`, if successful.
 
-        Additionally, the returned :class:`long-running-operation <google.cloud.bigtable.admin_v2.overlay.types.restore_table.RestoreTableOperation>`
-        provides a method, :meth:`google.cloud.bigtable.admin_v2.overlay.types.restore_table.RestoreTableOperation.optimize_restore_table_operation` that
+        Additionally, the returned :class:`long-running-operation <google.cloud.bigtable_admin_v2.overlay.types.restore_table.RestoreTableOperation>`
+        provides a method, :meth:`google.cloud.bigtable_admin_v2.overlay.types.restore_table.RestoreTableOperation.optimize_restore_table_operation` that
         provides access to a :class:`google.api_core.operation.Operation` object representing the OptimizeRestoreTable long-running-operation
         after the current one has completed.
 
@@ -197,7 +197,7 @@ def sample_restore_table():
                     response = optimize_operation.result()
 
         Args:
-            request (Union[google.cloud.bigtable.admin_v2.types.RestoreTableRequest, dict]):
+            request (Union[google.cloud.bigtable_admin_v2.types.RestoreTableRequest, dict]):
                 The request object. The request for
                 [RestoreTable][google.bigtable.admin.v2.BigtableTableAdmin.RestoreTable].
             retry (google.api_core.retry.Retry): Designation of what errors, if any,
@@ -209,10 +209,10 @@ def sample_restore_table():
                 be of type `bytes`.
 
         Returns:
-            google.cloud.bigtable.admin_v2.overlay.types.restore_table.RestoreTableOperation:
+            google.cloud.bigtable_admin_v2.overlay.types.restore_table.RestoreTableOperation:
                 An object representing a long-running operation.
 
-                The result type for the operation will be :class:`google.cloud.bigtable.admin_v2.types.Table` A collection of user data indexed by row, column, and timestamp.
+                The result type for the operation will be :class:`google.cloud.bigtable_admin_v2.types.Table` A collection of user data indexed by row, column, and timestamp.
                    Each table is served using the resources of its
                    parent cluster.
         """
@@ -273,7 +273,7 @@ def sample_wait_for_consistency():
                 print(response)
 
         Args:
-            request (Union[google.cloud.bigtable.admin_v2.overlay.types.WaitForConsistencyRequest, dict]):
+            request (Union[google.cloud.bigtable_admin_v2.overlay.types.WaitForConsistencyRequest, dict]):
                 The request object.
             name (str):
                 Required. The unique name of the Table for which to

google/cloud/bigtable_admin_v2/overlay/types/async_consistency.py

@@ -34,24 +34,24 @@ class _AsyncCheckConsistencyPollingFuture(async_future.AsyncFuture):
 
     **This class should not be instantiated by users** and should only be instantiated by the admin
     client's
-    :meth:`google.cloud.bigtable.admin_v2.overlay.services.bigtable_table_admin.AsyncBigtableTableAdminClient.wait_for_consistency`
+    :meth:`google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.AsyncBigtableTableAdminClient.wait_for_consistency`
     or
-    :meth:`google.cloud.bigtable.admin_v2.overlay.services.bigtable_table_admin.AsyncBigtableTableAdminClient.wait_for_replication`
+    :meth:`google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.AsyncBigtableTableAdminClient.wait_for_replication`
     methods.
 
     Args:
         check_consistency_call(Callable[
             [Optional[google.api_core.retry.Retry],
-            google.cloud.bigtable.admin_v2.types.CheckConsistencyResponse]):
+            google.cloud.bigtable_admin_v2.types.CheckConsistencyResponse]):
             A :meth:`check_consistency
-            <google.cloud.bigtable.admin_v2.overlay.services.bigtable_table_admin.AsyncBigtableTableAdminClient.check_consistency>`
+            <google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.AsyncBigtableTableAdminClient.check_consistency>`
             call from the admin client. The call should fix every user parameter except for retry,
             which will be done via :meth:`functools.partial`.
         default_retry(Optional[google.api_core.retry.Retry]): The `retry` parameter passed in to either
             :meth:`wait_for_consistency
-            <google.cloud.bigtable.admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.wait_for_consistency>`
+            <google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.wait_for_consistency>`
             or :meth:`wait_for_replication
-            <google.cloud.bigtable.admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.wait_for_replication>`
+            <google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.wait_for_replication>`
         retry (google.api_core.retry.AsyncRetry): The retry configuration used
             when polling. This can be used to control how often :meth:`done`
             is polled. Regardless of the retry's ``deadline``, it will be

google/cloud/bigtable_admin_v2/overlay/types/async_restore_table.py

@@ -30,7 +30,7 @@ class AsyncRestoreTableOperation(operation_async.AsyncOperation):
 
     **This class should not be instantiated by users** and should only be instantiated by the admin
     client's :meth:`restore_table
-    <google.cloud.bigtable.admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.restore_table>`
+    <google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.restore_table>`
     method.
 
     Args:

google/cloud/bigtable_admin_v2/overlay/types/consistency.py

@@ -34,17 +34,17 @@ class _CheckConsistencyPollingFuture(polling.PollingFuture):
 
     **This class should not be instantiated by users** and should only be instantiated by the admin
     client's
-    :meth:`google.cloud.bigtable.admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.wait_for_consistency`
+    :meth:`google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.wait_for_consistency`
     or
-    :meth:`google.cloud.bigtable.admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.wait_for_replication`
+    :meth:`google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.wait_for_replication`
     methods.
 
     Args:
         check_consistency_call(Callable[
             [Optional[google.api_core.retry.Retry],
-            google.cloud.bigtable.admin_v2.types.CheckConsistencyResponse]):
+            google.cloud.bigtable_admin_v2.types.CheckConsistencyResponse]):
             A :meth:`check_consistency
-            <google.cloud.bigtable.admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.check_consistency>`
+            <google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.check_consistency>`
             call from the admin client. The call should fix every user parameter,
             which will be done via :meth:`functools.partial`.
         polling (google.api_core.retry.Retry): The configuration used for polling.

google/cloud/bigtable_admin_v2/overlay/types/restore_table.py

@@ -30,7 +30,7 @@ class RestoreTableOperation(operation.Operation):
 
     **This class should not be instantiated by users** and should only be instantiated by the admin
     client's :meth:`restore_table
-    <google.cloud.bigtable.admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.restore_table>`
+    <google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.restore_table>`
     method.
 
     Args:
@@ -62,7 +62,7 @@ def optimize_restored_table_operation(self) -> Optional[operation.Operation]:
         The follow-up operation has
         :attr:`metadata <google.api_core.operation.Operation.metadata>` type
         :class:`OptimizeRestoredTableMetadata
-        <google.cloud.bigtable.admin_v2.types.bigtable_table_admin.OptimizeRestoredTableMetadata>`
+        <google.cloud.bigtable_admin_v2.types.bigtable_table_admin.OptimizeRestoredTableMetadata>`
         and no return value, but can be waited for with `result`.
 
         The current operation might not trigger a follow-up OptimizeRestoredTable operation, in which case, this

google/cloud/bigtable_admin_v2/overlay/types/wait_for_consistency_request.py

@@ -34,8 +34,8 @@
 # for an autogenerated call.
 class WaitForConsistencyRequest(proto.Message):
     """Wrapper class for encapsulating parameters for the `wait_for_consistency` method in both
-    :class:`google.cloud.bigtable.admin_v2.overlay.services.bigtable_table_admin.client.BigtableTableAdminClient`
-    and :class:`google.cloud.bigtable.admin_v2.overlay.services.bigtable_table_admin.async_client.BigtableTableAdmiAsyncClient`.
+    :class:`google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.client.BigtableTableAdminClient`
+    and :class:`google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.async_client.BigtableTableAdmiAsyncClient`.
 
 
     This message has `oneof`_ fields (mutually exclusive fields).
@@ -50,14 +50,14 @@ class WaitForConsistencyRequest(proto.Message):
             Required. The unique name of the Table for which to check
             replication consistency. Values are of the form
             ``projects/{project}/instances/{instance}/tables/{table}``.
-        standard_read_remote_writes (google.cloud.bigtable.admin_v2.types.StandardReadRemoteWrites):
+        standard_read_remote_writes (google.cloud.bigtable_admin_v2.types.StandardReadRemoteWrites):
             Checks that reads using an app profile with
             ``StandardIsolation`` can see all writes committed before
             the token was created, even if the read and write target
             different clusters.
 
             This field is a member of `oneof`_ ``mode``.
-        data_boost_read_local_writes (google.cloud.bigtable.admin_v2.types.DataBoostReadLocalWrites):
+        data_boost_read_local_writes (google.cloud.bigtable_admin_v2.types.DataBoostReadLocalWrites):
             Checks that reads using an app profile with
             ``DataBoostIsolationReadOnly`` can see all writes committed
             before the token was created, but only if the read and write

tests/system/admin_overlay/test_system_async.py

@@ -17,6 +17,7 @@
 from google.cloud import bigtable_admin_v2 as admin_v2
 from google.cloud.bigtable.data._cross_sync import CrossSync
 from google.cloud.bigtable.data import mutations, read_rows_query
+from google.cloud.environment_vars import BIGTABLE_EMULATOR
 
 from .conftest import (
     INSTANCE_PREFIX,
@@ -37,6 +38,7 @@
 from datetime import datetime, timedelta
 
 import pytest
+import os
 
 
 if CrossSync.is_async:
@@ -47,6 +49,12 @@
 
 __CROSS_SYNC_OUTPUT__ = "tests.system.admin_overlay.test_system_autogen"
 
+if os.getenv(BIGTABLE_EMULATOR):
+    pytest.skip(
+        allow_module_level=True,
+        reason="Emulator support for admin client tests unsupported.",
+    )
+
 
 @CrossSync.convert
 @CrossSync.pytest_fixture(scope="session")

tests/system/admin_overlay/test_system_autogen.py

@@ -19,6 +19,7 @@
 from google.cloud import bigtable_admin_v2 as admin_v2
 from google.cloud.bigtable.data._cross_sync import CrossSync
 from google.cloud.bigtable.data import mutations, read_rows_query
+from google.cloud.environment_vars import BIGTABLE_EMULATOR
 from .conftest import (
     INSTANCE_PREFIX,
     BACKUP_PREFIX,
@@ -36,8 +37,15 @@
 )
 from datetime import datetime, timedelta
 import pytest
+import os
 from google.api_core import operation as api_core_operation
 
+if os.getenv(BIGTABLE_EMULATOR):
+    pytest.skip(
+        allow_module_level=True,
+        reason="Emulator support for admin client tests unsupported.",
+    )
+
 
 @pytest.fixture(scope="session")
 def data_client(admin_overlay_project_id):