From 90dd22c40708d82f31fdd93ab34bee6f24579680 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Thu, 1 Jun 2023 09:50:00 +0000 Subject: [PATCH] feat: Add MultisliceNode --- feat: Enable Force on DeleteQueuedResource PiperOrigin-RevId: 536935689 Source-Link: https://github.com/googleapis/googleapis/commit/5649269b4e6d024f45287e1610fb479cf4e726a8 Source-Link: https://github.com/googleapis/googleapis-gen/commit/9562345a095887618b945a5a7b671a2ad8a8536a Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiOTU2MjM0NWEwOTU4ODc2MThiOTQ1YTVhN2I2NzFhMmFkOGE4NTM2YSJ9 --- owl-bot-staging/v1/.coveragerc | 13 + owl-bot-staging/v1/.flake8 | 33 + owl-bot-staging/v1/MANIFEST.in | 2 + owl-bot-staging/v1/README.rst | 49 + owl-bot-staging/v1/docs/conf.py | 376 + owl-bot-staging/v1/docs/index.rst | 7 + owl-bot-staging/v1/docs/tpu_v1/services.rst | 6 + owl-bot-staging/v1/docs/tpu_v1/tpu.rst | 10 + owl-bot-staging/v1/docs/tpu_v1/types.rst | 6 + .../v1/google/cloud/tpu/__init__.py | 69 + .../v1/google/cloud/tpu/gapic_version.py | 16 + owl-bot-staging/v1/google/cloud/tpu/py.typed | 2 + .../v1/google/cloud/tpu_v1/__init__.py | 70 + .../google/cloud/tpu_v1/gapic_metadata.json | 133 + .../v1/google/cloud/tpu_v1/gapic_version.py | 16 + .../v1/google/cloud/tpu_v1/py.typed | 2 + .../google/cloud/tpu_v1/services/__init__.py | 15 + .../cloud/tpu_v1/services/tpu/__init__.py | 22 + .../cloud/tpu_v1/services/tpu/async_client.py | 1674 ++++ .../cloud/tpu_v1/services/tpu/client.py | 1892 ++++ .../cloud/tpu_v1/services/tpu/pagers.py | 381 + .../services/tpu/transports/__init__.py | 33 + .../tpu_v1/services/tpu/transports/base.py | 349 + .../tpu_v1/services/tpu/transports/grpc.py | 655 ++ .../services/tpu/transports/grpc_asyncio.py | 654 ++ .../v1/google/cloud/tpu_v1/types/__init__.py | 62 + .../v1/google/cloud/tpu_v1/types/cloud_tpu.py | 861 ++ owl-bot-staging/v1/mypy.ini | 3 + owl-bot-staging/v1/noxfile.py | 184 + .../snippet_metadata_google.cloud.tpu.v1.json | 1778 ++++ .../tpu_v1_generated_tpu_create_node_async.py | 61 + .../tpu_v1_generated_tpu_create_node_sync.py | 61 + .../tpu_v1_generated_tpu_delete_node_async.py | 56 + .../tpu_v1_generated_tpu_delete_node_sync.py | 56 + ...enerated_tpu_get_accelerator_type_async.py | 52 + ...generated_tpu_get_accelerator_type_sync.py | 52 + .../tpu_v1_generated_tpu_get_node_async.py | 52 + .../tpu_v1_generated_tpu_get_node_sync.py | 52 + ...rated_tpu_get_tensor_flow_version_async.py | 52 + ...erated_tpu_get_tensor_flow_version_sync.py | 52 + ...erated_tpu_list_accelerator_types_async.py | 53 + ...nerated_tpu_list_accelerator_types_sync.py | 53 + .../tpu_v1_generated_tpu_list_nodes_async.py | 53 + .../tpu_v1_generated_tpu_list_nodes_sync.py | 53 + ...ted_tpu_list_tensor_flow_versions_async.py | 53 + ...ated_tpu_list_tensor_flow_versions_sync.py | 53 + ...tpu_v1_generated_tpu_reimage_node_async.py | 55 + .../tpu_v1_generated_tpu_reimage_node_sync.py | 55 + .../tpu_v1_generated_tpu_start_node_async.py | 55 + .../tpu_v1_generated_tpu_start_node_sync.py | 55 + .../tpu_v1_generated_tpu_stop_node_async.py | 55 + .../tpu_v1_generated_tpu_stop_node_sync.py | 55 + .../v1/scripts/fixup_tpu_v1_keywords.py | 186 + owl-bot-staging/v1/setup.py | 90 + .../v1/testing/constraints-3.10.txt | 6 + .../v1/testing/constraints-3.11.txt | 6 + .../v1/testing/constraints-3.12.txt | 6 + .../v1/testing/constraints-3.7.txt | 9 + .../v1/testing/constraints-3.8.txt | 6 + .../v1/testing/constraints-3.9.txt | 6 + owl-bot-staging/v1/tests/__init__.py | 16 + owl-bot-staging/v1/tests/unit/__init__.py | 16 + .../v1/tests/unit/gapic/__init__.py | 16 + .../v1/tests/unit/gapic/tpu_v1/__init__.py | 16 + .../v1/tests/unit/gapic/tpu_v1/test_tpu.py | 4982 ++++++++++ owl-bot-staging/v2/.coveragerc | 13 + owl-bot-staging/v2/.flake8 | 33 + owl-bot-staging/v2/MANIFEST.in | 2 + owl-bot-staging/v2/README.rst | 49 + owl-bot-staging/v2/docs/conf.py | 376 + owl-bot-staging/v2/docs/index.rst | 7 + owl-bot-staging/v2/docs/tpu_v2/services.rst | 6 + owl-bot-staging/v2/docs/tpu_v2/tpu.rst | 10 + owl-bot-staging/v2/docs/tpu_v2/types.rst | 6 + .../v2/google/cloud/tpu/__init__.py | 97 + .../v2/google/cloud/tpu/gapic_version.py | 16 + owl-bot-staging/v2/google/cloud/tpu/py.typed | 2 + .../v2/google/cloud/tpu_v2/__init__.py | 98 + .../google/cloud/tpu_v2/gapic_metadata.json | 223 + .../v2/google/cloud/tpu_v2/gapic_version.py | 16 + .../v2/google/cloud/tpu_v2/py.typed | 2 + .../google/cloud/tpu_v2/services/__init__.py | 15 + .../cloud/tpu_v2/services/tpu/__init__.py | 22 + .../cloud/tpu_v2/services/tpu/async_client.py | 1885 ++++ .../cloud/tpu_v2/services/tpu/client.py | 2106 ++++ .../cloud/tpu_v2/services/tpu/pagers.py | 381 + .../services/tpu/transports/__init__.py | 38 + .../tpu_v2/services/tpu/transports/base.py | 377 + .../tpu_v2/services/tpu/transports/grpc.py | 708 ++ .../services/tpu/transports/grpc_asyncio.py | 707 ++ .../tpu_v2/services/tpu/transports/rest.py | 2247 +++++ .../v2/google/cloud/tpu_v2/types/__init__.py | 90 + .../v2/google/cloud/tpu_v2/types/cloud_tpu.py | 1243 +++ owl-bot-staging/v2/mypy.ini | 3 + owl-bot-staging/v2/noxfile.py | 184 + .../snippet_metadata_google.cloud.tpu.v2.json | 2100 ++++ .../tpu_v2_generated_tpu_create_node_async.py | 61 + .../tpu_v2_generated_tpu_create_node_sync.py | 61 + .../tpu_v2_generated_tpu_delete_node_async.py | 56 + .../tpu_v2_generated_tpu_delete_node_sync.py | 56 + ...ted_tpu_generate_service_identity_async.py | 52 + ...ated_tpu_generate_service_identity_sync.py | 52 + ...enerated_tpu_get_accelerator_type_async.py | 52 + ...generated_tpu_get_accelerator_type_sync.py | 52 + ...enerated_tpu_get_guest_attributes_async.py | 52 + ...generated_tpu_get_guest_attributes_sync.py | 52 + .../tpu_v2_generated_tpu_get_node_async.py | 52 + .../tpu_v2_generated_tpu_get_node_sync.py | 52 + ...generated_tpu_get_runtime_version_async.py | 52 + ..._generated_tpu_get_runtime_version_sync.py | 52 + ...erated_tpu_list_accelerator_types_async.py | 53 + ...nerated_tpu_list_accelerator_types_sync.py | 53 + .../tpu_v2_generated_tpu_list_nodes_async.py | 53 + .../tpu_v2_generated_tpu_list_nodes_sync.py | 53 + ...nerated_tpu_list_runtime_versions_async.py | 53 + ...enerated_tpu_list_runtime_versions_sync.py | 53 + .../tpu_v2_generated_tpu_start_node_async.py | 56 + .../tpu_v2_generated_tpu_start_node_sync.py | 56 + .../tpu_v2_generated_tpu_stop_node_async.py | 56 + .../tpu_v2_generated_tpu_stop_node_sync.py | 56 + .../tpu_v2_generated_tpu_update_node_async.py | 60 + .../tpu_v2_generated_tpu_update_node_sync.py | 60 + .../v2/scripts/fixup_tpu_v2_keywords.py | 188 + owl-bot-staging/v2/setup.py | 90 + .../v2/testing/constraints-3.10.txt | 6 + .../v2/testing/constraints-3.11.txt | 6 + .../v2/testing/constraints-3.12.txt | 6 + .../v2/testing/constraints-3.7.txt | 9 + .../v2/testing/constraints-3.8.txt | 6 + .../v2/testing/constraints-3.9.txt | 6 + owl-bot-staging/v2/tests/__init__.py | 16 + owl-bot-staging/v2/tests/unit/__init__.py | 16 + .../v2/tests/unit/gapic/__init__.py | 16 + .../v2/tests/unit/gapic/tpu_v2/__init__.py | 16 + .../v2/tests/unit/gapic/tpu_v2/test_tpu.py | 8760 +++++++++++++++++ owl-bot-staging/v2alpha1/.coveragerc | 13 + owl-bot-staging/v2alpha1/.flake8 | 33 + owl-bot-staging/v2alpha1/MANIFEST.in | 2 + owl-bot-staging/v2alpha1/README.rst | 49 + owl-bot-staging/v2alpha1/docs/conf.py | 376 + owl-bot-staging/v2alpha1/docs/index.rst | 7 + .../v2alpha1/docs/tpu_v2alpha1/services.rst | 6 + .../v2alpha1/docs/tpu_v2alpha1/tpu.rst | 10 + .../v2alpha1/docs/tpu_v2alpha1/types.rst | 6 + .../v2alpha1/google/cloud/tpu/__init__.py | 113 + .../google/cloud/tpu/gapic_version.py | 16 + .../v2alpha1/google/cloud/tpu/py.typed | 2 + .../google/cloud/tpu_v2alpha1/__init__.py | 114 + .../cloud/tpu_v2alpha1/gapic_metadata.json | 203 + .../cloud/tpu_v2alpha1/gapic_version.py | 16 + .../google/cloud/tpu_v2alpha1/py.typed | 2 + .../cloud/tpu_v2alpha1/services/__init__.py | 15 + .../tpu_v2alpha1/services/tpu/__init__.py | 22 + .../tpu_v2alpha1/services/tpu/async_client.py | 2445 +++++ .../cloud/tpu_v2alpha1/services/tpu/client.py | 2674 +++++ .../cloud/tpu_v2alpha1/services/tpu/pagers.py | 502 + .../services/tpu/transports/__init__.py | 33 + .../services/tpu/transports/base.py | 447 + .../services/tpu/transports/grpc.py | 838 ++ .../services/tpu/transports/grpc_asyncio.py | 837 ++ .../cloud/tpu_v2alpha1/types/__init__.py | 106 + .../cloud/tpu_v2alpha1/types/cloud_tpu.py | 1868 ++++ owl-bot-staging/v2alpha1/mypy.ini | 3 + owl-bot-staging/v2alpha1/noxfile.py | 184 + ...et_metadata_google.cloud.tpu.v2alpha1.json | 2913 ++++++ ...2alpha1_generated_tpu_create_node_async.py | 60 + ...v2alpha1_generated_tpu_create_node_sync.py | 60 + ...erated_tpu_create_queued_resource_async.py | 56 + ...nerated_tpu_create_queued_resource_sync.py | 56 + ...2alpha1_generated_tpu_delete_node_async.py | 56 + ...v2alpha1_generated_tpu_delete_node_sync.py | 56 + ...erated_tpu_delete_queued_resource_async.py | 56 + ...nerated_tpu_delete_queued_resource_sync.py | 56 + ...ted_tpu_generate_service_identity_async.py | 52 + ...ated_tpu_generate_service_identity_sync.py | 52 + ...enerated_tpu_get_accelerator_type_async.py | 52 + ...generated_tpu_get_accelerator_type_sync.py | 52 + ...enerated_tpu_get_guest_attributes_async.py | 52 + ...generated_tpu_get_guest_attributes_sync.py | 52 + ...u_v2alpha1_generated_tpu_get_node_async.py | 52 + ...pu_v2alpha1_generated_tpu_get_node_sync.py | 52 + ...generated_tpu_get_queued_resource_async.py | 52 + ..._generated_tpu_get_queued_resource_sync.py | 52 + ...generated_tpu_get_runtime_version_async.py | 52 + ..._generated_tpu_get_runtime_version_sync.py | 52 + ...erated_tpu_list_accelerator_types_async.py | 53 + ...nerated_tpu_list_accelerator_types_sync.py | 53 + ...v2alpha1_generated_tpu_list_nodes_async.py | 53 + ..._v2alpha1_generated_tpu_list_nodes_sync.py | 53 + ...nerated_tpu_list_queued_resources_async.py | 53 + ...enerated_tpu_list_queued_resources_sync.py | 53 + ...nerated_tpu_list_runtime_versions_async.py | 53 + ...enerated_tpu_list_runtime_versions_sync.py | 53 + ...ed_tpu_simulate_maintenance_event_async.py | 56 + ...ted_tpu_simulate_maintenance_event_sync.py | 56 + ...v2alpha1_generated_tpu_start_node_async.py | 56 + ..._v2alpha1_generated_tpu_start_node_sync.py | 56 + ..._v2alpha1_generated_tpu_stop_node_async.py | 56 + ...u_v2alpha1_generated_tpu_stop_node_sync.py | 56 + ...2alpha1_generated_tpu_update_node_async.py | 59 + ...v2alpha1_generated_tpu_update_node_sync.py | 59 + .../scripts/fixup_tpu_v2alpha1_keywords.py | 193 + owl-bot-staging/v2alpha1/setup.py | 90 + .../v2alpha1/testing/constraints-3.10.txt | 6 + .../v2alpha1/testing/constraints-3.11.txt | 6 + .../v2alpha1/testing/constraints-3.12.txt | 6 + .../v2alpha1/testing/constraints-3.7.txt | 9 + .../v2alpha1/testing/constraints-3.8.txt | 6 + .../v2alpha1/testing/constraints-3.9.txt | 6 + owl-bot-staging/v2alpha1/tests/__init__.py | 16 + .../v2alpha1/tests/unit/__init__.py | 16 + .../v2alpha1/tests/unit/gapic/__init__.py | 16 + .../tests/unit/gapic/tpu_v2alpha1/__init__.py | 16 + .../tests/unit/gapic/tpu_v2alpha1/test_tpu.py | 6686 +++++++++++++ 214 files changed, 62432 insertions(+) create mode 100644 owl-bot-staging/v1/.coveragerc create mode 100644 owl-bot-staging/v1/.flake8 create mode 100644 owl-bot-staging/v1/MANIFEST.in create mode 100644 owl-bot-staging/v1/README.rst create mode 100644 owl-bot-staging/v1/docs/conf.py create mode 100644 owl-bot-staging/v1/docs/index.rst create mode 100644 owl-bot-staging/v1/docs/tpu_v1/services.rst create mode 100644 owl-bot-staging/v1/docs/tpu_v1/tpu.rst create mode 100644 owl-bot-staging/v1/docs/tpu_v1/types.rst create mode 100644 owl-bot-staging/v1/google/cloud/tpu/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/tpu/gapic_version.py create mode 100644 owl-bot-staging/v1/google/cloud/tpu/py.typed create mode 100644 owl-bot-staging/v1/google/cloud/tpu_v1/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/tpu_v1/gapic_metadata.json create mode 100644 owl-bot-staging/v1/google/cloud/tpu_v1/gapic_version.py create mode 100644 owl-bot-staging/v1/google/cloud/tpu_v1/py.typed create mode 100644 owl-bot-staging/v1/google/cloud/tpu_v1/services/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/tpu_v1/services/tpu/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/tpu_v1/services/tpu/async_client.py create mode 100644 owl-bot-staging/v1/google/cloud/tpu_v1/services/tpu/client.py create mode 100644 owl-bot-staging/v1/google/cloud/tpu_v1/services/tpu/pagers.py create mode 100644 owl-bot-staging/v1/google/cloud/tpu_v1/services/tpu/transports/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/tpu_v1/services/tpu/transports/base.py create mode 100644 owl-bot-staging/v1/google/cloud/tpu_v1/services/tpu/transports/grpc.py create mode 100644 owl-bot-staging/v1/google/cloud/tpu_v1/services/tpu/transports/grpc_asyncio.py create mode 100644 owl-bot-staging/v1/google/cloud/tpu_v1/types/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/tpu_v1/types/cloud_tpu.py create mode 100644 owl-bot-staging/v1/mypy.ini create mode 100644 owl-bot-staging/v1/noxfile.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/snippet_metadata_google.cloud.tpu.v1.json create mode 100644 owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_create_node_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_create_node_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_delete_node_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_delete_node_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_get_accelerator_type_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_get_accelerator_type_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_get_node_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_get_node_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_get_tensor_flow_version_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_get_tensor_flow_version_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_list_accelerator_types_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_list_accelerator_types_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_list_nodes_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_list_nodes_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_list_tensor_flow_versions_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_list_tensor_flow_versions_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_reimage_node_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_reimage_node_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_start_node_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_start_node_sync.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_stop_node_async.py create mode 100644 owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_stop_node_sync.py create mode 100644 owl-bot-staging/v1/scripts/fixup_tpu_v1_keywords.py create mode 100644 owl-bot-staging/v1/setup.py create mode 100644 owl-bot-staging/v1/testing/constraints-3.10.txt create mode 100644 owl-bot-staging/v1/testing/constraints-3.11.txt create mode 100644 owl-bot-staging/v1/testing/constraints-3.12.txt create mode 100644 owl-bot-staging/v1/testing/constraints-3.7.txt create mode 100644 owl-bot-staging/v1/testing/constraints-3.8.txt create mode 100644 owl-bot-staging/v1/testing/constraints-3.9.txt create mode 100644 owl-bot-staging/v1/tests/__init__.py create mode 100644 owl-bot-staging/v1/tests/unit/__init__.py create mode 100644 owl-bot-staging/v1/tests/unit/gapic/__init__.py create mode 100644 owl-bot-staging/v1/tests/unit/gapic/tpu_v1/__init__.py create mode 100644 owl-bot-staging/v1/tests/unit/gapic/tpu_v1/test_tpu.py create mode 100644 owl-bot-staging/v2/.coveragerc create mode 100644 owl-bot-staging/v2/.flake8 create mode 100644 owl-bot-staging/v2/MANIFEST.in create mode 100644 owl-bot-staging/v2/README.rst create mode 100644 owl-bot-staging/v2/docs/conf.py create mode 100644 owl-bot-staging/v2/docs/index.rst create mode 100644 owl-bot-staging/v2/docs/tpu_v2/services.rst create mode 100644 owl-bot-staging/v2/docs/tpu_v2/tpu.rst create mode 100644 owl-bot-staging/v2/docs/tpu_v2/types.rst create mode 100644 owl-bot-staging/v2/google/cloud/tpu/__init__.py create mode 100644 owl-bot-staging/v2/google/cloud/tpu/gapic_version.py create mode 100644 owl-bot-staging/v2/google/cloud/tpu/py.typed create mode 100644 owl-bot-staging/v2/google/cloud/tpu_v2/__init__.py create mode 100644 owl-bot-staging/v2/google/cloud/tpu_v2/gapic_metadata.json create mode 100644 owl-bot-staging/v2/google/cloud/tpu_v2/gapic_version.py create mode 100644 owl-bot-staging/v2/google/cloud/tpu_v2/py.typed create mode 100644 owl-bot-staging/v2/google/cloud/tpu_v2/services/__init__.py create mode 100644 owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/__init__.py create mode 100644 owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/async_client.py create mode 100644 owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/client.py create mode 100644 owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/pagers.py create mode 100644 owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/transports/__init__.py create mode 100644 owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/transports/base.py create mode 100644 owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/transports/grpc.py create mode 100644 owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/transports/grpc_asyncio.py create mode 100644 owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/transports/rest.py create mode 100644 owl-bot-staging/v2/google/cloud/tpu_v2/types/__init__.py create mode 100644 owl-bot-staging/v2/google/cloud/tpu_v2/types/cloud_tpu.py create mode 100644 owl-bot-staging/v2/mypy.ini create mode 100644 owl-bot-staging/v2/noxfile.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.cloud.tpu.v2.json create mode 100644 owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_create_node_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_create_node_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_delete_node_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_delete_node_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_generate_service_identity_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_generate_service_identity_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_get_accelerator_type_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_get_accelerator_type_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_get_guest_attributes_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_get_guest_attributes_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_get_node_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_get_node_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_get_runtime_version_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_get_runtime_version_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_list_accelerator_types_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_list_accelerator_types_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_list_nodes_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_list_nodes_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_list_runtime_versions_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_list_runtime_versions_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_start_node_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_start_node_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_stop_node_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_stop_node_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_update_node_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_update_node_sync.py create mode 100644 owl-bot-staging/v2/scripts/fixup_tpu_v2_keywords.py create mode 100644 owl-bot-staging/v2/setup.py create mode 100644 owl-bot-staging/v2/testing/constraints-3.10.txt create mode 100644 owl-bot-staging/v2/testing/constraints-3.11.txt create mode 100644 owl-bot-staging/v2/testing/constraints-3.12.txt create mode 100644 owl-bot-staging/v2/testing/constraints-3.7.txt create mode 100644 owl-bot-staging/v2/testing/constraints-3.8.txt create mode 100644 owl-bot-staging/v2/testing/constraints-3.9.txt create mode 100644 owl-bot-staging/v2/tests/__init__.py create mode 100644 owl-bot-staging/v2/tests/unit/__init__.py create mode 100644 owl-bot-staging/v2/tests/unit/gapic/__init__.py create mode 100644 owl-bot-staging/v2/tests/unit/gapic/tpu_v2/__init__.py create mode 100644 owl-bot-staging/v2/tests/unit/gapic/tpu_v2/test_tpu.py create mode 100644 owl-bot-staging/v2alpha1/.coveragerc create mode 100644 owl-bot-staging/v2alpha1/.flake8 create mode 100644 owl-bot-staging/v2alpha1/MANIFEST.in create mode 100644 owl-bot-staging/v2alpha1/README.rst create mode 100644 owl-bot-staging/v2alpha1/docs/conf.py create mode 100644 owl-bot-staging/v2alpha1/docs/index.rst create mode 100644 owl-bot-staging/v2alpha1/docs/tpu_v2alpha1/services.rst create mode 100644 owl-bot-staging/v2alpha1/docs/tpu_v2alpha1/tpu.rst create mode 100644 owl-bot-staging/v2alpha1/docs/tpu_v2alpha1/types.rst create mode 100644 owl-bot-staging/v2alpha1/google/cloud/tpu/__init__.py create mode 100644 owl-bot-staging/v2alpha1/google/cloud/tpu/gapic_version.py create mode 100644 owl-bot-staging/v2alpha1/google/cloud/tpu/py.typed create mode 100644 owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/__init__.py create mode 100644 owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/gapic_metadata.json create mode 100644 owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/gapic_version.py create mode 100644 owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/py.typed create mode 100644 owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/__init__.py create mode 100644 owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/tpu/__init__.py create mode 100644 owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/tpu/async_client.py create mode 100644 owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/tpu/client.py create mode 100644 owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/tpu/pagers.py create mode 100644 owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/tpu/transports/__init__.py create mode 100644 owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/tpu/transports/base.py create mode 100644 owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/tpu/transports/grpc.py create mode 100644 owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/tpu/transports/grpc_asyncio.py create mode 100644 owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/types/__init__.py create mode 100644 owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/types/cloud_tpu.py create mode 100644 owl-bot-staging/v2alpha1/mypy.ini create mode 100644 owl-bot-staging/v2alpha1/noxfile.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/snippet_metadata_google.cloud.tpu.v2alpha1.json create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_create_node_async.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_create_node_sync.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_create_queued_resource_async.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_create_queued_resource_sync.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_delete_node_async.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_delete_node_sync.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_delete_queued_resource_async.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_delete_queued_resource_sync.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_generate_service_identity_async.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_generate_service_identity_sync.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_accelerator_type_async.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_accelerator_type_sync.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_guest_attributes_async.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_guest_attributes_sync.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_node_async.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_node_sync.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_queued_resource_async.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_queued_resource_sync.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_runtime_version_async.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_runtime_version_sync.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_list_accelerator_types_async.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_list_accelerator_types_sync.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_list_nodes_async.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_list_nodes_sync.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_list_queued_resources_async.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_list_queued_resources_sync.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_list_runtime_versions_async.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_list_runtime_versions_sync.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_simulate_maintenance_event_async.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_simulate_maintenance_event_sync.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_start_node_async.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_start_node_sync.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_stop_node_async.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_stop_node_sync.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_update_node_async.py create mode 100644 owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_update_node_sync.py create mode 100644 owl-bot-staging/v2alpha1/scripts/fixup_tpu_v2alpha1_keywords.py create mode 100644 owl-bot-staging/v2alpha1/setup.py create mode 100644 owl-bot-staging/v2alpha1/testing/constraints-3.10.txt create mode 100644 owl-bot-staging/v2alpha1/testing/constraints-3.11.txt create mode 100644 owl-bot-staging/v2alpha1/testing/constraints-3.12.txt create mode 100644 owl-bot-staging/v2alpha1/testing/constraints-3.7.txt create mode 100644 owl-bot-staging/v2alpha1/testing/constraints-3.8.txt create mode 100644 owl-bot-staging/v2alpha1/testing/constraints-3.9.txt create mode 100644 owl-bot-staging/v2alpha1/tests/__init__.py create mode 100644 owl-bot-staging/v2alpha1/tests/unit/__init__.py create mode 100644 owl-bot-staging/v2alpha1/tests/unit/gapic/__init__.py create mode 100644 owl-bot-staging/v2alpha1/tests/unit/gapic/tpu_v2alpha1/__init__.py create mode 100644 owl-bot-staging/v2alpha1/tests/unit/gapic/tpu_v2alpha1/test_tpu.py diff --git a/owl-bot-staging/v1/.coveragerc b/owl-bot-staging/v1/.coveragerc new file mode 100644 index 0000000..2800d3d --- /dev/null +++ b/owl-bot-staging/v1/.coveragerc @@ -0,0 +1,13 @@ +[run] +branch = True + +[report] +show_missing = True +omit = + google/cloud/tpu/__init__.py + google/cloud/tpu/gapic_version.py +exclude_lines = + # Re-enable the standard pragma + pragma: NO COVER + # Ignore debug-only repr + def __repr__ diff --git a/owl-bot-staging/v1/.flake8 b/owl-bot-staging/v1/.flake8 new file mode 100644 index 0000000..29227d4 --- /dev/null +++ b/owl-bot-staging/v1/.flake8 @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- +# +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Generated by synthtool. DO NOT EDIT! +[flake8] +ignore = E203, E266, E501, W503 +exclude = + # Exclude generated code. + **/proto/** + **/gapic/** + **/services/** + **/types/** + *_pb2.py + + # Standard linting exemptions. + **/.nox/** + __pycache__, + .git, + *.pyc, + conf.py diff --git a/owl-bot-staging/v1/MANIFEST.in b/owl-bot-staging/v1/MANIFEST.in new file mode 100644 index 0000000..14ef934 --- /dev/null +++ b/owl-bot-staging/v1/MANIFEST.in @@ -0,0 +1,2 @@ +recursive-include google/cloud/tpu *.py +recursive-include google/cloud/tpu_v1 *.py diff --git a/owl-bot-staging/v1/README.rst b/owl-bot-staging/v1/README.rst new file mode 100644 index 0000000..a9af6a5 --- /dev/null +++ b/owl-bot-staging/v1/README.rst @@ -0,0 +1,49 @@ +Python Client for Google Cloud Tpu API +================================================= + +Quick Start +----------- + +In order to use this library, you first need to go through the following steps: + +1. `Select or create a Cloud Platform project.`_ +2. `Enable billing for your project.`_ +3. Enable the Google Cloud Tpu API. +4. `Setup Authentication.`_ + +.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project +.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project +.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html + +Installation +~~~~~~~~~~~~ + +Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to +create isolated Python environments. The basic problem it addresses is one of +dependencies and versions, and indirectly permissions. + +With `virtualenv`_, it's possible to install this library without needing system +install permissions, and without clashing with the installed system +dependencies. + +.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/ + + +Mac/Linux +^^^^^^^^^ + +.. code-block:: console + + python3 -m venv + source /bin/activate + /bin/pip install /path/to/library + + +Windows +^^^^^^^ + +.. code-block:: console + + python3 -m venv + \Scripts\activate + \Scripts\pip.exe install \path\to\library diff --git a/owl-bot-staging/v1/docs/conf.py b/owl-bot-staging/v1/docs/conf.py new file mode 100644 index 0000000..096ffc7 --- /dev/null +++ b/owl-bot-staging/v1/docs/conf.py @@ -0,0 +1,376 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# +# google-cloud-tpu documentation build configuration file +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os +import shlex + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath("..")) + +__version__ = "0.1.0" + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +needs_sphinx = "4.0.1" + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.autosummary", + "sphinx.ext.intersphinx", + "sphinx.ext.coverage", + "sphinx.ext.napoleon", + "sphinx.ext.todo", + "sphinx.ext.viewcode", +] + +# autodoc/autosummary flags +autoclass_content = "both" +autodoc_default_flags = ["members"] +autosummary_generate = True + + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +# Allow markdown includes (so releases.md can include CHANGLEOG.md) +# http://www.sphinx-doc.org/en/master/markdown.html +source_parsers = {".md": "recommonmark.parser.CommonMarkParser"} + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +source_suffix = [".rst", ".md"] + +# The encoding of source files. +# source_encoding = 'utf-8-sig' + +# The root toctree document. +root_doc = "index" + +# General information about the project. +project = u"google-cloud-tpu" +copyright = u"2022, Google, LLC" +author = u"Google APIs" # TODO: autogenerate this bit + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The full version, including alpha/beta/rc tags. +release = __version__ +# The short X.Y version. +version = ".".join(release.split(".")[0:2]) + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# today = '' +# Else, today_fmt is used as the format for a strftime call. +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ["_build"] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = "sphinx" + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = "alabaster" + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +html_theme_options = { + "description": "Google Cloud Client Libraries for Python", + "github_user": "googleapis", + "github_repo": "google-cloud-python", + "github_banner": True, + "font_family": "'Roboto', Georgia, sans", + "head_font_family": "'Roboto', Georgia, serif", + "code_font_family": "'Roboto Mono', 'Consolas', monospace", +} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +# html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ["_static"] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +# html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# html_additional_pages = {} + +# If false, no module index is generated. +# html_domain_indices = True + +# If false, no index is generated. +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' +# html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +# html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +# html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = "google-cloud-tpu-doc" + +# -- Options for warnings ------------------------------------------------------ + + +suppress_warnings = [ + # Temporarily suppress this to avoid "more than one target found for + # cross-reference" warning, which are intractable for us to avoid while in + # a mono-repo. + # See https://github.com/sphinx-doc/sphinx/blob + # /2a65ffeef5c107c19084fabdd706cdff3f52d93c/sphinx/domains/python.py#L843 + "ref.python" +] + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + # 'preamble': '', + # Latex figure (float) alignment + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ( + root_doc, + "google-cloud-tpu.tex", + u"google-cloud-tpu Documentation", + author, + "manual", + ) +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# latex_use_parts = False + +# If true, show page references after internal links. +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# latex_appendices = [] + +# If false, no module index is generated. +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ( + root_doc, + "google-cloud-tpu", + u"Google Cloud Tpu Documentation", + [author], + 1, + ) +] + +# If true, show URL addresses after external links. +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ( + root_doc, + "google-cloud-tpu", + u"google-cloud-tpu Documentation", + author, + "google-cloud-tpu", + "GAPIC library for Google Cloud Tpu API", + "APIs", + ) +] + +# Documents to append as an appendix to all manuals. +# texinfo_appendices = [] + +# If false, no module index is generated. +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# texinfo_no_detailmenu = False + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = { + "python": ("http://python.readthedocs.org/en/latest/", None), + "gax": ("https://gax-python.readthedocs.org/en/latest/", None), + "google-auth": ("https://google-auth.readthedocs.io/en/stable", None), + "google-gax": ("https://gax-python.readthedocs.io/en/latest/", None), + "google.api_core": ("https://googleapis.dev/python/google-api-core/latest/", None), + "grpc": ("https://grpc.io/grpc/python/", None), + "requests": ("http://requests.kennethreitz.org/en/stable/", None), + "proto": ("https://proto-plus-python.readthedocs.io/en/stable", None), + "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), +} + + +# Napoleon settings +napoleon_google_docstring = True +napoleon_numpy_docstring = True +napoleon_include_private_with_doc = False +napoleon_include_special_with_doc = True +napoleon_use_admonition_for_examples = False +napoleon_use_admonition_for_notes = False +napoleon_use_admonition_for_references = False +napoleon_use_ivar = False +napoleon_use_param = True +napoleon_use_rtype = True diff --git a/owl-bot-staging/v1/docs/index.rst b/owl-bot-staging/v1/docs/index.rst new file mode 100644 index 0000000..355bce3 --- /dev/null +++ b/owl-bot-staging/v1/docs/index.rst @@ -0,0 +1,7 @@ +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + tpu_v1/services + tpu_v1/types diff --git a/owl-bot-staging/v1/docs/tpu_v1/services.rst b/owl-bot-staging/v1/docs/tpu_v1/services.rst new file mode 100644 index 0000000..166671b --- /dev/null +++ b/owl-bot-staging/v1/docs/tpu_v1/services.rst @@ -0,0 +1,6 @@ +Services for Google Cloud Tpu v1 API +==================================== +.. toctree:: + :maxdepth: 2 + + tpu diff --git a/owl-bot-staging/v1/docs/tpu_v1/tpu.rst b/owl-bot-staging/v1/docs/tpu_v1/tpu.rst new file mode 100644 index 0000000..2a42bda --- /dev/null +++ b/owl-bot-staging/v1/docs/tpu_v1/tpu.rst @@ -0,0 +1,10 @@ +Tpu +--------------------- + +.. automodule:: google.cloud.tpu_v1.services.tpu + :members: + :inherited-members: + +.. automodule:: google.cloud.tpu_v1.services.tpu.pagers + :members: + :inherited-members: diff --git a/owl-bot-staging/v1/docs/tpu_v1/types.rst b/owl-bot-staging/v1/docs/tpu_v1/types.rst new file mode 100644 index 0000000..a79d42c --- /dev/null +++ b/owl-bot-staging/v1/docs/tpu_v1/types.rst @@ -0,0 +1,6 @@ +Types for Google Cloud Tpu v1 API +================================= + +.. automodule:: google.cloud.tpu_v1.types + :members: + :show-inheritance: diff --git a/owl-bot-staging/v1/google/cloud/tpu/__init__.py b/owl-bot-staging/v1/google/cloud/tpu/__init__.py new file mode 100644 index 0000000..2e445d4 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/tpu/__init__.py @@ -0,0 +1,69 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from google.cloud.tpu import gapic_version as package_version + +__version__ = package_version.__version__ + + +from google.cloud.tpu_v1.services.tpu.client import TpuClient +from google.cloud.tpu_v1.services.tpu.async_client import TpuAsyncClient + +from google.cloud.tpu_v1.types.cloud_tpu import AcceleratorType +from google.cloud.tpu_v1.types.cloud_tpu import CreateNodeRequest +from google.cloud.tpu_v1.types.cloud_tpu import DeleteNodeRequest +from google.cloud.tpu_v1.types.cloud_tpu import GetAcceleratorTypeRequest +from google.cloud.tpu_v1.types.cloud_tpu import GetNodeRequest +from google.cloud.tpu_v1.types.cloud_tpu import GetTensorFlowVersionRequest +from google.cloud.tpu_v1.types.cloud_tpu import ListAcceleratorTypesRequest +from google.cloud.tpu_v1.types.cloud_tpu import ListAcceleratorTypesResponse +from google.cloud.tpu_v1.types.cloud_tpu import ListNodesRequest +from google.cloud.tpu_v1.types.cloud_tpu import ListNodesResponse +from google.cloud.tpu_v1.types.cloud_tpu import ListTensorFlowVersionsRequest +from google.cloud.tpu_v1.types.cloud_tpu import ListTensorFlowVersionsResponse +from google.cloud.tpu_v1.types.cloud_tpu import NetworkEndpoint +from google.cloud.tpu_v1.types.cloud_tpu import Node +from google.cloud.tpu_v1.types.cloud_tpu import OperationMetadata +from google.cloud.tpu_v1.types.cloud_tpu import ReimageNodeRequest +from google.cloud.tpu_v1.types.cloud_tpu import SchedulingConfig +from google.cloud.tpu_v1.types.cloud_tpu import StartNodeRequest +from google.cloud.tpu_v1.types.cloud_tpu import StopNodeRequest +from google.cloud.tpu_v1.types.cloud_tpu import Symptom +from google.cloud.tpu_v1.types.cloud_tpu import TensorFlowVersion + +__all__ = ('TpuClient', + 'TpuAsyncClient', + 'AcceleratorType', + 'CreateNodeRequest', + 'DeleteNodeRequest', + 'GetAcceleratorTypeRequest', + 'GetNodeRequest', + 'GetTensorFlowVersionRequest', + 'ListAcceleratorTypesRequest', + 'ListAcceleratorTypesResponse', + 'ListNodesRequest', + 'ListNodesResponse', + 'ListTensorFlowVersionsRequest', + 'ListTensorFlowVersionsResponse', + 'NetworkEndpoint', + 'Node', + 'OperationMetadata', + 'ReimageNodeRequest', + 'SchedulingConfig', + 'StartNodeRequest', + 'StopNodeRequest', + 'Symptom', + 'TensorFlowVersion', +) diff --git a/owl-bot-staging/v1/google/cloud/tpu/gapic_version.py b/owl-bot-staging/v1/google/cloud/tpu/gapic_version.py new file mode 100644 index 0000000..405b1ce --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/tpu/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +__version__ = "0.1.0" # {x-release-please-version} diff --git a/owl-bot-staging/v1/google/cloud/tpu/py.typed b/owl-bot-staging/v1/google/cloud/tpu/py.typed new file mode 100644 index 0000000..e122051 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/tpu/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-tpu package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/tpu_v1/__init__.py b/owl-bot-staging/v1/google/cloud/tpu_v1/__init__.py new file mode 100644 index 0000000..5fdc783 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/tpu_v1/__init__.py @@ -0,0 +1,70 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from google.cloud.tpu_v1 import gapic_version as package_version + +__version__ = package_version.__version__ + + +from .services.tpu import TpuClient +from .services.tpu import TpuAsyncClient + +from .types.cloud_tpu import AcceleratorType +from .types.cloud_tpu import CreateNodeRequest +from .types.cloud_tpu import DeleteNodeRequest +from .types.cloud_tpu import GetAcceleratorTypeRequest +from .types.cloud_tpu import GetNodeRequest +from .types.cloud_tpu import GetTensorFlowVersionRequest +from .types.cloud_tpu import ListAcceleratorTypesRequest +from .types.cloud_tpu import ListAcceleratorTypesResponse +from .types.cloud_tpu import ListNodesRequest +from .types.cloud_tpu import ListNodesResponse +from .types.cloud_tpu import ListTensorFlowVersionsRequest +from .types.cloud_tpu import ListTensorFlowVersionsResponse +from .types.cloud_tpu import NetworkEndpoint +from .types.cloud_tpu import Node +from .types.cloud_tpu import OperationMetadata +from .types.cloud_tpu import ReimageNodeRequest +from .types.cloud_tpu import SchedulingConfig +from .types.cloud_tpu import StartNodeRequest +from .types.cloud_tpu import StopNodeRequest +from .types.cloud_tpu import Symptom +from .types.cloud_tpu import TensorFlowVersion + +__all__ = ( + 'TpuAsyncClient', +'AcceleratorType', +'CreateNodeRequest', +'DeleteNodeRequest', +'GetAcceleratorTypeRequest', +'GetNodeRequest', +'GetTensorFlowVersionRequest', +'ListAcceleratorTypesRequest', +'ListAcceleratorTypesResponse', +'ListNodesRequest', +'ListNodesResponse', +'ListTensorFlowVersionsRequest', +'ListTensorFlowVersionsResponse', +'NetworkEndpoint', +'Node', +'OperationMetadata', +'ReimageNodeRequest', +'SchedulingConfig', +'StartNodeRequest', +'StopNodeRequest', +'Symptom', +'TensorFlowVersion', +'TpuClient', +) diff --git a/owl-bot-staging/v1/google/cloud/tpu_v1/gapic_metadata.json b/owl-bot-staging/v1/google/cloud/tpu_v1/gapic_metadata.json new file mode 100644 index 0000000..0ac37b5 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/tpu_v1/gapic_metadata.json @@ -0,0 +1,133 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.cloud.tpu_v1", + "protoPackage": "google.cloud.tpu.v1", + "schema": "1.0", + "services": { + "Tpu": { + "clients": { + "grpc": { + "libraryClient": "TpuClient", + "rpcs": { + "CreateNode": { + "methods": [ + "create_node" + ] + }, + "DeleteNode": { + "methods": [ + "delete_node" + ] + }, + "GetAcceleratorType": { + "methods": [ + "get_accelerator_type" + ] + }, + "GetNode": { + "methods": [ + "get_node" + ] + }, + "GetTensorFlowVersion": { + "methods": [ + "get_tensor_flow_version" + ] + }, + "ListAcceleratorTypes": { + "methods": [ + "list_accelerator_types" + ] + }, + "ListNodes": { + "methods": [ + "list_nodes" + ] + }, + "ListTensorFlowVersions": { + "methods": [ + "list_tensor_flow_versions" + ] + }, + "ReimageNode": { + "methods": [ + "reimage_node" + ] + }, + "StartNode": { + "methods": [ + "start_node" + ] + }, + "StopNode": { + "methods": [ + "stop_node" + ] + } + } + }, + "grpc-async": { + "libraryClient": "TpuAsyncClient", + "rpcs": { + "CreateNode": { + "methods": [ + "create_node" + ] + }, + "DeleteNode": { + "methods": [ + "delete_node" + ] + }, + "GetAcceleratorType": { + "methods": [ + "get_accelerator_type" + ] + }, + "GetNode": { + "methods": [ + "get_node" + ] + }, + "GetTensorFlowVersion": { + "methods": [ + "get_tensor_flow_version" + ] + }, + "ListAcceleratorTypes": { + "methods": [ + "list_accelerator_types" + ] + }, + "ListNodes": { + "methods": [ + "list_nodes" + ] + }, + "ListTensorFlowVersions": { + "methods": [ + "list_tensor_flow_versions" + ] + }, + "ReimageNode": { + "methods": [ + "reimage_node" + ] + }, + "StartNode": { + "methods": [ + "start_node" + ] + }, + "StopNode": { + "methods": [ + "stop_node" + ] + } + } + } + } + } + } +} diff --git a/owl-bot-staging/v1/google/cloud/tpu_v1/gapic_version.py b/owl-bot-staging/v1/google/cloud/tpu_v1/gapic_version.py new file mode 100644 index 0000000..405b1ce --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/tpu_v1/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +__version__ = "0.1.0" # {x-release-please-version} diff --git a/owl-bot-staging/v1/google/cloud/tpu_v1/py.typed b/owl-bot-staging/v1/google/cloud/tpu_v1/py.typed new file mode 100644 index 0000000..e122051 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/tpu_v1/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-tpu package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/tpu_v1/services/__init__.py b/owl-bot-staging/v1/google/cloud/tpu_v1/services/__init__.py new file mode 100644 index 0000000..e8e1c38 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/tpu_v1/services/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/google/cloud/tpu_v1/services/tpu/__init__.py b/owl-bot-staging/v1/google/cloud/tpu_v1/services/tpu/__init__.py new file mode 100644 index 0000000..23e6818 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/tpu_v1/services/tpu/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .client import TpuClient +from .async_client import TpuAsyncClient + +__all__ = ( + 'TpuClient', + 'TpuAsyncClient', +) diff --git a/owl-bot-staging/v1/google/cloud/tpu_v1/services/tpu/async_client.py b/owl-bot-staging/v1/google/cloud/tpu_v1/services/tpu/async_client.py new file mode 100644 index 0000000..6435f4d --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/tpu_v1/services/tpu/async_client.py @@ -0,0 +1,1674 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import functools +import re +from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union + +from google.cloud.tpu_v1 import gapic_version as package_version + +from google.api_core.client_options import ClientOptions +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + +from google.api_core import operation # type: ignore +from google.api_core import operation_async # type: ignore +from google.cloud.location import locations_pb2 # type: ignore +from google.cloud.tpu_v1.services.tpu import pagers +from google.cloud.tpu_v1.types import cloud_tpu +from google.longrunning import operations_pb2 +from google.protobuf import timestamp_pb2 # type: ignore +from .transports.base import TpuTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import TpuGrpcAsyncIOTransport +from .client import TpuClient + + +class TpuAsyncClient: + """Manages TPU nodes and other resources + TPU API v1 + """ + + _client: TpuClient + + DEFAULT_ENDPOINT = TpuClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = TpuClient.DEFAULT_MTLS_ENDPOINT + + accelerator_type_path = staticmethod(TpuClient.accelerator_type_path) + parse_accelerator_type_path = staticmethod(TpuClient.parse_accelerator_type_path) + node_path = staticmethod(TpuClient.node_path) + parse_node_path = staticmethod(TpuClient.parse_node_path) + tensor_flow_version_path = staticmethod(TpuClient.tensor_flow_version_path) + parse_tensor_flow_version_path = staticmethod(TpuClient.parse_tensor_flow_version_path) + common_billing_account_path = staticmethod(TpuClient.common_billing_account_path) + parse_common_billing_account_path = staticmethod(TpuClient.parse_common_billing_account_path) + common_folder_path = staticmethod(TpuClient.common_folder_path) + parse_common_folder_path = staticmethod(TpuClient.parse_common_folder_path) + common_organization_path = staticmethod(TpuClient.common_organization_path) + parse_common_organization_path = staticmethod(TpuClient.parse_common_organization_path) + common_project_path = staticmethod(TpuClient.common_project_path) + parse_common_project_path = staticmethod(TpuClient.parse_common_project_path) + common_location_path = staticmethod(TpuClient.common_location_path) + parse_common_location_path = staticmethod(TpuClient.parse_common_location_path) + + @classmethod + def from_service_account_info(cls, info: dict, *args, **kwargs): + """Creates an instance of this client using the provided credentials + info. + + Args: + info (dict): The service account private key info. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + TpuAsyncClient: The constructed client. + """ + return TpuClient.from_service_account_info.__func__(TpuAsyncClient, info, *args, **kwargs) # type: ignore + + @classmethod + def from_service_account_file(cls, filename: str, *args, **kwargs): + """Creates an instance of this client using the provided credentials + file. + + Args: + filename (str): The path to the service account private key json + file. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + TpuAsyncClient: The constructed client. + """ + return TpuClient.from_service_account_file.__func__(TpuAsyncClient, filename, *args, **kwargs) # type: ignore + + from_service_account_json = from_service_account_file + + @classmethod + def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[ClientOptions] = None): + """Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variable is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + return TpuClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore + + @property + def transport(self) -> TpuTransport: + """Returns the transport used by the client instance. + + Returns: + TpuTransport: The transport used by the client instance. + """ + return self._client.transport + + get_transport_class = functools.partial(type(TpuClient).get_transport_class, type(TpuClient)) + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Union[str, TpuTransport] = "grpc_asyncio", + client_options: Optional[ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the tpu client. + + Args: + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + transport (Union[str, ~.TpuTransport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (ClientOptions): Custom options for the client. It + won't take effect if a ``transport`` instance is provided. + (1) The ``api_endpoint`` property can be used to override the + default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT + environment variable can also be used to override the endpoint: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto switch to the + default mTLS endpoint if client certificate is present, this is + the default value). However, the ``api_endpoint`` property takes + precedence if provided. + (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide client certificate for mutual TLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + """ + self._client = TpuClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + + ) + + async def list_nodes(self, + request: Optional[Union[cloud_tpu.ListNodesRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListNodesAsyncPager: + r"""Lists nodes. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v1 + + async def sample_list_nodes(): + # Create a client + client = tpu_v1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v1.ListNodesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_nodes(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v1.types.ListNodesRequest, dict]]): + The request object. Request for + [ListNodes][google.cloud.tpu.v1.Tpu.ListNodes]. + parent (:class:`str`): + Required. The parent resource name. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v1.services.tpu.pagers.ListNodesAsyncPager: + Response for + [ListNodes][google.cloud.tpu.v1.Tpu.ListNodes]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_tpu.ListNodesRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_nodes, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListNodesAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_node(self, + request: Optional[Union[cloud_tpu.GetNodeRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_tpu.Node: + r"""Gets the details of a node. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v1 + + async def sample_get_node(): + # Create a client + client = tpu_v1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v1.GetNodeRequest( + name="name_value", + ) + + # Make the request + response = await client.get_node(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v1.types.GetNodeRequest, dict]]): + The request object. Request for [GetNode][google.cloud.tpu.v1.Tpu.GetNode]. + name (:class:`str`): + Required. The resource name. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v1.types.Node: + A TPU instance. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_tpu.GetNodeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.get_node, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def create_node(self, + request: Optional[Union[cloud_tpu.CreateNodeRequest, dict]] = None, + *, + parent: Optional[str] = None, + node: Optional[cloud_tpu.Node] = None, + node_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Creates a node. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v1 + + async def sample_create_node(): + # Create a client + client = tpu_v1.TpuAsyncClient() + + # Initialize request argument(s) + node = tpu_v1.Node() + node.accelerator_type = "accelerator_type_value" + node.tensorflow_version = "tensorflow_version_value" + + request = tpu_v1.CreateNodeRequest( + parent="parent_value", + node=node, + ) + + # Make the request + operation = client.create_node(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v1.types.CreateNodeRequest, dict]]): + The request object. Request for + [CreateNode][google.cloud.tpu.v1.Tpu.CreateNode]. + parent (:class:`str`): + Required. The parent resource name. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + node (:class:`google.cloud.tpu_v1.types.Node`): + Required. The node. + This corresponds to the ``node`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + node_id (:class:`str`): + The unqualified resource name. + This corresponds to the ``node_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.tpu_v1.types.Node` A TPU instance. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, node, node_id]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_tpu.CreateNodeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if node is not None: + request.node = node + if node_id is not None: + request.node_id = node_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.create_node, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_tpu.Node, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + async def delete_node(self, + request: Optional[Union[cloud_tpu.DeleteNodeRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Deletes a node. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v1 + + async def sample_delete_node(): + # Create a client + client = tpu_v1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v1.DeleteNodeRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_node(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v1.types.DeleteNodeRequest, dict]]): + The request object. Request for + [DeleteNode][google.cloud.tpu.v1.Tpu.DeleteNode]. + name (:class:`str`): + Required. The resource name. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.tpu_v1.types.Node` A TPU instance. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_tpu.DeleteNodeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.delete_node, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_tpu.Node, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + async def reimage_node(self, + request: Optional[Union[cloud_tpu.ReimageNodeRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Reimages a node's OS. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v1 + + async def sample_reimage_node(): + # Create a client + client = tpu_v1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v1.ReimageNodeRequest( + ) + + # Make the request + operation = client.reimage_node(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v1.types.ReimageNodeRequest, dict]]): + The request object. Request for + [ReimageNode][google.cloud.tpu.v1.Tpu.ReimageNode]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.tpu_v1.types.Node` A TPU instance. + + """ + # Create or coerce a protobuf request object. + request = cloud_tpu.ReimageNodeRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.reimage_node, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_tpu.Node, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + async def stop_node(self, + request: Optional[Union[cloud_tpu.StopNodeRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Stops a node, this operation is only available with + single TPU nodes. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v1 + + async def sample_stop_node(): + # Create a client + client = tpu_v1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v1.StopNodeRequest( + ) + + # Make the request + operation = client.stop_node(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v1.types.StopNodeRequest, dict]]): + The request object. Request for + [StopNode][google.cloud.tpu.v1.Tpu.StopNode]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.tpu_v1.types.Node` A TPU instance. + + """ + # Create or coerce a protobuf request object. + request = cloud_tpu.StopNodeRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.stop_node, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_tpu.Node, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + async def start_node(self, + request: Optional[Union[cloud_tpu.StartNodeRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Starts a node. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v1 + + async def sample_start_node(): + # Create a client + client = tpu_v1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v1.StartNodeRequest( + ) + + # Make the request + operation = client.start_node(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v1.types.StartNodeRequest, dict]]): + The request object. Request for + [StartNode][google.cloud.tpu.v1.Tpu.StartNode]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.tpu_v1.types.Node` A TPU instance. + + """ + # Create or coerce a protobuf request object. + request = cloud_tpu.StartNodeRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.start_node, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_tpu.Node, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + async def list_tensor_flow_versions(self, + request: Optional[Union[cloud_tpu.ListTensorFlowVersionsRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListTensorFlowVersionsAsyncPager: + r"""List TensorFlow versions supported by this API. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v1 + + async def sample_list_tensor_flow_versions(): + # Create a client + client = tpu_v1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v1.ListTensorFlowVersionsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_tensor_flow_versions(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v1.types.ListTensorFlowVersionsRequest, dict]]): + The request object. Request for + [ListTensorFlowVersions][google.cloud.tpu.v1.Tpu.ListTensorFlowVersions]. + parent (:class:`str`): + Required. The parent resource name. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v1.services.tpu.pagers.ListTensorFlowVersionsAsyncPager: + Response for + [ListTensorFlowVersions][google.cloud.tpu.v1.Tpu.ListTensorFlowVersions]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_tpu.ListTensorFlowVersionsRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_tensor_flow_versions, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListTensorFlowVersionsAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_tensor_flow_version(self, + request: Optional[Union[cloud_tpu.GetTensorFlowVersionRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_tpu.TensorFlowVersion: + r"""Gets TensorFlow Version. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v1 + + async def sample_get_tensor_flow_version(): + # Create a client + client = tpu_v1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v1.GetTensorFlowVersionRequest( + name="name_value", + ) + + # Make the request + response = await client.get_tensor_flow_version(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v1.types.GetTensorFlowVersionRequest, dict]]): + The request object. Request for + [GetTensorFlowVersion][google.cloud.tpu.v1.Tpu.GetTensorFlowVersion]. + name (:class:`str`): + Required. The resource name. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v1.types.TensorFlowVersion: + A tensorflow version that a Node can + be configured with. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_tpu.GetTensorFlowVersionRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.get_tensor_flow_version, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def list_accelerator_types(self, + request: Optional[Union[cloud_tpu.ListAcceleratorTypesRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListAcceleratorTypesAsyncPager: + r"""Lists accelerator types supported by this API. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v1 + + async def sample_list_accelerator_types(): + # Create a client + client = tpu_v1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v1.ListAcceleratorTypesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_accelerator_types(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v1.types.ListAcceleratorTypesRequest, dict]]): + The request object. Request for + [ListAcceleratorTypes][google.cloud.tpu.v1.Tpu.ListAcceleratorTypes]. + parent (:class:`str`): + Required. The parent resource name. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v1.services.tpu.pagers.ListAcceleratorTypesAsyncPager: + Response for + [ListAcceleratorTypes][google.cloud.tpu.v1.Tpu.ListAcceleratorTypes]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_tpu.ListAcceleratorTypesRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_accelerator_types, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListAcceleratorTypesAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_accelerator_type(self, + request: Optional[Union[cloud_tpu.GetAcceleratorTypeRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_tpu.AcceleratorType: + r"""Gets AcceleratorType. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v1 + + async def sample_get_accelerator_type(): + # Create a client + client = tpu_v1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v1.GetAcceleratorTypeRequest( + name="name_value", + ) + + # Make the request + response = await client.get_accelerator_type(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v1.types.GetAcceleratorTypeRequest, dict]]): + The request object. Request for + [GetAcceleratorType][google.cloud.tpu.v1.Tpu.GetAcceleratorType]. + name (:class:`str`): + Required. The resource name. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v1.types.AcceleratorType: + A accelerator type that a Node can be + configured with. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_tpu.GetAcceleratorTypeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.get_accelerator_type, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def list_operations( + self, + request: Optional[operations_pb2.ListOperationsRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.ListOperationsResponse: + r"""Lists operations that match the specified filter in the request. + + Args: + request (:class:`~.operations_pb2.ListOperationsRequest`): + The request object. Request message for + `ListOperations` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.ListOperationsResponse: + Response message for ``ListOperations`` method. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.ListOperationsRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.list_operations, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + response = await rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + async def get_operation( + self, + request: Optional[operations_pb2.GetOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.Operation: + r"""Gets the latest state of a long-running operation. + + Args: + request (:class:`~.operations_pb2.GetOperationRequest`): + The request object. Request message for + `GetOperation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.Operation: + An ``Operation`` object. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.GetOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.get_operation, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + response = await rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + async def delete_operation( + self, + request: Optional[operations_pb2.DeleteOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes a long-running operation. + + This method indicates that the client is no longer interested + in the operation result. It does not cancel the operation. + If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + + Args: + request (:class:`~.operations_pb2.DeleteOperationRequest`): + The request object. Request message for + `DeleteOperation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + None + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.DeleteOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.delete_operation, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + async def cancel_operation( + self, + request: Optional[operations_pb2.CancelOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Starts asynchronous cancellation on a long-running operation. + + The server makes a best effort to cancel the operation, but success + is not guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + + Args: + request (:class:`~.operations_pb2.CancelOperationRequest`): + The request object. Request message for + `CancelOperation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + None + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.CancelOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.cancel_operation, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + async def get_location( + self, + request: Optional[locations_pb2.GetLocationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> locations_pb2.Location: + r"""Gets information about a location. + + Args: + request (:class:`~.location_pb2.GetLocationRequest`): + The request object. Request message for + `GetLocation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.location_pb2.Location: + Location object. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = locations_pb2.GetLocationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.get_location, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + response = await rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + async def list_locations( + self, + request: Optional[locations_pb2.ListLocationsRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> locations_pb2.ListLocationsResponse: + r"""Lists information about the supported locations for this service. + + Args: + request (:class:`~.location_pb2.ListLocationsRequest`): + The request object. Request message for + `ListLocations` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.location_pb2.ListLocationsResponse: + Response message for ``ListLocations`` method. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = locations_pb2.ListLocationsRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.list_locations, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + response = await rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + async def __aenter__(self): + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__all__ = ( + "TpuAsyncClient", +) diff --git a/owl-bot-staging/v1/google/cloud/tpu_v1/services/tpu/client.py b/owl-bot-staging/v1/google/cloud/tpu_v1/services/tpu/client.py new file mode 100644 index 0000000..8d7a4ee --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/tpu_v1/services/tpu/client.py @@ -0,0 +1,1892 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import os +import re +from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast + +from google.cloud.tpu_v1 import gapic_version as package_version + +from google.api_core import client_options as client_options_lib +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.oauth2 import service_account # type: ignore + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + +from google.api_core import operation # type: ignore +from google.api_core import operation_async # type: ignore +from google.cloud.location import locations_pb2 # type: ignore +from google.cloud.tpu_v1.services.tpu import pagers +from google.cloud.tpu_v1.types import cloud_tpu +from google.longrunning import operations_pb2 +from google.protobuf import timestamp_pb2 # type: ignore +from .transports.base import TpuTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import TpuGrpcTransport +from .transports.grpc_asyncio import TpuGrpcAsyncIOTransport + + +class TpuClientMeta(type): + """Metaclass for the Tpu client. + + This provides class-level methods for building and retrieving + support objects (e.g. transport) without polluting the client instance + objects. + """ + _transport_registry = OrderedDict() # type: Dict[str, Type[TpuTransport]] + _transport_registry["grpc"] = TpuGrpcTransport + _transport_registry["grpc_asyncio"] = TpuGrpcAsyncIOTransport + + def get_transport_class(cls, + label: Optional[str] = None, + ) -> Type[TpuTransport]: + """Returns an appropriate transport class. + + Args: + label: The name of the desired transport. If none is + provided, then the first transport in the registry is used. + + Returns: + The transport class to use. + """ + # If a specific transport is requested, return that one. + if label: + return cls._transport_registry[label] + + # No transport is requested; return the default (that is, the first one + # in the dictionary). + return next(iter(cls._transport_registry.values())) + + +class TpuClient(metaclass=TpuClientMeta): + """Manages TPU nodes and other resources + TPU API v1 + """ + + @staticmethod + def _get_default_mtls_endpoint(api_endpoint): + """Converts api endpoint to mTLS endpoint. + + Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to + "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. + Args: + api_endpoint (Optional[str]): the api endpoint to convert. + Returns: + str: converted mTLS api endpoint. + """ + if not api_endpoint: + return api_endpoint + + mtls_endpoint_re = re.compile( + r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" + ) + + m = mtls_endpoint_re.match(api_endpoint) + name, mtls, sandbox, googledomain = m.groups() + if mtls or not googledomain: + return api_endpoint + + if sandbox: + return api_endpoint.replace( + "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" + ) + + return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") + + DEFAULT_ENDPOINT = "tpu.googleapis.com" + DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore + DEFAULT_ENDPOINT + ) + + @classmethod + def from_service_account_info(cls, info: dict, *args, **kwargs): + """Creates an instance of this client using the provided credentials + info. + + Args: + info (dict): The service account private key info. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + TpuClient: The constructed client. + """ + credentials = service_account.Credentials.from_service_account_info(info) + kwargs["credentials"] = credentials + return cls(*args, **kwargs) + + @classmethod + def from_service_account_file(cls, filename: str, *args, **kwargs): + """Creates an instance of this client using the provided credentials + file. + + Args: + filename (str): The path to the service account private key json + file. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + TpuClient: The constructed client. + """ + credentials = service_account.Credentials.from_service_account_file( + filename) + kwargs["credentials"] = credentials + return cls(*args, **kwargs) + + from_service_account_json = from_service_account_file + + @property + def transport(self) -> TpuTransport: + """Returns the transport used by the client instance. + + Returns: + TpuTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def accelerator_type_path(project: str,location: str,accelerator_type: str,) -> str: + """Returns a fully-qualified accelerator_type string.""" + return "projects/{project}/locations/{location}/acceleratorTypes/{accelerator_type}".format(project=project, location=location, accelerator_type=accelerator_type, ) + + @staticmethod + def parse_accelerator_type_path(path: str) -> Dict[str,str]: + """Parses a accelerator_type path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/acceleratorTypes/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def node_path(project: str,location: str,node: str,) -> str: + """Returns a fully-qualified node string.""" + return "projects/{project}/locations/{location}/nodes/{node}".format(project=project, location=location, node=node, ) + + @staticmethod + def parse_node_path(path: str) -> Dict[str,str]: + """Parses a node path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/nodes/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def tensor_flow_version_path(project: str,location: str,tensor_flow_version: str,) -> str: + """Returns a fully-qualified tensor_flow_version string.""" + return "projects/{project}/locations/{location}/tensorFlowVersions/{tensor_flow_version}".format(project=project, location=location, tensor_flow_version=tensor_flow_version, ) + + @staticmethod + def parse_tensor_flow_version_path(path: str) -> Dict[str,str]: + """Parses a tensor_flow_version path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/tensorFlowVersions/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_billing_account_path(billing_account: str, ) -> str: + """Returns a fully-qualified billing_account string.""" + return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + + @staticmethod + def parse_common_billing_account_path(path: str) -> Dict[str,str]: + """Parse a billing_account path into its component segments.""" + m = re.match(r"^billingAccounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_folder_path(folder: str, ) -> str: + """Returns a fully-qualified folder string.""" + return "folders/{folder}".format(folder=folder, ) + + @staticmethod + def parse_common_folder_path(path: str) -> Dict[str,str]: + """Parse a folder path into its component segments.""" + m = re.match(r"^folders/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_organization_path(organization: str, ) -> str: + """Returns a fully-qualified organization string.""" + return "organizations/{organization}".format(organization=organization, ) + + @staticmethod + def parse_common_organization_path(path: str) -> Dict[str,str]: + """Parse a organization path into its component segments.""" + m = re.match(r"^organizations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_project_path(project: str, ) -> str: + """Returns a fully-qualified project string.""" + return "projects/{project}".format(project=project, ) + + @staticmethod + def parse_common_project_path(path: str) -> Dict[str,str]: + """Parse a project path into its component segments.""" + m = re.match(r"^projects/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_location_path(project: str, location: str, ) -> str: + """Returns a fully-qualified location string.""" + return "projects/{project}/locations/{location}".format(project=project, location=location, ) + + @staticmethod + def parse_common_location_path(path: str) -> Dict[str,str]: + """Parse a location path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @classmethod + def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_options_lib.ClientOptions] = None): + """Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variable is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + if client_options is None: + client_options = client_options_lib.ClientOptions() + use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") + use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_client_cert not in ("true", "false"): + raise ValueError("Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`") + if use_mtls_endpoint not in ("auto", "never", "always"): + raise MutualTLSChannelError("Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`") + + # Figure out the client cert source to use. + client_cert_source = None + if use_client_cert == "true": + if client_options.client_cert_source: + client_cert_source = client_options.client_cert_source + elif mtls.has_default_client_cert_source(): + client_cert_source = mtls.default_client_cert_source() + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): + api_endpoint = cls.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = cls.DEFAULT_ENDPOINT + + return api_endpoint, client_cert_source + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[Union[str, TpuTransport]] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the tpu client. + + Args: + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + transport (Union[str, TpuTransport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): Custom options for the + client. It won't take effect if a ``transport`` instance is provided. + (1) The ``api_endpoint`` property can be used to override the + default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT + environment variable can also be used to override the endpoint: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto switch to the + default mTLS endpoint if client certificate is present, this is + the default value). However, the ``api_endpoint`` property takes + precedence if provided. + (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide client certificate for mutual TLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + """ + if isinstance(client_options, dict): + client_options = client_options_lib.from_dict(client_options) + if client_options is None: + client_options = client_options_lib.ClientOptions() + client_options = cast(client_options_lib.ClientOptions, client_options) + + api_endpoint, client_cert_source_func = self.get_mtls_endpoint_and_cert_source(client_options) + + api_key_value = getattr(client_options, "api_key", None) + if api_key_value and credentials: + raise ValueError("client_options.api_key and credentials are mutually exclusive") + + # Save or instantiate the transport. + # Ordinarily, we provide the transport, but allowing a custom transport + # instance provides an extensibility point for unusual situations. + if isinstance(transport, TpuTransport): + # transport is a TpuTransport instance. + if credentials or client_options.credentials_file or api_key_value: + raise ValueError("When providing a transport instance, " + "provide its credentials directly.") + if client_options.scopes: + raise ValueError( + "When providing a transport instance, provide its scopes " + "directly." + ) + self._transport = transport + else: + import google.auth._default # type: ignore + + if api_key_value and hasattr(google.auth._default, "get_api_key_credentials"): + credentials = google.auth._default.get_api_key_credentials(api_key_value) + + Transport = type(self).get_transport_class(transport) + self._transport = Transport( + credentials=credentials, + credentials_file=client_options.credentials_file, + host=api_endpoint, + scopes=client_options.scopes, + client_cert_source_for_mtls=client_cert_source_func, + quota_project_id=client_options.quota_project_id, + client_info=client_info, + always_use_jwt_access=True, + api_audience=client_options.api_audience, + ) + + def list_nodes(self, + request: Optional[Union[cloud_tpu.ListNodesRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListNodesPager: + r"""Lists nodes. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v1 + + def sample_list_nodes(): + # Create a client + client = tpu_v1.TpuClient() + + # Initialize request argument(s) + request = tpu_v1.ListNodesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_nodes(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.tpu_v1.types.ListNodesRequest, dict]): + The request object. Request for + [ListNodes][google.cloud.tpu.v1.Tpu.ListNodes]. + parent (str): + Required. The parent resource name. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v1.services.tpu.pagers.ListNodesPager: + Response for + [ListNodes][google.cloud.tpu.v1.Tpu.ListNodes]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.ListNodesRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.ListNodesRequest): + request = cloud_tpu.ListNodesRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_nodes] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListNodesPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_node(self, + request: Optional[Union[cloud_tpu.GetNodeRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_tpu.Node: + r"""Gets the details of a node. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v1 + + def sample_get_node(): + # Create a client + client = tpu_v1.TpuClient() + + # Initialize request argument(s) + request = tpu_v1.GetNodeRequest( + name="name_value", + ) + + # Make the request + response = client.get_node(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.tpu_v1.types.GetNodeRequest, dict]): + The request object. Request for [GetNode][google.cloud.tpu.v1.Tpu.GetNode]. + name (str): + Required. The resource name. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v1.types.Node: + A TPU instance. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.GetNodeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.GetNodeRequest): + request = cloud_tpu.GetNodeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_node] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def create_node(self, + request: Optional[Union[cloud_tpu.CreateNodeRequest, dict]] = None, + *, + parent: Optional[str] = None, + node: Optional[cloud_tpu.Node] = None, + node_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Creates a node. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v1 + + def sample_create_node(): + # Create a client + client = tpu_v1.TpuClient() + + # Initialize request argument(s) + node = tpu_v1.Node() + node.accelerator_type = "accelerator_type_value" + node.tensorflow_version = "tensorflow_version_value" + + request = tpu_v1.CreateNodeRequest( + parent="parent_value", + node=node, + ) + + # Make the request + operation = client.create_node(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.tpu_v1.types.CreateNodeRequest, dict]): + The request object. Request for + [CreateNode][google.cloud.tpu.v1.Tpu.CreateNode]. + parent (str): + Required. The parent resource name. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + node (google.cloud.tpu_v1.types.Node): + Required. The node. + This corresponds to the ``node`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + node_id (str): + The unqualified resource name. + This corresponds to the ``node_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.tpu_v1.types.Node` A TPU instance. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, node, node_id]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.CreateNodeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.CreateNodeRequest): + request = cloud_tpu.CreateNodeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if node is not None: + request.node = node + if node_id is not None: + request.node_id = node_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_node] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_tpu.Node, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + def delete_node(self, + request: Optional[Union[cloud_tpu.DeleteNodeRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Deletes a node. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v1 + + def sample_delete_node(): + # Create a client + client = tpu_v1.TpuClient() + + # Initialize request argument(s) + request = tpu_v1.DeleteNodeRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_node(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.tpu_v1.types.DeleteNodeRequest, dict]): + The request object. Request for + [DeleteNode][google.cloud.tpu.v1.Tpu.DeleteNode]. + name (str): + Required. The resource name. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.tpu_v1.types.Node` A TPU instance. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.DeleteNodeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.DeleteNodeRequest): + request = cloud_tpu.DeleteNodeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.delete_node] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_tpu.Node, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + def reimage_node(self, + request: Optional[Union[cloud_tpu.ReimageNodeRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Reimages a node's OS. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v1 + + def sample_reimage_node(): + # Create a client + client = tpu_v1.TpuClient() + + # Initialize request argument(s) + request = tpu_v1.ReimageNodeRequest( + ) + + # Make the request + operation = client.reimage_node(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.tpu_v1.types.ReimageNodeRequest, dict]): + The request object. Request for + [ReimageNode][google.cloud.tpu.v1.Tpu.ReimageNode]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.tpu_v1.types.Node` A TPU instance. + + """ + # Create or coerce a protobuf request object. + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.ReimageNodeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.ReimageNodeRequest): + request = cloud_tpu.ReimageNodeRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.reimage_node] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_tpu.Node, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + def stop_node(self, + request: Optional[Union[cloud_tpu.StopNodeRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Stops a node, this operation is only available with + single TPU nodes. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v1 + + def sample_stop_node(): + # Create a client + client = tpu_v1.TpuClient() + + # Initialize request argument(s) + request = tpu_v1.StopNodeRequest( + ) + + # Make the request + operation = client.stop_node(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.tpu_v1.types.StopNodeRequest, dict]): + The request object. Request for + [StopNode][google.cloud.tpu.v1.Tpu.StopNode]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.tpu_v1.types.Node` A TPU instance. + + """ + # Create or coerce a protobuf request object. + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.StopNodeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.StopNodeRequest): + request = cloud_tpu.StopNodeRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.stop_node] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_tpu.Node, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + def start_node(self, + request: Optional[Union[cloud_tpu.StartNodeRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Starts a node. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v1 + + def sample_start_node(): + # Create a client + client = tpu_v1.TpuClient() + + # Initialize request argument(s) + request = tpu_v1.StartNodeRequest( + ) + + # Make the request + operation = client.start_node(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.tpu_v1.types.StartNodeRequest, dict]): + The request object. Request for + [StartNode][google.cloud.tpu.v1.Tpu.StartNode]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.tpu_v1.types.Node` A TPU instance. + + """ + # Create or coerce a protobuf request object. + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.StartNodeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.StartNodeRequest): + request = cloud_tpu.StartNodeRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.start_node] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_tpu.Node, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + def list_tensor_flow_versions(self, + request: Optional[Union[cloud_tpu.ListTensorFlowVersionsRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListTensorFlowVersionsPager: + r"""List TensorFlow versions supported by this API. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v1 + + def sample_list_tensor_flow_versions(): + # Create a client + client = tpu_v1.TpuClient() + + # Initialize request argument(s) + request = tpu_v1.ListTensorFlowVersionsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_tensor_flow_versions(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.tpu_v1.types.ListTensorFlowVersionsRequest, dict]): + The request object. Request for + [ListTensorFlowVersions][google.cloud.tpu.v1.Tpu.ListTensorFlowVersions]. + parent (str): + Required. The parent resource name. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v1.services.tpu.pagers.ListTensorFlowVersionsPager: + Response for + [ListTensorFlowVersions][google.cloud.tpu.v1.Tpu.ListTensorFlowVersions]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.ListTensorFlowVersionsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.ListTensorFlowVersionsRequest): + request = cloud_tpu.ListTensorFlowVersionsRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_tensor_flow_versions] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListTensorFlowVersionsPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_tensor_flow_version(self, + request: Optional[Union[cloud_tpu.GetTensorFlowVersionRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_tpu.TensorFlowVersion: + r"""Gets TensorFlow Version. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v1 + + def sample_get_tensor_flow_version(): + # Create a client + client = tpu_v1.TpuClient() + + # Initialize request argument(s) + request = tpu_v1.GetTensorFlowVersionRequest( + name="name_value", + ) + + # Make the request + response = client.get_tensor_flow_version(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.tpu_v1.types.GetTensorFlowVersionRequest, dict]): + The request object. Request for + [GetTensorFlowVersion][google.cloud.tpu.v1.Tpu.GetTensorFlowVersion]. + name (str): + Required. The resource name. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v1.types.TensorFlowVersion: + A tensorflow version that a Node can + be configured with. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.GetTensorFlowVersionRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.GetTensorFlowVersionRequest): + request = cloud_tpu.GetTensorFlowVersionRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_tensor_flow_version] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def list_accelerator_types(self, + request: Optional[Union[cloud_tpu.ListAcceleratorTypesRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListAcceleratorTypesPager: + r"""Lists accelerator types supported by this API. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v1 + + def sample_list_accelerator_types(): + # Create a client + client = tpu_v1.TpuClient() + + # Initialize request argument(s) + request = tpu_v1.ListAcceleratorTypesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_accelerator_types(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.tpu_v1.types.ListAcceleratorTypesRequest, dict]): + The request object. Request for + [ListAcceleratorTypes][google.cloud.tpu.v1.Tpu.ListAcceleratorTypes]. + parent (str): + Required. The parent resource name. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v1.services.tpu.pagers.ListAcceleratorTypesPager: + Response for + [ListAcceleratorTypes][google.cloud.tpu.v1.Tpu.ListAcceleratorTypes]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.ListAcceleratorTypesRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.ListAcceleratorTypesRequest): + request = cloud_tpu.ListAcceleratorTypesRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_accelerator_types] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListAcceleratorTypesPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_accelerator_type(self, + request: Optional[Union[cloud_tpu.GetAcceleratorTypeRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_tpu.AcceleratorType: + r"""Gets AcceleratorType. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v1 + + def sample_get_accelerator_type(): + # Create a client + client = tpu_v1.TpuClient() + + # Initialize request argument(s) + request = tpu_v1.GetAcceleratorTypeRequest( + name="name_value", + ) + + # Make the request + response = client.get_accelerator_type(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.tpu_v1.types.GetAcceleratorTypeRequest, dict]): + The request object. Request for + [GetAcceleratorType][google.cloud.tpu.v1.Tpu.GetAcceleratorType]. + name (str): + Required. The resource name. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v1.types.AcceleratorType: + A accelerator type that a Node can be + configured with. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.GetAcceleratorTypeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.GetAcceleratorTypeRequest): + request = cloud_tpu.GetAcceleratorTypeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_accelerator_type] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def __enter__(self) -> "TpuClient": + return self + + def __exit__(self, type, value, traceback): + """Releases underlying transport's resources. + + .. warning:: + ONLY use as a context manager if the transport is NOT shared + with other clients! Exiting the with block will CLOSE the transport + and may cause errors in other clients! + """ + self.transport.close() + + def list_operations( + self, + request: Optional[operations_pb2.ListOperationsRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.ListOperationsResponse: + r"""Lists operations that match the specified filter in the request. + + Args: + request (:class:`~.operations_pb2.ListOperationsRequest`): + The request object. Request message for + `ListOperations` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.ListOperationsResponse: + Response message for ``ListOperations`` method. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.ListOperationsRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.list_operations, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + response = rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + def get_operation( + self, + request: Optional[operations_pb2.GetOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.Operation: + r"""Gets the latest state of a long-running operation. + + Args: + request (:class:`~.operations_pb2.GetOperationRequest`): + The request object. Request message for + `GetOperation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.Operation: + An ``Operation`` object. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.GetOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.get_operation, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + response = rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + def delete_operation( + self, + request: Optional[operations_pb2.DeleteOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes a long-running operation. + + This method indicates that the client is no longer interested + in the operation result. It does not cancel the operation. + If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + + Args: + request (:class:`~.operations_pb2.DeleteOperationRequest`): + The request object. Request message for + `DeleteOperation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + None + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.DeleteOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.delete_operation, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + def cancel_operation( + self, + request: Optional[operations_pb2.CancelOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Starts asynchronous cancellation on a long-running operation. + + The server makes a best effort to cancel the operation, but success + is not guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + + Args: + request (:class:`~.operations_pb2.CancelOperationRequest`): + The request object. Request message for + `CancelOperation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + None + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.CancelOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.cancel_operation, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + def get_location( + self, + request: Optional[locations_pb2.GetLocationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> locations_pb2.Location: + r"""Gets information about a location. + + Args: + request (:class:`~.location_pb2.GetLocationRequest`): + The request object. Request message for + `GetLocation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.location_pb2.Location: + Location object. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = locations_pb2.GetLocationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.get_location, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + response = rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + def list_locations( + self, + request: Optional[locations_pb2.ListLocationsRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> locations_pb2.ListLocationsResponse: + r"""Lists information about the supported locations for this service. + + Args: + request (:class:`~.location_pb2.ListLocationsRequest`): + The request object. Request message for + `ListLocations` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.location_pb2.ListLocationsResponse: + Response message for ``ListLocations`` method. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = locations_pb2.ListLocationsRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.list_locations, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + response = rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__all__ = ( + "TpuClient", +) diff --git a/owl-bot-staging/v1/google/cloud/tpu_v1/services/tpu/pagers.py b/owl-bot-staging/v1/google/cloud/tpu_v1/services/tpu/pagers.py new file mode 100644 index 0000000..6e5d0a6 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/tpu_v1/services/tpu/pagers.py @@ -0,0 +1,381 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from typing import Any, AsyncIterator, Awaitable, Callable, Sequence, Tuple, Optional, Iterator + +from google.cloud.tpu_v1.types import cloud_tpu + + +class ListNodesPager: + """A pager for iterating through ``list_nodes`` requests. + + This class thinly wraps an initial + :class:`google.cloud.tpu_v1.types.ListNodesResponse` object, and + provides an ``__iter__`` method to iterate through its + ``nodes`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListNodes`` requests and continue to iterate + through the ``nodes`` field on the + corresponding responses. + + All the usual :class:`google.cloud.tpu_v1.types.ListNodesResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., cloud_tpu.ListNodesResponse], + request: cloud_tpu.ListNodesRequest, + response: cloud_tpu.ListNodesResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.tpu_v1.types.ListNodesRequest): + The initial request object. + response (google.cloud.tpu_v1.types.ListNodesResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_tpu.ListNodesRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[cloud_tpu.ListNodesResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[cloud_tpu.Node]: + for page in self.pages: + yield from page.nodes + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListNodesAsyncPager: + """A pager for iterating through ``list_nodes`` requests. + + This class thinly wraps an initial + :class:`google.cloud.tpu_v1.types.ListNodesResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``nodes`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListNodes`` requests and continue to iterate + through the ``nodes`` field on the + corresponding responses. + + All the usual :class:`google.cloud.tpu_v1.types.ListNodesResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., Awaitable[cloud_tpu.ListNodesResponse]], + request: cloud_tpu.ListNodesRequest, + response: cloud_tpu.ListNodesResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.tpu_v1.types.ListNodesRequest): + The initial request object. + response (google.cloud.tpu_v1.types.ListNodesResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_tpu.ListNodesRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[cloud_tpu.ListNodesResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + def __aiter__(self) -> AsyncIterator[cloud_tpu.Node]: + async def async_generator(): + async for page in self.pages: + for response in page.nodes: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListTensorFlowVersionsPager: + """A pager for iterating through ``list_tensor_flow_versions`` requests. + + This class thinly wraps an initial + :class:`google.cloud.tpu_v1.types.ListTensorFlowVersionsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``tensorflow_versions`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListTensorFlowVersions`` requests and continue to iterate + through the ``tensorflow_versions`` field on the + corresponding responses. + + All the usual :class:`google.cloud.tpu_v1.types.ListTensorFlowVersionsResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., cloud_tpu.ListTensorFlowVersionsResponse], + request: cloud_tpu.ListTensorFlowVersionsRequest, + response: cloud_tpu.ListTensorFlowVersionsResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.tpu_v1.types.ListTensorFlowVersionsRequest): + The initial request object. + response (google.cloud.tpu_v1.types.ListTensorFlowVersionsResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_tpu.ListTensorFlowVersionsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[cloud_tpu.ListTensorFlowVersionsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[cloud_tpu.TensorFlowVersion]: + for page in self.pages: + yield from page.tensorflow_versions + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListTensorFlowVersionsAsyncPager: + """A pager for iterating through ``list_tensor_flow_versions`` requests. + + This class thinly wraps an initial + :class:`google.cloud.tpu_v1.types.ListTensorFlowVersionsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``tensorflow_versions`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListTensorFlowVersions`` requests and continue to iterate + through the ``tensorflow_versions`` field on the + corresponding responses. + + All the usual :class:`google.cloud.tpu_v1.types.ListTensorFlowVersionsResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., Awaitable[cloud_tpu.ListTensorFlowVersionsResponse]], + request: cloud_tpu.ListTensorFlowVersionsRequest, + response: cloud_tpu.ListTensorFlowVersionsResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.tpu_v1.types.ListTensorFlowVersionsRequest): + The initial request object. + response (google.cloud.tpu_v1.types.ListTensorFlowVersionsResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_tpu.ListTensorFlowVersionsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[cloud_tpu.ListTensorFlowVersionsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + def __aiter__(self) -> AsyncIterator[cloud_tpu.TensorFlowVersion]: + async def async_generator(): + async for page in self.pages: + for response in page.tensorflow_versions: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListAcceleratorTypesPager: + """A pager for iterating through ``list_accelerator_types`` requests. + + This class thinly wraps an initial + :class:`google.cloud.tpu_v1.types.ListAcceleratorTypesResponse` object, and + provides an ``__iter__`` method to iterate through its + ``accelerator_types`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListAcceleratorTypes`` requests and continue to iterate + through the ``accelerator_types`` field on the + corresponding responses. + + All the usual :class:`google.cloud.tpu_v1.types.ListAcceleratorTypesResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., cloud_tpu.ListAcceleratorTypesResponse], + request: cloud_tpu.ListAcceleratorTypesRequest, + response: cloud_tpu.ListAcceleratorTypesResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.tpu_v1.types.ListAcceleratorTypesRequest): + The initial request object. + response (google.cloud.tpu_v1.types.ListAcceleratorTypesResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_tpu.ListAcceleratorTypesRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[cloud_tpu.ListAcceleratorTypesResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[cloud_tpu.AcceleratorType]: + for page in self.pages: + yield from page.accelerator_types + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListAcceleratorTypesAsyncPager: + """A pager for iterating through ``list_accelerator_types`` requests. + + This class thinly wraps an initial + :class:`google.cloud.tpu_v1.types.ListAcceleratorTypesResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``accelerator_types`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListAcceleratorTypes`` requests and continue to iterate + through the ``accelerator_types`` field on the + corresponding responses. + + All the usual :class:`google.cloud.tpu_v1.types.ListAcceleratorTypesResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., Awaitable[cloud_tpu.ListAcceleratorTypesResponse]], + request: cloud_tpu.ListAcceleratorTypesRequest, + response: cloud_tpu.ListAcceleratorTypesResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.tpu_v1.types.ListAcceleratorTypesRequest): + The initial request object. + response (google.cloud.tpu_v1.types.ListAcceleratorTypesResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_tpu.ListAcceleratorTypesRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[cloud_tpu.ListAcceleratorTypesResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + def __aiter__(self) -> AsyncIterator[cloud_tpu.AcceleratorType]: + async def async_generator(): + async for page in self.pages: + for response in page.accelerator_types: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) diff --git a/owl-bot-staging/v1/google/cloud/tpu_v1/services/tpu/transports/__init__.py b/owl-bot-staging/v1/google/cloud/tpu_v1/services/tpu/transports/__init__.py new file mode 100644 index 0000000..2064034 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/tpu_v1/services/tpu/transports/__init__.py @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +from typing import Dict, Type + +from .base import TpuTransport +from .grpc import TpuGrpcTransport +from .grpc_asyncio import TpuGrpcAsyncIOTransport + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[TpuTransport]] +_transport_registry['grpc'] = TpuGrpcTransport +_transport_registry['grpc_asyncio'] = TpuGrpcAsyncIOTransport + +__all__ = ( + 'TpuTransport', + 'TpuGrpcTransport', + 'TpuGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/tpu_v1/services/tpu/transports/base.py b/owl-bot-staging/v1/google/cloud/tpu_v1/services/tpu/transports/base.py new file mode 100644 index 0000000..dc8ebc7 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/tpu_v1/services/tpu/transports/base.py @@ -0,0 +1,349 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import abc +from typing import Awaitable, Callable, Dict, Optional, Sequence, Union + +from google.cloud.tpu_v1 import gapic_version as package_version + +import google.auth # type: ignore +import google.api_core +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.api_core import operations_v1 +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.location import locations_pb2 # type: ignore +from google.cloud.tpu_v1.types import cloud_tpu +from google.longrunning import operations_pb2 +from google.longrunning import operations_pb2 # type: ignore + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +class TpuTransport(abc.ABC): + """Abstract transport class for Tpu.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/cloud-platform', + ) + + DEFAULT_HOST: str = 'tpu.googleapis.com' + def __init__( + self, *, + host: str = DEFAULT_HOST, + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + **kwargs, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A list of scopes. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + """ + + scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES} + + # Save the scopes. + self._scopes = scopes + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") + + if credentials_file is not None: + credentials, _ = google.auth.load_credentials_from_file( + credentials_file, + **scopes_kwargs, + quota_project_id=quota_project_id + ) + elif credentials is None: + credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) + # Don't apply audience if the credentials file passed from user. + if hasattr(credentials, "with_gdch_audience"): + credentials = credentials.with_gdch_audience(api_audience if api_audience else host) + + # If the credentials are service account credentials, then always try to use self signed JWT. + if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): + credentials = credentials.with_always_use_jwt_access(True) + + # Save the credentials. + self._credentials = credentials + + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.list_nodes: gapic_v1.method.wrap_method( + self.list_nodes, + default_timeout=None, + client_info=client_info, + ), + self.get_node: gapic_v1.method.wrap_method( + self.get_node, + default_timeout=None, + client_info=client_info, + ), + self.create_node: gapic_v1.method.wrap_method( + self.create_node, + default_timeout=None, + client_info=client_info, + ), + self.delete_node: gapic_v1.method.wrap_method( + self.delete_node, + default_timeout=None, + client_info=client_info, + ), + self.reimage_node: gapic_v1.method.wrap_method( + self.reimage_node, + default_timeout=None, + client_info=client_info, + ), + self.stop_node: gapic_v1.method.wrap_method( + self.stop_node, + default_timeout=None, + client_info=client_info, + ), + self.start_node: gapic_v1.method.wrap_method( + self.start_node, + default_timeout=None, + client_info=client_info, + ), + self.list_tensor_flow_versions: gapic_v1.method.wrap_method( + self.list_tensor_flow_versions, + default_timeout=None, + client_info=client_info, + ), + self.get_tensor_flow_version: gapic_v1.method.wrap_method( + self.get_tensor_flow_version, + default_timeout=None, + client_info=client_info, + ), + self.list_accelerator_types: gapic_v1.method.wrap_method( + self.list_accelerator_types, + default_timeout=None, + client_info=client_info, + ), + self.get_accelerator_type: gapic_v1.method.wrap_method( + self.get_accelerator_type, + default_timeout=None, + client_info=client_info, + ), + } + + def close(self): + """Closes resources associated with the transport. + + .. warning:: + Only call this method if the transport is NOT shared + with other clients - this may cause errors in other clients! + """ + raise NotImplementedError() + + @property + def operations_client(self): + """Return the client designed to process long-running operations.""" + raise NotImplementedError() + + @property + def list_nodes(self) -> Callable[ + [cloud_tpu.ListNodesRequest], + Union[ + cloud_tpu.ListNodesResponse, + Awaitable[cloud_tpu.ListNodesResponse] + ]]: + raise NotImplementedError() + + @property + def get_node(self) -> Callable[ + [cloud_tpu.GetNodeRequest], + Union[ + cloud_tpu.Node, + Awaitable[cloud_tpu.Node] + ]]: + raise NotImplementedError() + + @property + def create_node(self) -> Callable[ + [cloud_tpu.CreateNodeRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def delete_node(self) -> Callable[ + [cloud_tpu.DeleteNodeRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def reimage_node(self) -> Callable[ + [cloud_tpu.ReimageNodeRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def stop_node(self) -> Callable[ + [cloud_tpu.StopNodeRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def start_node(self) -> Callable[ + [cloud_tpu.StartNodeRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def list_tensor_flow_versions(self) -> Callable[ + [cloud_tpu.ListTensorFlowVersionsRequest], + Union[ + cloud_tpu.ListTensorFlowVersionsResponse, + Awaitable[cloud_tpu.ListTensorFlowVersionsResponse] + ]]: + raise NotImplementedError() + + @property + def get_tensor_flow_version(self) -> Callable[ + [cloud_tpu.GetTensorFlowVersionRequest], + Union[ + cloud_tpu.TensorFlowVersion, + Awaitable[cloud_tpu.TensorFlowVersion] + ]]: + raise NotImplementedError() + + @property + def list_accelerator_types(self) -> Callable[ + [cloud_tpu.ListAcceleratorTypesRequest], + Union[ + cloud_tpu.ListAcceleratorTypesResponse, + Awaitable[cloud_tpu.ListAcceleratorTypesResponse] + ]]: + raise NotImplementedError() + + @property + def get_accelerator_type(self) -> Callable[ + [cloud_tpu.GetAcceleratorTypeRequest], + Union[ + cloud_tpu.AcceleratorType, + Awaitable[cloud_tpu.AcceleratorType] + ]]: + raise NotImplementedError() + + @property + def list_operations( + self, + ) -> Callable[ + [operations_pb2.ListOperationsRequest], + Union[operations_pb2.ListOperationsResponse, Awaitable[operations_pb2.ListOperationsResponse]], + ]: + raise NotImplementedError() + + @property + def get_operation( + self, + ) -> Callable[ + [operations_pb2.GetOperationRequest], + Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]], + ]: + raise NotImplementedError() + + @property + def cancel_operation( + self, + ) -> Callable[ + [operations_pb2.CancelOperationRequest], + None, + ]: + raise NotImplementedError() + + @property + def delete_operation( + self, + ) -> Callable[ + [operations_pb2.DeleteOperationRequest], + None, + ]: + raise NotImplementedError() + + @property + def get_location(self, + ) -> Callable[ + [locations_pb2.GetLocationRequest], + Union[locations_pb2.Location, Awaitable[locations_pb2.Location]], + ]: + raise NotImplementedError() + + @property + def list_locations(self, + ) -> Callable[ + [locations_pb2.ListLocationsRequest], + Union[locations_pb2.ListLocationsResponse, Awaitable[locations_pb2.ListLocationsResponse]], + ]: + raise NotImplementedError() + + @property + def kind(self) -> str: + raise NotImplementedError() + + +__all__ = ( + 'TpuTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/tpu_v1/services/tpu/transports/grpc.py b/owl-bot-staging/v1/google/cloud/tpu_v1/services/tpu/transports/grpc.py new file mode 100644 index 0000000..d2b3fcc --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/tpu_v1/services/tpu/transports/grpc.py @@ -0,0 +1,655 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import grpc_helpers +from google.api_core import operations_v1 +from google.api_core import gapic_v1 +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore + +from google.cloud.location import locations_pb2 # type: ignore +from google.cloud.tpu_v1.types import cloud_tpu +from google.longrunning import operations_pb2 +from google.longrunning import operations_pb2 # type: ignore +from .base import TpuTransport, DEFAULT_CLIENT_INFO + + +class TpuGrpcTransport(TpuTransport): + """gRPC backend transport for Tpu. + + Manages TPU nodes and other resources + TPU API v1 + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + _stubs: Dict[str, Callable] + + def __init__(self, *, + host: str = 'tpu.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[grpc.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + channel (Optional[grpc.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + self._operations_client: Optional[operations_v1.OperationsClient] = None + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @classmethod + def create_channel(cls, + host: str = 'tpu.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> grpc.Channel: + """Create and return a gRPC channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + grpc.Channel: A gRPC channel object. + + Raises: + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service. + """ + return self._grpc_channel + + @property + def operations_client(self) -> operations_v1.OperationsClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Quick check: Only create a new client if we do not already have one. + if self._operations_client is None: + self._operations_client = operations_v1.OperationsClient( + self.grpc_channel + ) + + # Return the client from cache. + return self._operations_client + + @property + def list_nodes(self) -> Callable[ + [cloud_tpu.ListNodesRequest], + cloud_tpu.ListNodesResponse]: + r"""Return a callable for the list nodes method over gRPC. + + Lists nodes. + + Returns: + Callable[[~.ListNodesRequest], + ~.ListNodesResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_nodes' not in self._stubs: + self._stubs['list_nodes'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v1.Tpu/ListNodes', + request_serializer=cloud_tpu.ListNodesRequest.serialize, + response_deserializer=cloud_tpu.ListNodesResponse.deserialize, + ) + return self._stubs['list_nodes'] + + @property + def get_node(self) -> Callable[ + [cloud_tpu.GetNodeRequest], + cloud_tpu.Node]: + r"""Return a callable for the get node method over gRPC. + + Gets the details of a node. + + Returns: + Callable[[~.GetNodeRequest], + ~.Node]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_node' not in self._stubs: + self._stubs['get_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v1.Tpu/GetNode', + request_serializer=cloud_tpu.GetNodeRequest.serialize, + response_deserializer=cloud_tpu.Node.deserialize, + ) + return self._stubs['get_node'] + + @property + def create_node(self) -> Callable[ + [cloud_tpu.CreateNodeRequest], + operations_pb2.Operation]: + r"""Return a callable for the create node method over gRPC. + + Creates a node. + + Returns: + Callable[[~.CreateNodeRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'create_node' not in self._stubs: + self._stubs['create_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v1.Tpu/CreateNode', + request_serializer=cloud_tpu.CreateNodeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['create_node'] + + @property + def delete_node(self) -> Callable[ + [cloud_tpu.DeleteNodeRequest], + operations_pb2.Operation]: + r"""Return a callable for the delete node method over gRPC. + + Deletes a node. + + Returns: + Callable[[~.DeleteNodeRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_node' not in self._stubs: + self._stubs['delete_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v1.Tpu/DeleteNode', + request_serializer=cloud_tpu.DeleteNodeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['delete_node'] + + @property + def reimage_node(self) -> Callable[ + [cloud_tpu.ReimageNodeRequest], + operations_pb2.Operation]: + r"""Return a callable for the reimage node method over gRPC. + + Reimages a node's OS. + + Returns: + Callable[[~.ReimageNodeRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'reimage_node' not in self._stubs: + self._stubs['reimage_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v1.Tpu/ReimageNode', + request_serializer=cloud_tpu.ReimageNodeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['reimage_node'] + + @property + def stop_node(self) -> Callable[ + [cloud_tpu.StopNodeRequest], + operations_pb2.Operation]: + r"""Return a callable for the stop node method over gRPC. + + Stops a node, this operation is only available with + single TPU nodes. + + Returns: + Callable[[~.StopNodeRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'stop_node' not in self._stubs: + self._stubs['stop_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v1.Tpu/StopNode', + request_serializer=cloud_tpu.StopNodeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['stop_node'] + + @property + def start_node(self) -> Callable[ + [cloud_tpu.StartNodeRequest], + operations_pb2.Operation]: + r"""Return a callable for the start node method over gRPC. + + Starts a node. + + Returns: + Callable[[~.StartNodeRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'start_node' not in self._stubs: + self._stubs['start_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v1.Tpu/StartNode', + request_serializer=cloud_tpu.StartNodeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['start_node'] + + @property + def list_tensor_flow_versions(self) -> Callable[ + [cloud_tpu.ListTensorFlowVersionsRequest], + cloud_tpu.ListTensorFlowVersionsResponse]: + r"""Return a callable for the list tensor flow versions method over gRPC. + + List TensorFlow versions supported by this API. + + Returns: + Callable[[~.ListTensorFlowVersionsRequest], + ~.ListTensorFlowVersionsResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_tensor_flow_versions' not in self._stubs: + self._stubs['list_tensor_flow_versions'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v1.Tpu/ListTensorFlowVersions', + request_serializer=cloud_tpu.ListTensorFlowVersionsRequest.serialize, + response_deserializer=cloud_tpu.ListTensorFlowVersionsResponse.deserialize, + ) + return self._stubs['list_tensor_flow_versions'] + + @property + def get_tensor_flow_version(self) -> Callable[ + [cloud_tpu.GetTensorFlowVersionRequest], + cloud_tpu.TensorFlowVersion]: + r"""Return a callable for the get tensor flow version method over gRPC. + + Gets TensorFlow Version. + + Returns: + Callable[[~.GetTensorFlowVersionRequest], + ~.TensorFlowVersion]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_tensor_flow_version' not in self._stubs: + self._stubs['get_tensor_flow_version'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v1.Tpu/GetTensorFlowVersion', + request_serializer=cloud_tpu.GetTensorFlowVersionRequest.serialize, + response_deserializer=cloud_tpu.TensorFlowVersion.deserialize, + ) + return self._stubs['get_tensor_flow_version'] + + @property + def list_accelerator_types(self) -> Callable[ + [cloud_tpu.ListAcceleratorTypesRequest], + cloud_tpu.ListAcceleratorTypesResponse]: + r"""Return a callable for the list accelerator types method over gRPC. + + Lists accelerator types supported by this API. + + Returns: + Callable[[~.ListAcceleratorTypesRequest], + ~.ListAcceleratorTypesResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_accelerator_types' not in self._stubs: + self._stubs['list_accelerator_types'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v1.Tpu/ListAcceleratorTypes', + request_serializer=cloud_tpu.ListAcceleratorTypesRequest.serialize, + response_deserializer=cloud_tpu.ListAcceleratorTypesResponse.deserialize, + ) + return self._stubs['list_accelerator_types'] + + @property + def get_accelerator_type(self) -> Callable[ + [cloud_tpu.GetAcceleratorTypeRequest], + cloud_tpu.AcceleratorType]: + r"""Return a callable for the get accelerator type method over gRPC. + + Gets AcceleratorType. + + Returns: + Callable[[~.GetAcceleratorTypeRequest], + ~.AcceleratorType]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_accelerator_type' not in self._stubs: + self._stubs['get_accelerator_type'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v1.Tpu/GetAcceleratorType', + request_serializer=cloud_tpu.GetAcceleratorTypeRequest.serialize, + response_deserializer=cloud_tpu.AcceleratorType.deserialize, + ) + return self._stubs['get_accelerator_type'] + + def close(self): + self.grpc_channel.close() + + @property + def delete_operation( + self, + ) -> Callable[[operations_pb2.DeleteOperationRequest], None]: + r"""Return a callable for the delete_operation method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "delete_operation" not in self._stubs: + self._stubs["delete_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/DeleteOperation", + request_serializer=operations_pb2.DeleteOperationRequest.SerializeToString, + response_deserializer=None, + ) + return self._stubs["delete_operation"] + + @property + def cancel_operation( + self, + ) -> Callable[[operations_pb2.CancelOperationRequest], None]: + r"""Return a callable for the cancel_operation method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "cancel_operation" not in self._stubs: + self._stubs["cancel_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/CancelOperation", + request_serializer=operations_pb2.CancelOperationRequest.SerializeToString, + response_deserializer=None, + ) + return self._stubs["cancel_operation"] + + @property + def get_operation( + self, + ) -> Callable[[operations_pb2.GetOperationRequest], operations_pb2.Operation]: + r"""Return a callable for the get_operation method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_operation" not in self._stubs: + self._stubs["get_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/GetOperation", + request_serializer=operations_pb2.GetOperationRequest.SerializeToString, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["get_operation"] + + @property + def list_operations( + self, + ) -> Callable[[operations_pb2.ListOperationsRequest], operations_pb2.ListOperationsResponse]: + r"""Return a callable for the list_operations method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_operations" not in self._stubs: + self._stubs["list_operations"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/ListOperations", + request_serializer=operations_pb2.ListOperationsRequest.SerializeToString, + response_deserializer=operations_pb2.ListOperationsResponse.FromString, + ) + return self._stubs["list_operations"] + + @property + def list_locations( + self, + ) -> Callable[[locations_pb2.ListLocationsRequest], locations_pb2.ListLocationsResponse]: + r"""Return a callable for the list locations method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_locations" not in self._stubs: + self._stubs["list_locations"] = self.grpc_channel.unary_unary( + "/google.cloud.location.Locations/ListLocations", + request_serializer=locations_pb2.ListLocationsRequest.SerializeToString, + response_deserializer=locations_pb2.ListLocationsResponse.FromString, + ) + return self._stubs["list_locations"] + + @property + def get_location( + self, + ) -> Callable[[locations_pb2.GetLocationRequest], locations_pb2.Location]: + r"""Return a callable for the list locations method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_location" not in self._stubs: + self._stubs["get_location"] = self.grpc_channel.unary_unary( + "/google.cloud.location.Locations/GetLocation", + request_serializer=locations_pb2.GetLocationRequest.SerializeToString, + response_deserializer=locations_pb2.Location.FromString, + ) + return self._stubs["get_location"] + + @property + def kind(self) -> str: + return "grpc" + + +__all__ = ( + 'TpuGrpcTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/tpu_v1/services/tpu/transports/grpc_asyncio.py b/owl-bot-staging/v1/google/cloud/tpu_v1/services/tpu/transports/grpc_asyncio.py new file mode 100644 index 0000000..852cab8 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/tpu_v1/services/tpu/transports/grpc_asyncio.py @@ -0,0 +1,654 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers_async +from google.api_core import operations_v1 +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore +from grpc.experimental import aio # type: ignore + +from google.cloud.location import locations_pb2 # type: ignore +from google.cloud.tpu_v1.types import cloud_tpu +from google.longrunning import operations_pb2 +from google.longrunning import operations_pb2 # type: ignore +from .base import TpuTransport, DEFAULT_CLIENT_INFO +from .grpc import TpuGrpcTransport + + +class TpuGrpcAsyncIOTransport(TpuTransport): + """gRPC AsyncIO backend transport for Tpu. + + Manages TPU nodes and other resources + TPU API v1 + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + + _grpc_channel: aio.Channel + _stubs: Dict[str, Callable] = {} + + @classmethod + def create_channel(cls, + host: str = 'tpu.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> aio.Channel: + """Create and return a gRPC AsyncIO channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + aio.Channel: A gRPC AsyncIO channel object. + """ + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + def __init__(self, *, + host: str = 'tpu.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[aio.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + channel (Optional[aio.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + self._operations_client: Optional[operations_v1.OperationsAsyncClient] = None + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @property + def grpc_channel(self) -> aio.Channel: + """Create the channel designed to connect to this service. + + This property caches on the instance; repeated calls return + the same channel. + """ + # Return the channel from cache. + return self._grpc_channel + + @property + def operations_client(self) -> operations_v1.OperationsAsyncClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Quick check: Only create a new client if we do not already have one. + if self._operations_client is None: + self._operations_client = operations_v1.OperationsAsyncClient( + self.grpc_channel + ) + + # Return the client from cache. + return self._operations_client + + @property + def list_nodes(self) -> Callable[ + [cloud_tpu.ListNodesRequest], + Awaitable[cloud_tpu.ListNodesResponse]]: + r"""Return a callable for the list nodes method over gRPC. + + Lists nodes. + + Returns: + Callable[[~.ListNodesRequest], + Awaitable[~.ListNodesResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_nodes' not in self._stubs: + self._stubs['list_nodes'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v1.Tpu/ListNodes', + request_serializer=cloud_tpu.ListNodesRequest.serialize, + response_deserializer=cloud_tpu.ListNodesResponse.deserialize, + ) + return self._stubs['list_nodes'] + + @property + def get_node(self) -> Callable[ + [cloud_tpu.GetNodeRequest], + Awaitable[cloud_tpu.Node]]: + r"""Return a callable for the get node method over gRPC. + + Gets the details of a node. + + Returns: + Callable[[~.GetNodeRequest], + Awaitable[~.Node]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_node' not in self._stubs: + self._stubs['get_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v1.Tpu/GetNode', + request_serializer=cloud_tpu.GetNodeRequest.serialize, + response_deserializer=cloud_tpu.Node.deserialize, + ) + return self._stubs['get_node'] + + @property + def create_node(self) -> Callable[ + [cloud_tpu.CreateNodeRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the create node method over gRPC. + + Creates a node. + + Returns: + Callable[[~.CreateNodeRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'create_node' not in self._stubs: + self._stubs['create_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v1.Tpu/CreateNode', + request_serializer=cloud_tpu.CreateNodeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['create_node'] + + @property + def delete_node(self) -> Callable[ + [cloud_tpu.DeleteNodeRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the delete node method over gRPC. + + Deletes a node. + + Returns: + Callable[[~.DeleteNodeRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_node' not in self._stubs: + self._stubs['delete_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v1.Tpu/DeleteNode', + request_serializer=cloud_tpu.DeleteNodeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['delete_node'] + + @property + def reimage_node(self) -> Callable[ + [cloud_tpu.ReimageNodeRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the reimage node method over gRPC. + + Reimages a node's OS. + + Returns: + Callable[[~.ReimageNodeRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'reimage_node' not in self._stubs: + self._stubs['reimage_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v1.Tpu/ReimageNode', + request_serializer=cloud_tpu.ReimageNodeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['reimage_node'] + + @property + def stop_node(self) -> Callable[ + [cloud_tpu.StopNodeRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the stop node method over gRPC. + + Stops a node, this operation is only available with + single TPU nodes. + + Returns: + Callable[[~.StopNodeRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'stop_node' not in self._stubs: + self._stubs['stop_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v1.Tpu/StopNode', + request_serializer=cloud_tpu.StopNodeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['stop_node'] + + @property + def start_node(self) -> Callable[ + [cloud_tpu.StartNodeRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the start node method over gRPC. + + Starts a node. + + Returns: + Callable[[~.StartNodeRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'start_node' not in self._stubs: + self._stubs['start_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v1.Tpu/StartNode', + request_serializer=cloud_tpu.StartNodeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['start_node'] + + @property + def list_tensor_flow_versions(self) -> Callable[ + [cloud_tpu.ListTensorFlowVersionsRequest], + Awaitable[cloud_tpu.ListTensorFlowVersionsResponse]]: + r"""Return a callable for the list tensor flow versions method over gRPC. + + List TensorFlow versions supported by this API. + + Returns: + Callable[[~.ListTensorFlowVersionsRequest], + Awaitable[~.ListTensorFlowVersionsResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_tensor_flow_versions' not in self._stubs: + self._stubs['list_tensor_flow_versions'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v1.Tpu/ListTensorFlowVersions', + request_serializer=cloud_tpu.ListTensorFlowVersionsRequest.serialize, + response_deserializer=cloud_tpu.ListTensorFlowVersionsResponse.deserialize, + ) + return self._stubs['list_tensor_flow_versions'] + + @property + def get_tensor_flow_version(self) -> Callable[ + [cloud_tpu.GetTensorFlowVersionRequest], + Awaitable[cloud_tpu.TensorFlowVersion]]: + r"""Return a callable for the get tensor flow version method over gRPC. + + Gets TensorFlow Version. + + Returns: + Callable[[~.GetTensorFlowVersionRequest], + Awaitable[~.TensorFlowVersion]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_tensor_flow_version' not in self._stubs: + self._stubs['get_tensor_flow_version'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v1.Tpu/GetTensorFlowVersion', + request_serializer=cloud_tpu.GetTensorFlowVersionRequest.serialize, + response_deserializer=cloud_tpu.TensorFlowVersion.deserialize, + ) + return self._stubs['get_tensor_flow_version'] + + @property + def list_accelerator_types(self) -> Callable[ + [cloud_tpu.ListAcceleratorTypesRequest], + Awaitable[cloud_tpu.ListAcceleratorTypesResponse]]: + r"""Return a callable for the list accelerator types method over gRPC. + + Lists accelerator types supported by this API. + + Returns: + Callable[[~.ListAcceleratorTypesRequest], + Awaitable[~.ListAcceleratorTypesResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_accelerator_types' not in self._stubs: + self._stubs['list_accelerator_types'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v1.Tpu/ListAcceleratorTypes', + request_serializer=cloud_tpu.ListAcceleratorTypesRequest.serialize, + response_deserializer=cloud_tpu.ListAcceleratorTypesResponse.deserialize, + ) + return self._stubs['list_accelerator_types'] + + @property + def get_accelerator_type(self) -> Callable[ + [cloud_tpu.GetAcceleratorTypeRequest], + Awaitable[cloud_tpu.AcceleratorType]]: + r"""Return a callable for the get accelerator type method over gRPC. + + Gets AcceleratorType. + + Returns: + Callable[[~.GetAcceleratorTypeRequest], + Awaitable[~.AcceleratorType]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_accelerator_type' not in self._stubs: + self._stubs['get_accelerator_type'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v1.Tpu/GetAcceleratorType', + request_serializer=cloud_tpu.GetAcceleratorTypeRequest.serialize, + response_deserializer=cloud_tpu.AcceleratorType.deserialize, + ) + return self._stubs['get_accelerator_type'] + + def close(self): + return self.grpc_channel.close() + + @property + def delete_operation( + self, + ) -> Callable[[operations_pb2.DeleteOperationRequest], None]: + r"""Return a callable for the delete_operation method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "delete_operation" not in self._stubs: + self._stubs["delete_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/DeleteOperation", + request_serializer=operations_pb2.DeleteOperationRequest.SerializeToString, + response_deserializer=None, + ) + return self._stubs["delete_operation"] + + @property + def cancel_operation( + self, + ) -> Callable[[operations_pb2.CancelOperationRequest], None]: + r"""Return a callable for the cancel_operation method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "cancel_operation" not in self._stubs: + self._stubs["cancel_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/CancelOperation", + request_serializer=operations_pb2.CancelOperationRequest.SerializeToString, + response_deserializer=None, + ) + return self._stubs["cancel_operation"] + + @property + def get_operation( + self, + ) -> Callable[[operations_pb2.GetOperationRequest], operations_pb2.Operation]: + r"""Return a callable for the get_operation method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_operation" not in self._stubs: + self._stubs["get_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/GetOperation", + request_serializer=operations_pb2.GetOperationRequest.SerializeToString, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["get_operation"] + + @property + def list_operations( + self, + ) -> Callable[[operations_pb2.ListOperationsRequest], operations_pb2.ListOperationsResponse]: + r"""Return a callable for the list_operations method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_operations" not in self._stubs: + self._stubs["list_operations"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/ListOperations", + request_serializer=operations_pb2.ListOperationsRequest.SerializeToString, + response_deserializer=operations_pb2.ListOperationsResponse.FromString, + ) + return self._stubs["list_operations"] + + @property + def list_locations( + self, + ) -> Callable[[locations_pb2.ListLocationsRequest], locations_pb2.ListLocationsResponse]: + r"""Return a callable for the list locations method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_locations" not in self._stubs: + self._stubs["list_locations"] = self.grpc_channel.unary_unary( + "/google.cloud.location.Locations/ListLocations", + request_serializer=locations_pb2.ListLocationsRequest.SerializeToString, + response_deserializer=locations_pb2.ListLocationsResponse.FromString, + ) + return self._stubs["list_locations"] + + @property + def get_location( + self, + ) -> Callable[[locations_pb2.GetLocationRequest], locations_pb2.Location]: + r"""Return a callable for the list locations method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_location" not in self._stubs: + self._stubs["get_location"] = self.grpc_channel.unary_unary( + "/google.cloud.location.Locations/GetLocation", + request_serializer=locations_pb2.GetLocationRequest.SerializeToString, + response_deserializer=locations_pb2.Location.FromString, + ) + return self._stubs["get_location"] + + +__all__ = ( + 'TpuGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/tpu_v1/types/__init__.py b/owl-bot-staging/v1/google/cloud/tpu_v1/types/__init__.py new file mode 100644 index 0000000..6013bf0 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/tpu_v1/types/__init__.py @@ -0,0 +1,62 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .cloud_tpu import ( + AcceleratorType, + CreateNodeRequest, + DeleteNodeRequest, + GetAcceleratorTypeRequest, + GetNodeRequest, + GetTensorFlowVersionRequest, + ListAcceleratorTypesRequest, + ListAcceleratorTypesResponse, + ListNodesRequest, + ListNodesResponse, + ListTensorFlowVersionsRequest, + ListTensorFlowVersionsResponse, + NetworkEndpoint, + Node, + OperationMetadata, + ReimageNodeRequest, + SchedulingConfig, + StartNodeRequest, + StopNodeRequest, + Symptom, + TensorFlowVersion, +) + +__all__ = ( + 'AcceleratorType', + 'CreateNodeRequest', + 'DeleteNodeRequest', + 'GetAcceleratorTypeRequest', + 'GetNodeRequest', + 'GetTensorFlowVersionRequest', + 'ListAcceleratorTypesRequest', + 'ListAcceleratorTypesResponse', + 'ListNodesRequest', + 'ListNodesResponse', + 'ListTensorFlowVersionsRequest', + 'ListTensorFlowVersionsResponse', + 'NetworkEndpoint', + 'Node', + 'OperationMetadata', + 'ReimageNodeRequest', + 'SchedulingConfig', + 'StartNodeRequest', + 'StopNodeRequest', + 'Symptom', + 'TensorFlowVersion', +) diff --git a/owl-bot-staging/v1/google/cloud/tpu_v1/types/cloud_tpu.py b/owl-bot-staging/v1/google/cloud/tpu_v1/types/cloud_tpu.py new file mode 100644 index 0000000..938aa1e --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/tpu_v1/types/cloud_tpu.py @@ -0,0 +1,861 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from __future__ import annotations + +from typing import MutableMapping, MutableSequence + +import proto # type: ignore + +from google.protobuf import timestamp_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.tpu.v1', + manifest={ + 'SchedulingConfig', + 'NetworkEndpoint', + 'Node', + 'ListNodesRequest', + 'ListNodesResponse', + 'GetNodeRequest', + 'CreateNodeRequest', + 'DeleteNodeRequest', + 'ReimageNodeRequest', + 'StopNodeRequest', + 'StartNodeRequest', + 'TensorFlowVersion', + 'GetTensorFlowVersionRequest', + 'ListTensorFlowVersionsRequest', + 'ListTensorFlowVersionsResponse', + 'AcceleratorType', + 'GetAcceleratorTypeRequest', + 'ListAcceleratorTypesRequest', + 'ListAcceleratorTypesResponse', + 'OperationMetadata', + 'Symptom', + }, +) + + +class SchedulingConfig(proto.Message): + r"""Sets the scheduling options for this node. + + Attributes: + preemptible (bool): + Defines whether the node is preemptible. + reserved (bool): + Whether the node is created under a + reservation. + """ + + preemptible: bool = proto.Field( + proto.BOOL, + number=1, + ) + reserved: bool = proto.Field( + proto.BOOL, + number=2, + ) + + +class NetworkEndpoint(proto.Message): + r"""A network endpoint over which a TPU worker can be reached. + + Attributes: + ip_address (str): + The IP address of this network endpoint. + port (int): + The port of this network endpoint. + """ + + ip_address: str = proto.Field( + proto.STRING, + number=1, + ) + port: int = proto.Field( + proto.INT32, + number=2, + ) + + +class Node(proto.Message): + r"""A TPU instance. + + Attributes: + name (str): + Output only. Immutable. The name of the TPU + description (str): + The user-supplied description of the TPU. + Maximum of 512 characters. + accelerator_type (str): + Required. The type of hardware accelerators + associated with this node. + ip_address (str): + Output only. DEPRECATED! Use network_endpoints instead. The + network address for the TPU Node as visible to Compute + Engine instances. + port (str): + Output only. DEPRECATED! Use network_endpoints instead. The + network port for the TPU Node as visible to Compute Engine + instances. + state (google.cloud.tpu_v1.types.Node.State): + Output only. The current state for the TPU + Node. + health_description (str): + Output only. If this field is populated, it + contains a description of why the TPU Node is + unhealthy. + tensorflow_version (str): + Required. The version of Tensorflow running + in the Node. + network (str): + The name of a network they wish to peer the + TPU node to. It must be a preexisting Compute + Engine network inside of the project on which + this API has been activated. If none is + provided, "default" will be used. + cidr_block (str): + The CIDR block that the TPU node will use + when selecting an IP address. This CIDR block + must be a /29 block; the Compute Engine networks + API forbids a smaller block, and using a larger + block would be wasteful (a node can only consume + one IP address). Errors will occur if the CIDR + block has already been used for a currently + existing TPU node, the CIDR block conflicts with + any subnetworks in the user's provided network, + or the provided network is peered with another + network that is using that CIDR block. + service_account (str): + Output only. The service account used to run + the tensor flow services within the node. To + share resources, including Google Cloud Storage + data, with the Tensorflow job running in the + Node, this account must have permissions to that + data. + create_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time when the node was + created. + scheduling_config (google.cloud.tpu_v1.types.SchedulingConfig): + The scheduling options for this node. + network_endpoints (MutableSequence[google.cloud.tpu_v1.types.NetworkEndpoint]): + Output only. The network endpoints where TPU + workers can be accessed and sent work. It is + recommended that Tensorflow clients of the node + reach out to the 0th entry in this map first. + health (google.cloud.tpu_v1.types.Node.Health): + The health status of the TPU node. + labels (MutableMapping[str, str]): + Resource labels to represent user-provided + metadata. + use_service_networking (bool): + Whether the VPC peering for the node is set up through + Service Networking API. The VPC Peering should be set up + before provisioning the node. If this field is set, + cidr_block field should not be specified. If the network, + that you want to peer the TPU Node to, is Shared VPC + networks, the node must be created with this this field + enabled. + api_version (google.cloud.tpu_v1.types.Node.ApiVersion): + Output only. The API version that created + this Node. + symptoms (MutableSequence[google.cloud.tpu_v1.types.Symptom]): + Output only. The Symptoms that have occurred + to the TPU Node. + """ + class State(proto.Enum): + r"""Represents the different states of a TPU node during its + lifecycle. + + Values: + STATE_UNSPECIFIED (0): + TPU node state is not known/set. + CREATING (1): + TPU node is being created. + READY (2): + TPU node has been created. + RESTARTING (3): + TPU node is restarting. + REIMAGING (4): + TPU node is undergoing reimaging. + DELETING (5): + TPU node is being deleted. + REPAIRING (6): + TPU node is being repaired and may be unusable. Details can + be found in the ``help_description`` field. + STOPPED (8): + TPU node is stopped. + STOPPING (9): + TPU node is currently stopping. + STARTING (10): + TPU node is currently starting. + PREEMPTED (11): + TPU node has been preempted. Only applies to + Preemptible TPU Nodes. + TERMINATED (12): + TPU node has been terminated due to + maintenance or has reached the end of its life + cycle (for preemptible nodes). + HIDING (13): + TPU node is currently hiding. + HIDDEN (14): + TPU node has been hidden. + UNHIDING (15): + TPU node is currently unhiding. + """ + STATE_UNSPECIFIED = 0 + CREATING = 1 + READY = 2 + RESTARTING = 3 + REIMAGING = 4 + DELETING = 5 + REPAIRING = 6 + STOPPED = 8 + STOPPING = 9 + STARTING = 10 + PREEMPTED = 11 + TERMINATED = 12 + HIDING = 13 + HIDDEN = 14 + UNHIDING = 15 + + class Health(proto.Enum): + r"""Health defines the status of a TPU node as reported by + Health Monitor. + + Values: + HEALTH_UNSPECIFIED (0): + Health status is unknown: not initialized or + failed to retrieve. + HEALTHY (1): + The resource is healthy. + DEPRECATED_UNHEALTHY (2): + The resource is unhealthy. + TIMEOUT (3): + The resource is unresponsive. + UNHEALTHY_TENSORFLOW (4): + The in-guest ML stack is unhealthy. + UNHEALTHY_MAINTENANCE (5): + The node is under maintenance/priority boost + caused rescheduling and will resume running once + rescheduled. + """ + HEALTH_UNSPECIFIED = 0 + HEALTHY = 1 + DEPRECATED_UNHEALTHY = 2 + TIMEOUT = 3 + UNHEALTHY_TENSORFLOW = 4 + UNHEALTHY_MAINTENANCE = 5 + + class ApiVersion(proto.Enum): + r"""TPU API Version. + + Values: + API_VERSION_UNSPECIFIED (0): + API version is unknown. + V1_ALPHA1 (1): + TPU API V1Alpha1 version. + V1 (2): + TPU API V1 version. + V2_ALPHA1 (3): + TPU API V2Alpha1 version. + """ + API_VERSION_UNSPECIFIED = 0 + V1_ALPHA1 = 1 + V1 = 2 + V2_ALPHA1 = 3 + + name: str = proto.Field( + proto.STRING, + number=1, + ) + description: str = proto.Field( + proto.STRING, + number=3, + ) + accelerator_type: str = proto.Field( + proto.STRING, + number=5, + ) + ip_address: str = proto.Field( + proto.STRING, + number=8, + ) + port: str = proto.Field( + proto.STRING, + number=14, + ) + state: State = proto.Field( + proto.ENUM, + number=9, + enum=State, + ) + health_description: str = proto.Field( + proto.STRING, + number=10, + ) + tensorflow_version: str = proto.Field( + proto.STRING, + number=11, + ) + network: str = proto.Field( + proto.STRING, + number=12, + ) + cidr_block: str = proto.Field( + proto.STRING, + number=13, + ) + service_account: str = proto.Field( + proto.STRING, + number=15, + ) + create_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=16, + message=timestamp_pb2.Timestamp, + ) + scheduling_config: 'SchedulingConfig' = proto.Field( + proto.MESSAGE, + number=17, + message='SchedulingConfig', + ) + network_endpoints: MutableSequence['NetworkEndpoint'] = proto.RepeatedField( + proto.MESSAGE, + number=21, + message='NetworkEndpoint', + ) + health: Health = proto.Field( + proto.ENUM, + number=22, + enum=Health, + ) + labels: MutableMapping[str, str] = proto.MapField( + proto.STRING, + proto.STRING, + number=24, + ) + use_service_networking: bool = proto.Field( + proto.BOOL, + number=27, + ) + api_version: ApiVersion = proto.Field( + proto.ENUM, + number=38, + enum=ApiVersion, + ) + symptoms: MutableSequence['Symptom'] = proto.RepeatedField( + proto.MESSAGE, + number=39, + message='Symptom', + ) + + +class ListNodesRequest(proto.Message): + r"""Request for [ListNodes][google.cloud.tpu.v1.Tpu.ListNodes]. + + Attributes: + parent (str): + Required. The parent resource name. + page_size (int): + The maximum number of items to return. + page_token (str): + The next_page_token value returned from a previous List + request, if any. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + page_size: int = proto.Field( + proto.INT32, + number=2, + ) + page_token: str = proto.Field( + proto.STRING, + number=3, + ) + + +class ListNodesResponse(proto.Message): + r"""Response for [ListNodes][google.cloud.tpu.v1.Tpu.ListNodes]. + + Attributes: + nodes (MutableSequence[google.cloud.tpu_v1.types.Node]): + The listed nodes. + next_page_token (str): + The next page token or empty if none. + unreachable (MutableSequence[str]): + Locations that could not be reached. + """ + + @property + def raw_page(self): + return self + + nodes: MutableSequence['Node'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='Node', + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + unreachable: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=3, + ) + + +class GetNodeRequest(proto.Message): + r"""Request for [GetNode][google.cloud.tpu.v1.Tpu.GetNode]. + + Attributes: + name (str): + Required. The resource name. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class CreateNodeRequest(proto.Message): + r"""Request for [CreateNode][google.cloud.tpu.v1.Tpu.CreateNode]. + + Attributes: + parent (str): + Required. The parent resource name. + node_id (str): + The unqualified resource name. + node (google.cloud.tpu_v1.types.Node): + Required. The node. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + node_id: str = proto.Field( + proto.STRING, + number=2, + ) + node: 'Node' = proto.Field( + proto.MESSAGE, + number=3, + message='Node', + ) + + +class DeleteNodeRequest(proto.Message): + r"""Request for [DeleteNode][google.cloud.tpu.v1.Tpu.DeleteNode]. + + Attributes: + name (str): + Required. The resource name. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class ReimageNodeRequest(proto.Message): + r"""Request for [ReimageNode][google.cloud.tpu.v1.Tpu.ReimageNode]. + + Attributes: + name (str): + The resource name. + tensorflow_version (str): + The version for reimage to create. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + tensorflow_version: str = proto.Field( + proto.STRING, + number=2, + ) + + +class StopNodeRequest(proto.Message): + r"""Request for [StopNode][google.cloud.tpu.v1.Tpu.StopNode]. + + Attributes: + name (str): + The resource name. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class StartNodeRequest(proto.Message): + r"""Request for [StartNode][google.cloud.tpu.v1.Tpu.StartNode]. + + Attributes: + name (str): + The resource name. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class TensorFlowVersion(proto.Message): + r"""A tensorflow version that a Node can be configured with. + + Attributes: + name (str): + The resource name. + version (str): + the tensorflow version. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + version: str = proto.Field( + proto.STRING, + number=2, + ) + + +class GetTensorFlowVersionRequest(proto.Message): + r"""Request for + [GetTensorFlowVersion][google.cloud.tpu.v1.Tpu.GetTensorFlowVersion]. + + Attributes: + name (str): + Required. The resource name. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class ListTensorFlowVersionsRequest(proto.Message): + r"""Request for + [ListTensorFlowVersions][google.cloud.tpu.v1.Tpu.ListTensorFlowVersions]. + + Attributes: + parent (str): + Required. The parent resource name. + page_size (int): + The maximum number of items to return. + page_token (str): + The next_page_token value returned from a previous List + request, if any. + filter (str): + List filter. + order_by (str): + Sort results. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + page_size: int = proto.Field( + proto.INT32, + number=2, + ) + page_token: str = proto.Field( + proto.STRING, + number=3, + ) + filter: str = proto.Field( + proto.STRING, + number=5, + ) + order_by: str = proto.Field( + proto.STRING, + number=6, + ) + + +class ListTensorFlowVersionsResponse(proto.Message): + r"""Response for + [ListTensorFlowVersions][google.cloud.tpu.v1.Tpu.ListTensorFlowVersions]. + + Attributes: + tensorflow_versions (MutableSequence[google.cloud.tpu_v1.types.TensorFlowVersion]): + The listed nodes. + next_page_token (str): + The next page token or empty if none. + unreachable (MutableSequence[str]): + Locations that could not be reached. + """ + + @property + def raw_page(self): + return self + + tensorflow_versions: MutableSequence['TensorFlowVersion'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='TensorFlowVersion', + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + unreachable: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=3, + ) + + +class AcceleratorType(proto.Message): + r"""A accelerator type that a Node can be configured with. + + Attributes: + name (str): + The resource name. + type_ (str): + the accelerator type. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + type_: str = proto.Field( + proto.STRING, + number=2, + ) + + +class GetAcceleratorTypeRequest(proto.Message): + r"""Request for + [GetAcceleratorType][google.cloud.tpu.v1.Tpu.GetAcceleratorType]. + + Attributes: + name (str): + Required. The resource name. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class ListAcceleratorTypesRequest(proto.Message): + r"""Request for + [ListAcceleratorTypes][google.cloud.tpu.v1.Tpu.ListAcceleratorTypes]. + + Attributes: + parent (str): + Required. The parent resource name. + page_size (int): + The maximum number of items to return. + page_token (str): + The next_page_token value returned from a previous List + request, if any. + filter (str): + List filter. + order_by (str): + Sort results. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + page_size: int = proto.Field( + proto.INT32, + number=2, + ) + page_token: str = proto.Field( + proto.STRING, + number=3, + ) + filter: str = proto.Field( + proto.STRING, + number=5, + ) + order_by: str = proto.Field( + proto.STRING, + number=6, + ) + + +class ListAcceleratorTypesResponse(proto.Message): + r"""Response for + [ListAcceleratorTypes][google.cloud.tpu.v1.Tpu.ListAcceleratorTypes]. + + Attributes: + accelerator_types (MutableSequence[google.cloud.tpu_v1.types.AcceleratorType]): + The listed nodes. + next_page_token (str): + The next page token or empty if none. + unreachable (MutableSequence[str]): + Locations that could not be reached. + """ + + @property + def raw_page(self): + return self + + accelerator_types: MutableSequence['AcceleratorType'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='AcceleratorType', + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + unreachable: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=3, + ) + + +class OperationMetadata(proto.Message): + r"""Metadata describing an [Operation][google.longrunning.Operation] + + Attributes: + create_time (google.protobuf.timestamp_pb2.Timestamp): + The time the operation was created. + end_time (google.protobuf.timestamp_pb2.Timestamp): + The time the operation finished running. + target (str): + Target of the operation - for example + projects/project-1/connectivityTests/test-1 + verb (str): + Name of the verb executed by the operation. + status_detail (str): + Human-readable status of the operation, if + any. + cancel_requested (bool): + Specifies if cancellation was requested for + the operation. + api_version (str): + API version. + """ + + create_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=1, + message=timestamp_pb2.Timestamp, + ) + end_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=2, + message=timestamp_pb2.Timestamp, + ) + target: str = proto.Field( + proto.STRING, + number=3, + ) + verb: str = proto.Field( + proto.STRING, + number=4, + ) + status_detail: str = proto.Field( + proto.STRING, + number=5, + ) + cancel_requested: bool = proto.Field( + proto.BOOL, + number=6, + ) + api_version: str = proto.Field( + proto.STRING, + number=7, + ) + + +class Symptom(proto.Message): + r"""A Symptom instance. + + Attributes: + create_time (google.protobuf.timestamp_pb2.Timestamp): + Timestamp when the Symptom is created. + symptom_type (google.cloud.tpu_v1.types.Symptom.SymptomType): + Type of the Symptom. + details (str): + Detailed information of the current Symptom. + worker_id (str): + A string used to uniquely distinguish a + worker within a TPU node. + """ + class SymptomType(proto.Enum): + r"""SymptomType represents the different types of Symptoms that a + TPU can be at. + + Values: + SYMPTOM_TYPE_UNSPECIFIED (0): + Unspecified symptom. + LOW_MEMORY (1): + TPU VM memory is low. + OUT_OF_MEMORY (2): + TPU runtime is out of memory. + EXECUTE_TIMED_OUT (3): + TPU runtime execution has timed out. + MESH_BUILD_FAIL (4): + TPU runtime fails to construct a mesh that + recognizes each TPU device's neighbors. + HBM_OUT_OF_MEMORY (5): + TPU HBM is out of memory. + PROJECT_ABUSE (6): + Abusive behaviors have been identified on the + current project. + """ + SYMPTOM_TYPE_UNSPECIFIED = 0 + LOW_MEMORY = 1 + OUT_OF_MEMORY = 2 + EXECUTE_TIMED_OUT = 3 + MESH_BUILD_FAIL = 4 + HBM_OUT_OF_MEMORY = 5 + PROJECT_ABUSE = 6 + + create_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=1, + message=timestamp_pb2.Timestamp, + ) + symptom_type: SymptomType = proto.Field( + proto.ENUM, + number=2, + enum=SymptomType, + ) + details: str = proto.Field( + proto.STRING, + number=3, + ) + worker_id: str = proto.Field( + proto.STRING, + number=4, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1/mypy.ini b/owl-bot-staging/v1/mypy.ini new file mode 100644 index 0000000..574c5ae --- /dev/null +++ b/owl-bot-staging/v1/mypy.ini @@ -0,0 +1,3 @@ +[mypy] +python_version = 3.7 +namespace_packages = True diff --git a/owl-bot-staging/v1/noxfile.py b/owl-bot-staging/v1/noxfile.py new file mode 100644 index 0000000..35cc346 --- /dev/null +++ b/owl-bot-staging/v1/noxfile.py @@ -0,0 +1,184 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +import pathlib +import shutil +import subprocess +import sys + + +import nox # type: ignore + +ALL_PYTHON = [ + "3.7", + "3.8", + "3.9", + "3.10", + "3.11", +] + +CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() + +LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" +PACKAGE_NAME = subprocess.check_output([sys.executable, "setup.py", "--name"], encoding="utf-8") + +BLACK_VERSION = "black==22.3.0" +BLACK_PATHS = ["docs", "google", "tests", "samples", "noxfile.py", "setup.py"] +DEFAULT_PYTHON_VERSION = "3.11" + +nox.sessions = [ + "unit", + "cover", + "mypy", + "check_lower_bounds" + # exclude update_lower_bounds from default + "docs", + "blacken", + "lint", + "lint_setup_py", +] + +@nox.session(python=ALL_PYTHON) +def unit(session): + """Run the unit test suite.""" + + session.install('coverage', 'pytest', 'pytest-cov', 'pytest-asyncio', 'asyncmock; python_version < "3.8"') + session.install('-e', '.') + + session.run( + 'py.test', + '--quiet', + '--cov=google/cloud/tpu_v1/', + '--cov=tests/', + '--cov-config=.coveragerc', + '--cov-report=term', + '--cov-report=html', + os.path.join('tests', 'unit', ''.join(session.posargs)) + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def cover(session): + """Run the final coverage report. + This outputs the coverage report aggregating coverage from the unit + test runs (not system test runs), and then erases coverage data. + """ + session.install("coverage", "pytest-cov") + session.run("coverage", "report", "--show-missing", "--fail-under=100") + + session.run("coverage", "erase") + + +@nox.session(python=ALL_PYTHON) +def mypy(session): + """Run the type checker.""" + session.install( + 'mypy', + 'types-requests', + 'types-protobuf' + ) + session.install('.') + session.run( + 'mypy', + '--explicit-package-bases', + 'google', + ) + + +@nox.session +def update_lower_bounds(session): + """Update lower bounds in constraints.txt to match setup.py""" + session.install('google-cloud-testutils') + session.install('.') + + session.run( + 'lower-bound-checker', + 'update', + '--package-name', + PACKAGE_NAME, + '--constraints-file', + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + + +@nox.session +def check_lower_bounds(session): + """Check lower bounds in setup.py are reflected in constraints file""" + session.install('google-cloud-testutils') + session.install('.') + + session.run( + 'lower-bound-checker', + 'check', + '--package-name', + PACKAGE_NAME, + '--constraints-file', + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def docs(session): + """Build the docs for this library.""" + + session.install("-e", ".") + session.install("sphinx==4.0.1", "alabaster", "recommonmark") + + shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) + session.run( + "sphinx-build", + "-W", # warnings as errors + "-T", # show full traceback on exception + "-N", # no colors + "-b", + "html", + "-d", + os.path.join("docs", "_build", "doctrees", ""), + os.path.join("docs", ""), + os.path.join("docs", "_build", "html", ""), + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint(session): + """Run linters. + + Returns a failure if the linters find linting errors or sufficiently + serious code quality issues. + """ + session.install("flake8", BLACK_VERSION) + session.run( + "black", + "--check", + *BLACK_PATHS, + ) + session.run("flake8", "google", "tests", "samples") + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def blacken(session): + """Run black. Format code to uniform standard.""" + session.install(BLACK_VERSION) + session.run( + "black", + *BLACK_PATHS, + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint_setup_py(session): + """Verify that setup.py is valid (including RST check).""" + session.install("docutils", "pygments") + session.run("python", "setup.py", "check", "--restructuredtext", "--strict") diff --git a/owl-bot-staging/v1/samples/generated_samples/snippet_metadata_google.cloud.tpu.v1.json b/owl-bot-staging/v1/samples/generated_samples/snippet_metadata_google.cloud.tpu.v1.json new file mode 100644 index 0000000..0a659a0 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/snippet_metadata_google.cloud.tpu.v1.json @@ -0,0 +1,1778 @@ +{ + "clientLibrary": { + "apis": [ + { + "id": "google.cloud.tpu.v1", + "version": "v1" + } + ], + "language": "PYTHON", + "name": "google-cloud-tpu", + "version": "0.1.0" + }, + "snippets": [ + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v1.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v1.TpuAsyncClient.create_node", + "method": { + "fullName": "google.cloud.tpu.v1.Tpu.CreateNode", + "service": { + "fullName": "google.cloud.tpu.v1.Tpu", + "shortName": "Tpu" + }, + "shortName": "CreateNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v1.types.CreateNodeRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "node", + "type": "google.cloud.tpu_v1.types.Node" + }, + { + "name": "node_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "create_node" + }, + "description": "Sample for CreateNode", + "file": "tpu_v1_generated_tpu_create_node_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v1_generated_Tpu_CreateNode_async", + "segments": [ + { + "end": 60, + "start": 27, + "type": "FULL" + }, + { + "end": 60, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 50, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 57, + "start": 51, + "type": "REQUEST_EXECUTION" + }, + { + "end": 61, + "start": 58, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v1_generated_tpu_create_node_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v1.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v1.TpuClient.create_node", + "method": { + "fullName": "google.cloud.tpu.v1.Tpu.CreateNode", + "service": { + "fullName": "google.cloud.tpu.v1.Tpu", + "shortName": "Tpu" + }, + "shortName": "CreateNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v1.types.CreateNodeRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "node", + "type": "google.cloud.tpu_v1.types.Node" + }, + { + "name": "node_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "create_node" + }, + "description": "Sample for CreateNode", + "file": "tpu_v1_generated_tpu_create_node_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v1_generated_Tpu_CreateNode_sync", + "segments": [ + { + "end": 60, + "start": 27, + "type": "FULL" + }, + { + "end": 60, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 50, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 57, + "start": 51, + "type": "REQUEST_EXECUTION" + }, + { + "end": 61, + "start": 58, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v1_generated_tpu_create_node_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v1.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v1.TpuAsyncClient.delete_node", + "method": { + "fullName": "google.cloud.tpu.v1.Tpu.DeleteNode", + "service": { + "fullName": "google.cloud.tpu.v1.Tpu", + "shortName": "Tpu" + }, + "shortName": "DeleteNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v1.types.DeleteNodeRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "delete_node" + }, + "description": "Sample for DeleteNode", + "file": "tpu_v1_generated_tpu_delete_node_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v1_generated_Tpu_DeleteNode_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v1_generated_tpu_delete_node_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v1.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v1.TpuClient.delete_node", + "method": { + "fullName": "google.cloud.tpu.v1.Tpu.DeleteNode", + "service": { + "fullName": "google.cloud.tpu.v1.Tpu", + "shortName": "Tpu" + }, + "shortName": "DeleteNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v1.types.DeleteNodeRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "delete_node" + }, + "description": "Sample for DeleteNode", + "file": "tpu_v1_generated_tpu_delete_node_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v1_generated_Tpu_DeleteNode_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v1_generated_tpu_delete_node_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v1.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v1.TpuAsyncClient.get_accelerator_type", + "method": { + "fullName": "google.cloud.tpu.v1.Tpu.GetAcceleratorType", + "service": { + "fullName": "google.cloud.tpu.v1.Tpu", + "shortName": "Tpu" + }, + "shortName": "GetAcceleratorType" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v1.types.GetAcceleratorTypeRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v1.types.AcceleratorType", + "shortName": "get_accelerator_type" + }, + "description": "Sample for GetAcceleratorType", + "file": "tpu_v1_generated_tpu_get_accelerator_type_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v1_generated_Tpu_GetAcceleratorType_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v1_generated_tpu_get_accelerator_type_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v1.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v1.TpuClient.get_accelerator_type", + "method": { + "fullName": "google.cloud.tpu.v1.Tpu.GetAcceleratorType", + "service": { + "fullName": "google.cloud.tpu.v1.Tpu", + "shortName": "Tpu" + }, + "shortName": "GetAcceleratorType" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v1.types.GetAcceleratorTypeRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v1.types.AcceleratorType", + "shortName": "get_accelerator_type" + }, + "description": "Sample for GetAcceleratorType", + "file": "tpu_v1_generated_tpu_get_accelerator_type_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v1_generated_Tpu_GetAcceleratorType_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v1_generated_tpu_get_accelerator_type_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v1.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v1.TpuAsyncClient.get_node", + "method": { + "fullName": "google.cloud.tpu.v1.Tpu.GetNode", + "service": { + "fullName": "google.cloud.tpu.v1.Tpu", + "shortName": "Tpu" + }, + "shortName": "GetNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v1.types.GetNodeRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v1.types.Node", + "shortName": "get_node" + }, + "description": "Sample for GetNode", + "file": "tpu_v1_generated_tpu_get_node_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v1_generated_Tpu_GetNode_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v1_generated_tpu_get_node_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v1.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v1.TpuClient.get_node", + "method": { + "fullName": "google.cloud.tpu.v1.Tpu.GetNode", + "service": { + "fullName": "google.cloud.tpu.v1.Tpu", + "shortName": "Tpu" + }, + "shortName": "GetNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v1.types.GetNodeRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v1.types.Node", + "shortName": "get_node" + }, + "description": "Sample for GetNode", + "file": "tpu_v1_generated_tpu_get_node_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v1_generated_Tpu_GetNode_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v1_generated_tpu_get_node_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v1.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v1.TpuAsyncClient.get_tensor_flow_version", + "method": { + "fullName": "google.cloud.tpu.v1.Tpu.GetTensorFlowVersion", + "service": { + "fullName": "google.cloud.tpu.v1.Tpu", + "shortName": "Tpu" + }, + "shortName": "GetTensorFlowVersion" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v1.types.GetTensorFlowVersionRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v1.types.TensorFlowVersion", + "shortName": "get_tensor_flow_version" + }, + "description": "Sample for GetTensorFlowVersion", + "file": "tpu_v1_generated_tpu_get_tensor_flow_version_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v1_generated_Tpu_GetTensorFlowVersion_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v1_generated_tpu_get_tensor_flow_version_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v1.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v1.TpuClient.get_tensor_flow_version", + "method": { + "fullName": "google.cloud.tpu.v1.Tpu.GetTensorFlowVersion", + "service": { + "fullName": "google.cloud.tpu.v1.Tpu", + "shortName": "Tpu" + }, + "shortName": "GetTensorFlowVersion" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v1.types.GetTensorFlowVersionRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v1.types.TensorFlowVersion", + "shortName": "get_tensor_flow_version" + }, + "description": "Sample for GetTensorFlowVersion", + "file": "tpu_v1_generated_tpu_get_tensor_flow_version_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v1_generated_Tpu_GetTensorFlowVersion_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v1_generated_tpu_get_tensor_flow_version_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v1.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v1.TpuAsyncClient.list_accelerator_types", + "method": { + "fullName": "google.cloud.tpu.v1.Tpu.ListAcceleratorTypes", + "service": { + "fullName": "google.cloud.tpu.v1.Tpu", + "shortName": "Tpu" + }, + "shortName": "ListAcceleratorTypes" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v1.types.ListAcceleratorTypesRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v1.services.tpu.pagers.ListAcceleratorTypesAsyncPager", + "shortName": "list_accelerator_types" + }, + "description": "Sample for ListAcceleratorTypes", + "file": "tpu_v1_generated_tpu_list_accelerator_types_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v1_generated_Tpu_ListAcceleratorTypes_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v1_generated_tpu_list_accelerator_types_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v1.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v1.TpuClient.list_accelerator_types", + "method": { + "fullName": "google.cloud.tpu.v1.Tpu.ListAcceleratorTypes", + "service": { + "fullName": "google.cloud.tpu.v1.Tpu", + "shortName": "Tpu" + }, + "shortName": "ListAcceleratorTypes" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v1.types.ListAcceleratorTypesRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v1.services.tpu.pagers.ListAcceleratorTypesPager", + "shortName": "list_accelerator_types" + }, + "description": "Sample for ListAcceleratorTypes", + "file": "tpu_v1_generated_tpu_list_accelerator_types_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v1_generated_Tpu_ListAcceleratorTypes_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v1_generated_tpu_list_accelerator_types_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v1.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v1.TpuAsyncClient.list_nodes", + "method": { + "fullName": "google.cloud.tpu.v1.Tpu.ListNodes", + "service": { + "fullName": "google.cloud.tpu.v1.Tpu", + "shortName": "Tpu" + }, + "shortName": "ListNodes" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v1.types.ListNodesRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v1.services.tpu.pagers.ListNodesAsyncPager", + "shortName": "list_nodes" + }, + "description": "Sample for ListNodes", + "file": "tpu_v1_generated_tpu_list_nodes_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v1_generated_Tpu_ListNodes_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v1_generated_tpu_list_nodes_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v1.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v1.TpuClient.list_nodes", + "method": { + "fullName": "google.cloud.tpu.v1.Tpu.ListNodes", + "service": { + "fullName": "google.cloud.tpu.v1.Tpu", + "shortName": "Tpu" + }, + "shortName": "ListNodes" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v1.types.ListNodesRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v1.services.tpu.pagers.ListNodesPager", + "shortName": "list_nodes" + }, + "description": "Sample for ListNodes", + "file": "tpu_v1_generated_tpu_list_nodes_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v1_generated_Tpu_ListNodes_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v1_generated_tpu_list_nodes_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v1.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v1.TpuAsyncClient.list_tensor_flow_versions", + "method": { + "fullName": "google.cloud.tpu.v1.Tpu.ListTensorFlowVersions", + "service": { + "fullName": "google.cloud.tpu.v1.Tpu", + "shortName": "Tpu" + }, + "shortName": "ListTensorFlowVersions" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v1.types.ListTensorFlowVersionsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v1.services.tpu.pagers.ListTensorFlowVersionsAsyncPager", + "shortName": "list_tensor_flow_versions" + }, + "description": "Sample for ListTensorFlowVersions", + "file": "tpu_v1_generated_tpu_list_tensor_flow_versions_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v1_generated_Tpu_ListTensorFlowVersions_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v1_generated_tpu_list_tensor_flow_versions_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v1.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v1.TpuClient.list_tensor_flow_versions", + "method": { + "fullName": "google.cloud.tpu.v1.Tpu.ListTensorFlowVersions", + "service": { + "fullName": "google.cloud.tpu.v1.Tpu", + "shortName": "Tpu" + }, + "shortName": "ListTensorFlowVersions" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v1.types.ListTensorFlowVersionsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v1.services.tpu.pagers.ListTensorFlowVersionsPager", + "shortName": "list_tensor_flow_versions" + }, + "description": "Sample for ListTensorFlowVersions", + "file": "tpu_v1_generated_tpu_list_tensor_flow_versions_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v1_generated_Tpu_ListTensorFlowVersions_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v1_generated_tpu_list_tensor_flow_versions_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v1.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v1.TpuAsyncClient.reimage_node", + "method": { + "fullName": "google.cloud.tpu.v1.Tpu.ReimageNode", + "service": { + "fullName": "google.cloud.tpu.v1.Tpu", + "shortName": "Tpu" + }, + "shortName": "ReimageNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v1.types.ReimageNodeRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "reimage_node" + }, + "description": "Sample for ReimageNode", + "file": "tpu_v1_generated_tpu_reimage_node_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v1_generated_Tpu_ReimageNode_async", + "segments": [ + { + "end": 54, + "start": 27, + "type": "FULL" + }, + { + "end": 54, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 51, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 55, + "start": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v1_generated_tpu_reimage_node_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v1.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v1.TpuClient.reimage_node", + "method": { + "fullName": "google.cloud.tpu.v1.Tpu.ReimageNode", + "service": { + "fullName": "google.cloud.tpu.v1.Tpu", + "shortName": "Tpu" + }, + "shortName": "ReimageNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v1.types.ReimageNodeRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "reimage_node" + }, + "description": "Sample for ReimageNode", + "file": "tpu_v1_generated_tpu_reimage_node_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v1_generated_Tpu_ReimageNode_sync", + "segments": [ + { + "end": 54, + "start": 27, + "type": "FULL" + }, + { + "end": 54, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 51, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 55, + "start": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v1_generated_tpu_reimage_node_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v1.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v1.TpuAsyncClient.start_node", + "method": { + "fullName": "google.cloud.tpu.v1.Tpu.StartNode", + "service": { + "fullName": "google.cloud.tpu.v1.Tpu", + "shortName": "Tpu" + }, + "shortName": "StartNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v1.types.StartNodeRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "start_node" + }, + "description": "Sample for StartNode", + "file": "tpu_v1_generated_tpu_start_node_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v1_generated_Tpu_StartNode_async", + "segments": [ + { + "end": 54, + "start": 27, + "type": "FULL" + }, + { + "end": 54, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 51, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 55, + "start": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v1_generated_tpu_start_node_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v1.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v1.TpuClient.start_node", + "method": { + "fullName": "google.cloud.tpu.v1.Tpu.StartNode", + "service": { + "fullName": "google.cloud.tpu.v1.Tpu", + "shortName": "Tpu" + }, + "shortName": "StartNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v1.types.StartNodeRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "start_node" + }, + "description": "Sample for StartNode", + "file": "tpu_v1_generated_tpu_start_node_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v1_generated_Tpu_StartNode_sync", + "segments": [ + { + "end": 54, + "start": 27, + "type": "FULL" + }, + { + "end": 54, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 51, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 55, + "start": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v1_generated_tpu_start_node_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v1.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v1.TpuAsyncClient.stop_node", + "method": { + "fullName": "google.cloud.tpu.v1.Tpu.StopNode", + "service": { + "fullName": "google.cloud.tpu.v1.Tpu", + "shortName": "Tpu" + }, + "shortName": "StopNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v1.types.StopNodeRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "stop_node" + }, + "description": "Sample for StopNode", + "file": "tpu_v1_generated_tpu_stop_node_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v1_generated_Tpu_StopNode_async", + "segments": [ + { + "end": 54, + "start": 27, + "type": "FULL" + }, + { + "end": 54, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 51, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 55, + "start": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v1_generated_tpu_stop_node_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v1.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v1.TpuClient.stop_node", + "method": { + "fullName": "google.cloud.tpu.v1.Tpu.StopNode", + "service": { + "fullName": "google.cloud.tpu.v1.Tpu", + "shortName": "Tpu" + }, + "shortName": "StopNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v1.types.StopNodeRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "stop_node" + }, + "description": "Sample for StopNode", + "file": "tpu_v1_generated_tpu_stop_node_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v1_generated_Tpu_StopNode_sync", + "segments": [ + { + "end": 54, + "start": 27, + "type": "FULL" + }, + { + "end": 54, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 51, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 55, + "start": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v1_generated_tpu_stop_node_sync.py" + } + ] +} diff --git a/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_create_node_async.py b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_create_node_async.py new file mode 100644 index 0000000..cf8cd81 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_create_node_async.py @@ -0,0 +1,61 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreateNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v1_generated_Tpu_CreateNode_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v1 + + +async def sample_create_node(): + # Create a client + client = tpu_v1.TpuAsyncClient() + + # Initialize request argument(s) + node = tpu_v1.Node() + node.accelerator_type = "accelerator_type_value" + node.tensorflow_version = "tensorflow_version_value" + + request = tpu_v1.CreateNodeRequest( + parent="parent_value", + node=node, + ) + + # Make the request + operation = client.create_node(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END tpu_v1_generated_Tpu_CreateNode_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_create_node_sync.py b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_create_node_sync.py new file mode 100644 index 0000000..bde5283 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_create_node_sync.py @@ -0,0 +1,61 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreateNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v1_generated_Tpu_CreateNode_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v1 + + +def sample_create_node(): + # Create a client + client = tpu_v1.TpuClient() + + # Initialize request argument(s) + node = tpu_v1.Node() + node.accelerator_type = "accelerator_type_value" + node.tensorflow_version = "tensorflow_version_value" + + request = tpu_v1.CreateNodeRequest( + parent="parent_value", + node=node, + ) + + # Make the request + operation = client.create_node(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END tpu_v1_generated_Tpu_CreateNode_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_delete_node_async.py b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_delete_node_async.py new file mode 100644 index 0000000..16f5b49 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_delete_node_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v1_generated_Tpu_DeleteNode_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v1 + + +async def sample_delete_node(): + # Create a client + client = tpu_v1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v1.DeleteNodeRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_node(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END tpu_v1_generated_Tpu_DeleteNode_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_delete_node_sync.py b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_delete_node_sync.py new file mode 100644 index 0000000..7a59a8b --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_delete_node_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v1_generated_Tpu_DeleteNode_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v1 + + +def sample_delete_node(): + # Create a client + client = tpu_v1.TpuClient() + + # Initialize request argument(s) + request = tpu_v1.DeleteNodeRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_node(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END tpu_v1_generated_Tpu_DeleteNode_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_get_accelerator_type_async.py b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_get_accelerator_type_async.py new file mode 100644 index 0000000..492e949 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_get_accelerator_type_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetAcceleratorType +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v1_generated_Tpu_GetAcceleratorType_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v1 + + +async def sample_get_accelerator_type(): + # Create a client + client = tpu_v1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v1.GetAcceleratorTypeRequest( + name="name_value", + ) + + # Make the request + response = await client.get_accelerator_type(request=request) + + # Handle the response + print(response) + +# [END tpu_v1_generated_Tpu_GetAcceleratorType_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_get_accelerator_type_sync.py b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_get_accelerator_type_sync.py new file mode 100644 index 0000000..e21334c --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_get_accelerator_type_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetAcceleratorType +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v1_generated_Tpu_GetAcceleratorType_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v1 + + +def sample_get_accelerator_type(): + # Create a client + client = tpu_v1.TpuClient() + + # Initialize request argument(s) + request = tpu_v1.GetAcceleratorTypeRequest( + name="name_value", + ) + + # Make the request + response = client.get_accelerator_type(request=request) + + # Handle the response + print(response) + +# [END tpu_v1_generated_Tpu_GetAcceleratorType_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_get_node_async.py b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_get_node_async.py new file mode 100644 index 0000000..8495733 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_get_node_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v1_generated_Tpu_GetNode_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v1 + + +async def sample_get_node(): + # Create a client + client = tpu_v1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v1.GetNodeRequest( + name="name_value", + ) + + # Make the request + response = await client.get_node(request=request) + + # Handle the response + print(response) + +# [END tpu_v1_generated_Tpu_GetNode_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_get_node_sync.py b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_get_node_sync.py new file mode 100644 index 0000000..397cacb --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_get_node_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v1_generated_Tpu_GetNode_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v1 + + +def sample_get_node(): + # Create a client + client = tpu_v1.TpuClient() + + # Initialize request argument(s) + request = tpu_v1.GetNodeRequest( + name="name_value", + ) + + # Make the request + response = client.get_node(request=request) + + # Handle the response + print(response) + +# [END tpu_v1_generated_Tpu_GetNode_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_get_tensor_flow_version_async.py b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_get_tensor_flow_version_async.py new file mode 100644 index 0000000..23cc71e --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_get_tensor_flow_version_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetTensorFlowVersion +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v1_generated_Tpu_GetTensorFlowVersion_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v1 + + +async def sample_get_tensor_flow_version(): + # Create a client + client = tpu_v1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v1.GetTensorFlowVersionRequest( + name="name_value", + ) + + # Make the request + response = await client.get_tensor_flow_version(request=request) + + # Handle the response + print(response) + +# [END tpu_v1_generated_Tpu_GetTensorFlowVersion_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_get_tensor_flow_version_sync.py b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_get_tensor_flow_version_sync.py new file mode 100644 index 0000000..34fa6ee --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_get_tensor_flow_version_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetTensorFlowVersion +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v1_generated_Tpu_GetTensorFlowVersion_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v1 + + +def sample_get_tensor_flow_version(): + # Create a client + client = tpu_v1.TpuClient() + + # Initialize request argument(s) + request = tpu_v1.GetTensorFlowVersionRequest( + name="name_value", + ) + + # Make the request + response = client.get_tensor_flow_version(request=request) + + # Handle the response + print(response) + +# [END tpu_v1_generated_Tpu_GetTensorFlowVersion_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_list_accelerator_types_async.py b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_list_accelerator_types_async.py new file mode 100644 index 0000000..ae5bd5f --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_list_accelerator_types_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListAcceleratorTypes +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v1_generated_Tpu_ListAcceleratorTypes_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v1 + + +async def sample_list_accelerator_types(): + # Create a client + client = tpu_v1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v1.ListAcceleratorTypesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_accelerator_types(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END tpu_v1_generated_Tpu_ListAcceleratorTypes_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_list_accelerator_types_sync.py b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_list_accelerator_types_sync.py new file mode 100644 index 0000000..b89bba3 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_list_accelerator_types_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListAcceleratorTypes +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v1_generated_Tpu_ListAcceleratorTypes_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v1 + + +def sample_list_accelerator_types(): + # Create a client + client = tpu_v1.TpuClient() + + # Initialize request argument(s) + request = tpu_v1.ListAcceleratorTypesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_accelerator_types(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END tpu_v1_generated_Tpu_ListAcceleratorTypes_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_list_nodes_async.py b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_list_nodes_async.py new file mode 100644 index 0000000..fa5ea2e --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_list_nodes_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListNodes +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v1_generated_Tpu_ListNodes_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v1 + + +async def sample_list_nodes(): + # Create a client + client = tpu_v1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v1.ListNodesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_nodes(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END tpu_v1_generated_Tpu_ListNodes_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_list_nodes_sync.py b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_list_nodes_sync.py new file mode 100644 index 0000000..42a58e5 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_list_nodes_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListNodes +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v1_generated_Tpu_ListNodes_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v1 + + +def sample_list_nodes(): + # Create a client + client = tpu_v1.TpuClient() + + # Initialize request argument(s) + request = tpu_v1.ListNodesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_nodes(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END tpu_v1_generated_Tpu_ListNodes_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_list_tensor_flow_versions_async.py b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_list_tensor_flow_versions_async.py new file mode 100644 index 0000000..54cf7b3 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_list_tensor_flow_versions_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListTensorFlowVersions +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v1_generated_Tpu_ListTensorFlowVersions_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v1 + + +async def sample_list_tensor_flow_versions(): + # Create a client + client = tpu_v1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v1.ListTensorFlowVersionsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_tensor_flow_versions(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END tpu_v1_generated_Tpu_ListTensorFlowVersions_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_list_tensor_flow_versions_sync.py b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_list_tensor_flow_versions_sync.py new file mode 100644 index 0000000..9f3267a --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_list_tensor_flow_versions_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListTensorFlowVersions +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v1_generated_Tpu_ListTensorFlowVersions_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v1 + + +def sample_list_tensor_flow_versions(): + # Create a client + client = tpu_v1.TpuClient() + + # Initialize request argument(s) + request = tpu_v1.ListTensorFlowVersionsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_tensor_flow_versions(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END tpu_v1_generated_Tpu_ListTensorFlowVersions_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_reimage_node_async.py b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_reimage_node_async.py new file mode 100644 index 0000000..4e33b6b --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_reimage_node_async.py @@ -0,0 +1,55 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ReimageNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v1_generated_Tpu_ReimageNode_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v1 + + +async def sample_reimage_node(): + # Create a client + client = tpu_v1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v1.ReimageNodeRequest( + ) + + # Make the request + operation = client.reimage_node(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END tpu_v1_generated_Tpu_ReimageNode_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_reimage_node_sync.py b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_reimage_node_sync.py new file mode 100644 index 0000000..b2e5c9b --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_reimage_node_sync.py @@ -0,0 +1,55 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ReimageNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v1_generated_Tpu_ReimageNode_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v1 + + +def sample_reimage_node(): + # Create a client + client = tpu_v1.TpuClient() + + # Initialize request argument(s) + request = tpu_v1.ReimageNodeRequest( + ) + + # Make the request + operation = client.reimage_node(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END tpu_v1_generated_Tpu_ReimageNode_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_start_node_async.py b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_start_node_async.py new file mode 100644 index 0000000..d2134fb --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_start_node_async.py @@ -0,0 +1,55 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for StartNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v1_generated_Tpu_StartNode_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v1 + + +async def sample_start_node(): + # Create a client + client = tpu_v1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v1.StartNodeRequest( + ) + + # Make the request + operation = client.start_node(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END tpu_v1_generated_Tpu_StartNode_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_start_node_sync.py b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_start_node_sync.py new file mode 100644 index 0000000..61750aa --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_start_node_sync.py @@ -0,0 +1,55 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for StartNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v1_generated_Tpu_StartNode_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v1 + + +def sample_start_node(): + # Create a client + client = tpu_v1.TpuClient() + + # Initialize request argument(s) + request = tpu_v1.StartNodeRequest( + ) + + # Make the request + operation = client.start_node(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END tpu_v1_generated_Tpu_StartNode_sync] diff --git a/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_stop_node_async.py b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_stop_node_async.py new file mode 100644 index 0000000..80388c8 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_stop_node_async.py @@ -0,0 +1,55 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for StopNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v1_generated_Tpu_StopNode_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v1 + + +async def sample_stop_node(): + # Create a client + client = tpu_v1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v1.StopNodeRequest( + ) + + # Make the request + operation = client.stop_node(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END tpu_v1_generated_Tpu_StopNode_async] diff --git a/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_stop_node_sync.py b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_stop_node_sync.py new file mode 100644 index 0000000..8f42e58 --- /dev/null +++ b/owl-bot-staging/v1/samples/generated_samples/tpu_v1_generated_tpu_stop_node_sync.py @@ -0,0 +1,55 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for StopNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v1_generated_Tpu_StopNode_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v1 + + +def sample_stop_node(): + # Create a client + client = tpu_v1.TpuClient() + + # Initialize request argument(s) + request = tpu_v1.StopNodeRequest( + ) + + # Make the request + operation = client.stop_node(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END tpu_v1_generated_Tpu_StopNode_sync] diff --git a/owl-bot-staging/v1/scripts/fixup_tpu_v1_keywords.py b/owl-bot-staging/v1/scripts/fixup_tpu_v1_keywords.py new file mode 100644 index 0000000..3c17c47 --- /dev/null +++ b/owl-bot-staging/v1/scripts/fixup_tpu_v1_keywords.py @@ -0,0 +1,186 @@ +#! /usr/bin/env python3 +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import argparse +import os +import libcst as cst +import pathlib +import sys +from typing import (Any, Callable, Dict, List, Sequence, Tuple) + + +def partition( + predicate: Callable[[Any], bool], + iterator: Sequence[Any] +) -> Tuple[List[Any], List[Any]]: + """A stable, out-of-place partition.""" + results = ([], []) + + for i in iterator: + results[int(predicate(i))].append(i) + + # Returns trueList, falseList + return results[1], results[0] + + +class tpuCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'create_node': ('parent', 'node', 'node_id', ), + 'delete_node': ('name', ), + 'get_accelerator_type': ('name', ), + 'get_node': ('name', ), + 'get_tensor_flow_version': ('name', ), + 'list_accelerator_types': ('parent', 'page_size', 'page_token', 'filter', 'order_by', ), + 'list_nodes': ('parent', 'page_size', 'page_token', ), + 'list_tensor_flow_versions': ('parent', 'page_size', 'page_token', 'filter', 'order_by', ), + 'reimage_node': ('name', 'tensorflow_version', ), + 'start_node': ('name', ), + 'stop_node': ('name', ), + } + + def leave_Call(self, original: cst.Call, updated: cst.Call) -> cst.CSTNode: + try: + key = original.func.attr.value + kword_params = self.METHOD_TO_PARAMS[key] + except (AttributeError, KeyError): + # Either not a method from the API or too convoluted to be sure. + return updated + + # If the existing code is valid, keyword args come after positional args. + # Therefore, all positional args must map to the first parameters. + args, kwargs = partition(lambda a: not bool(a.keyword), updated.args) + if any(k.keyword.value == "request" for k in kwargs): + # We've already fixed this file, don't fix it again. + return updated + + kwargs, ctrl_kwargs = partition( + lambda a: a.keyword.value not in self.CTRL_PARAMS, + kwargs + ) + + args, ctrl_args = args[:len(kword_params)], args[len(kword_params):] + ctrl_kwargs.extend(cst.Arg(value=a.value, keyword=cst.Name(value=ctrl)) + for a, ctrl in zip(ctrl_args, self.CTRL_PARAMS)) + + request_arg = cst.Arg( + value=cst.Dict([ + cst.DictElement( + cst.SimpleString("'{}'".format(name)), +cst.Element(value=arg.value) + ) + # Note: the args + kwargs looks silly, but keep in mind that + # the control parameters had to be stripped out, and that + # those could have been passed positionally or by keyword. + for name, arg in zip(kword_params, args + kwargs)]), + keyword=cst.Name("request") + ) + + return updated.with_changes( + args=[request_arg] + ctrl_kwargs + ) + + +def fix_files( + in_dir: pathlib.Path, + out_dir: pathlib.Path, + *, + transformer=tpuCallTransformer(), +): + """Duplicate the input dir to the output dir, fixing file method calls. + + Preconditions: + * in_dir is a real directory + * out_dir is a real, empty directory + """ + pyfile_gen = ( + pathlib.Path(os.path.join(root, f)) + for root, _, files in os.walk(in_dir) + for f in files if os.path.splitext(f)[1] == ".py" + ) + + for fpath in pyfile_gen: + with open(fpath, 'r') as f: + src = f.read() + + # Parse the code and insert method call fixes. + tree = cst.parse_module(src) + updated = tree.visit(transformer) + + # Create the path and directory structure for the new file. + updated_path = out_dir.joinpath(fpath.relative_to(in_dir)) + updated_path.parent.mkdir(parents=True, exist_ok=True) + + # Generate the updated source file at the corresponding path. + with open(updated_path, 'w') as f: + f.write(updated.code) + + +if __name__ == '__main__': + parser = argparse.ArgumentParser( + description="""Fix up source that uses the tpu client library. + +The existing sources are NOT overwritten but are copied to output_dir with changes made. + +Note: This tool operates at a best-effort level at converting positional + parameters in client method calls to keyword based parameters. + Cases where it WILL FAIL include + A) * or ** expansion in a method call. + B) Calls via function or method alias (includes free function calls) + C) Indirect or dispatched calls (e.g. the method is looked up dynamically) + + These all constitute false negatives. The tool will also detect false + positives when an API method shares a name with another method. +""") + parser.add_argument( + '-d', + '--input-directory', + required=True, + dest='input_dir', + help='the input directory to walk for python files to fix up', + ) + parser.add_argument( + '-o', + '--output-directory', + required=True, + dest='output_dir', + help='the directory to output files fixed via un-flattening', + ) + args = parser.parse_args() + input_dir = pathlib.Path(args.input_dir) + output_dir = pathlib.Path(args.output_dir) + if not input_dir.is_dir(): + print( + f"input directory '{input_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if not output_dir.is_dir(): + print( + f"output directory '{output_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if os.listdir(output_dir): + print( + f"output directory '{output_dir}' is not empty", + file=sys.stderr, + ) + sys.exit(-1) + + fix_files(input_dir, output_dir) diff --git a/owl-bot-staging/v1/setup.py b/owl-bot-staging/v1/setup.py new file mode 100644 index 0000000..47305e6 --- /dev/null +++ b/owl-bot-staging/v1/setup.py @@ -0,0 +1,90 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import io +import os + +import setuptools # type: ignore + +package_root = os.path.abspath(os.path.dirname(__file__)) + +name = 'google-cloud-tpu' + + +description = "Google Cloud Tpu API client library" + +version = {} +with open(os.path.join(package_root, 'google/cloud/tpu/gapic_version.py')) as fp: + exec(fp.read(), version) +version = version["__version__"] + +if version[0] == "0": + release_status = "Development Status :: 4 - Beta" +else: + release_status = "Development Status :: 5 - Production/Stable" + +dependencies = [ + "google-api-core[grpc] >= 1.34.0, <3.0.0dev,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*", + "proto-plus >= 1.22.0, <2.0.0dev", + "proto-plus >= 1.22.2, <2.0.0dev; python_version>='3.11'", + "protobuf>=3.19.5,<5.0.0dev,!=3.20.0,!=3.20.1,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", +] +url = "https://github.com/googleapis/python-tpu" + +package_root = os.path.abspath(os.path.dirname(__file__)) + +readme_filename = os.path.join(package_root, "README.rst") +with io.open(readme_filename, encoding="utf-8") as readme_file: + readme = readme_file.read() + +packages = [ + package + for package in setuptools.PEP420PackageFinder.find() + if package.startswith("google") +] + +namespaces = ["google", "google.cloud"] + +setuptools.setup( + name=name, + version=version, + description=description, + long_description=readme, + author="Google LLC", + author_email="googleapis-packages@google.com", + license="Apache 2.0", + url=url, + classifiers=[ + release_status, + "Intended Audience :: Developers", + "License :: OSI Approved :: Apache Software License", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Operating System :: OS Independent", + "Topic :: Internet", + ], + platforms="Posix; MacOS X; Windows", + packages=packages, + python_requires=">=3.7", + namespace_packages=namespaces, + install_requires=dependencies, + include_package_data=True, + zip_safe=False, +) diff --git a/owl-bot-staging/v1/testing/constraints-3.10.txt b/owl-bot-staging/v1/testing/constraints-3.10.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v1/testing/constraints-3.10.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1/testing/constraints-3.11.txt b/owl-bot-staging/v1/testing/constraints-3.11.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v1/testing/constraints-3.11.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1/testing/constraints-3.12.txt b/owl-bot-staging/v1/testing/constraints-3.12.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v1/testing/constraints-3.12.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1/testing/constraints-3.7.txt b/owl-bot-staging/v1/testing/constraints-3.7.txt new file mode 100644 index 0000000..6c44adf --- /dev/null +++ b/owl-bot-staging/v1/testing/constraints-3.7.txt @@ -0,0 +1,9 @@ +# This constraints file is used to check that lower bounds +# are correct in setup.py +# List all library dependencies and extras in this file. +# Pin the version to the lower bound. +# e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0dev", +# Then this file should have google-cloud-foo==1.14.0 +google-api-core==1.34.0 +proto-plus==1.22.0 +protobuf==3.19.5 diff --git a/owl-bot-staging/v1/testing/constraints-3.8.txt b/owl-bot-staging/v1/testing/constraints-3.8.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v1/testing/constraints-3.8.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1/testing/constraints-3.9.txt b/owl-bot-staging/v1/testing/constraints-3.9.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v1/testing/constraints-3.9.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v1/tests/__init__.py b/owl-bot-staging/v1/tests/__init__.py new file mode 100644 index 0000000..231bc12 --- /dev/null +++ b/owl-bot-staging/v1/tests/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/tests/unit/__init__.py b/owl-bot-staging/v1/tests/unit/__init__.py new file mode 100644 index 0000000..231bc12 --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/tests/unit/gapic/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/__init__.py new file mode 100644 index 0000000..231bc12 --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/tests/unit/gapic/tpu_v1/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/tpu_v1/__init__.py new file mode 100644 index 0000000..231bc12 --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/tpu_v1/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/tests/unit/gapic/tpu_v1/test_tpu.py b/owl-bot-staging/v1/tests/unit/gapic/tpu_v1/test_tpu.py new file mode 100644 index 0000000..c330f4e --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/tpu_v1/test_tpu.py @@ -0,0 +1,4982 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +# try/except added for compatibility with python < 3.8 +try: + from unittest import mock + from unittest.mock import AsyncMock # pragma: NO COVER +except ImportError: # pragma: NO COVER + import mock + +import grpc +from grpc.experimental import aio +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule +from proto.marshal.rules import wrappers + +from google.api_core import client_options +from google.api_core import exceptions as core_exceptions +from google.api_core import future +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers +from google.api_core import grpc_helpers_async +from google.api_core import operation +from google.api_core import operation_async # type: ignore +from google.api_core import operations_v1 +from google.api_core import path_template +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.cloud.location import locations_pb2 +from google.cloud.tpu_v1.services.tpu import TpuAsyncClient +from google.cloud.tpu_v1.services.tpu import TpuClient +from google.cloud.tpu_v1.services.tpu import pagers +from google.cloud.tpu_v1.services.tpu import transports +from google.cloud.tpu_v1.types import cloud_tpu +from google.longrunning import operations_pb2 +from google.oauth2 import service_account +from google.protobuf import timestamp_pb2 # type: ignore +import google.auth + + +def client_cert_source_callback(): + return b"cert bytes", b"key bytes" + + +# If default endpoint is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint(client): + return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT + + +def test__get_default_mtls_endpoint(): + api_endpoint = "example.googleapis.com" + api_mtls_endpoint = "example.mtls.googleapis.com" + sandbox_endpoint = "example.sandbox.googleapis.com" + sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" + non_googleapi = "api.example.com" + + assert TpuClient._get_default_mtls_endpoint(None) is None + assert TpuClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + assert TpuClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint + assert TpuClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint + assert TpuClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint + assert TpuClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + + +@pytest.mark.parametrize("client_class,transport_name", [ + (TpuClient, "grpc"), + (TpuAsyncClient, "grpc_asyncio"), +]) +def test_tpu_client_from_service_account_info(client_class, transport_name): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: + factory.return_value = creds + info = {"valid": True} + client = client_class.from_service_account_info(info, transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'tpu.googleapis.com:443' + ) + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.TpuGrpcTransport, "grpc"), + (transports.TpuGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_tpu_client_service_account_always_use_jwt(transport_class, transport_name): + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=True) + use_jwt.assert_called_once_with(True) + + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=False) + use_jwt.assert_not_called() + + +@pytest.mark.parametrize("client_class,transport_name", [ + (TpuClient, "grpc"), + (TpuAsyncClient, "grpc_asyncio"), +]) +def test_tpu_client_from_service_account_file(client_class, transport_name): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: + factory.return_value = creds + client = client_class.from_service_account_file("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'tpu.googleapis.com:443' + ) + + +def test_tpu_client_get_transport_class(): + transport = TpuClient.get_transport_class() + available_transports = [ + transports.TpuGrpcTransport, + ] + assert transport in available_transports + + transport = TpuClient.get_transport_class("grpc") + assert transport == transports.TpuGrpcTransport + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (TpuClient, transports.TpuGrpcTransport, "grpc"), + (TpuAsyncClient, transports.TpuGrpcAsyncIOTransport, "grpc_asyncio"), +]) +@mock.patch.object(TpuClient, "DEFAULT_ENDPOINT", modify_default_endpoint(TpuClient)) +@mock.patch.object(TpuAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(TpuAsyncClient)) +def test_tpu_client_client_options(client_class, transport_class, transport_name): + # Check that if channel is provided we won't create a new one. + with mock.patch.object(TpuClient, 'get_transport_class') as gtc: + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ) + client = client_class(transport=transport) + gtc.assert_not_called() + + # Check that if channel is provided via str we will create a new one. + with mock.patch.object(TpuClient, 'get_transport_class') as gtc: + client = client_class(transport=transport_name) + gtc.assert_called() + + # Check the case api_endpoint is provided. + options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name, client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_MTLS_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError): + client = client_class(transport=transport_name) + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): + with pytest.raises(ValueError): + client = client_class(transport=transport_name) + + # Check the case quota_project_id is provided + options = client_options.ClientOptions(quota_project_id="octopus") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id="octopus", + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + # Check the case api_endpoint is provided + options = client_options.ClientOptions(api_audience="https://language.googleapis.com") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience="https://language.googleapis.com" + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ + (TpuClient, transports.TpuGrpcTransport, "grpc", "true"), + (TpuAsyncClient, transports.TpuGrpcAsyncIOTransport, "grpc_asyncio", "true"), + (TpuClient, transports.TpuGrpcTransport, "grpc", "false"), + (TpuAsyncClient, transports.TpuGrpcAsyncIOTransport, "grpc_asyncio", "false"), +]) +@mock.patch.object(TpuClient, "DEFAULT_ENDPOINT", modify_default_endpoint(TpuClient)) +@mock.patch.object(TpuAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(TpuAsyncClient)) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_tpu_client_mtls_env_auto(client_class, transport_class, transport_name, use_client_cert_env): + # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default + # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. + + # Check the case client_cert_source is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + options = client_options.ClientOptions(client_cert_source=client_cert_source_callback) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + + if use_client_cert_env == "false": + expected_client_cert_source = None + expected_host = client.DEFAULT_ENDPOINT + else: + expected_client_cert_source = client_cert_source_callback + expected_host = client.DEFAULT_MTLS_ENDPOINT + + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case ADC client cert is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): + if use_client_cert_env == "false": + expected_host = client.DEFAULT_ENDPOINT + expected_client_cert_source = None + else: + expected_host = client.DEFAULT_MTLS_ENDPOINT + expected_client_cert_source = client_cert_source_callback + + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case client_cert_source and ADC client cert are not provided. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize("client_class", [ + TpuClient, TpuAsyncClient +]) +@mock.patch.object(TpuClient, "DEFAULT_ENDPOINT", modify_default_endpoint(TpuClient)) +@mock.patch.object(TpuAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(TpuAsyncClient)) +def test_tpu_client_get_mtls_endpoint_and_cert_source(client_class): + mock_client_cert_source = mock.Mock() + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "true". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + mock_api_endpoint = "foo" + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + assert api_endpoint == mock_api_endpoint + assert cert_source == mock_client_cert_source + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "false". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + mock_client_cert_source = mock.Mock() + mock_api_endpoint = "foo" + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + assert api_endpoint == mock_api_endpoint + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert doesn't exist. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=False): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert exists. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=mock_client_cert_source): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source == mock_client_cert_source + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (TpuClient, transports.TpuGrpcTransport, "grpc"), + (TpuAsyncClient, transports.TpuGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_tpu_client_client_options_scopes(client_class, transport_class, transport_name): + # Check the case scopes are provided. + options = client_options.ClientOptions( + scopes=["1", "2"], + ) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=["1", "2"], + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ + (TpuClient, transports.TpuGrpcTransport, "grpc", grpc_helpers), + (TpuAsyncClient, transports.TpuGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), +]) +def test_tpu_client_client_options_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + +def test_tpu_client_client_options_from_dict(): + with mock.patch('google.cloud.tpu_v1.services.tpu.transports.TpuGrpcTransport.__init__') as grpc_transport: + grpc_transport.return_value = None + client = TpuClient( + client_options={'api_endpoint': 'squid.clam.whelk'} + ) + grpc_transport.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ + (TpuClient, transports.TpuGrpcTransport, "grpc", grpc_helpers), + (TpuAsyncClient, transports.TpuGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), +]) +def test_tpu_client_create_channel_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # test that the credentials from file are saved and used as the credentials. + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel" + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + file_creds = ga_credentials.AnonymousCredentials() + load_creds.return_value = (file_creds, None) + adc.return_value = (creds, None) + client = client_class(client_options=options, transport=transport_name) + create_channel.assert_called_with( + "tpu.googleapis.com:443", + credentials=file_creds, + credentials_file=None, + quota_project_id=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + scopes=None, + default_host="tpu.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.ListNodesRequest, + dict, +]) +def test_list_nodes(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_nodes), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.ListNodesResponse( + next_page_token='next_page_token_value', + unreachable=['unreachable_value'], + ) + response = client.list_nodes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.ListNodesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListNodesPager) + assert response.next_page_token == 'next_page_token_value' + assert response.unreachable == ['unreachable_value'] + + +def test_list_nodes_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_nodes), + '__call__') as call: + client.list_nodes() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.ListNodesRequest() + +@pytest.mark.asyncio +async def test_list_nodes_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.ListNodesRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_nodes), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.ListNodesResponse( + next_page_token='next_page_token_value', + unreachable=['unreachable_value'], + )) + response = await client.list_nodes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.ListNodesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListNodesAsyncPager) + assert response.next_page_token == 'next_page_token_value' + assert response.unreachable == ['unreachable_value'] + + +@pytest.mark.asyncio +async def test_list_nodes_async_from_dict(): + await test_list_nodes_async(request_type=dict) + + +def test_list_nodes_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.ListNodesRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_nodes), + '__call__') as call: + call.return_value = cloud_tpu.ListNodesResponse() + client.list_nodes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_list_nodes_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.ListNodesRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_nodes), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.ListNodesResponse()) + await client.list_nodes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +def test_list_nodes_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_nodes), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.ListNodesResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_nodes( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + + +def test_list_nodes_flattened_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_nodes( + cloud_tpu.ListNodesRequest(), + parent='parent_value', + ) + +@pytest.mark.asyncio +async def test_list_nodes_flattened_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_nodes), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.ListNodesResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.ListNodesResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_nodes( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_list_nodes_flattened_error_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_nodes( + cloud_tpu.ListNodesRequest(), + parent='parent_value', + ) + + +def test_list_nodes_pager(transport_name: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_nodes), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + cloud_tpu.Node(), + cloud_tpu.Node(), + ], + next_page_token='abc', + ), + cloud_tpu.ListNodesResponse( + nodes=[], + next_page_token='def', + ), + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + cloud_tpu.Node(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_nodes(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, cloud_tpu.Node) + for i in results) +def test_list_nodes_pages(transport_name: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_nodes), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + cloud_tpu.Node(), + cloud_tpu.Node(), + ], + next_page_token='abc', + ), + cloud_tpu.ListNodesResponse( + nodes=[], + next_page_token='def', + ), + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + cloud_tpu.Node(), + ], + ), + RuntimeError, + ) + pages = list(client.list_nodes(request={}).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.asyncio +async def test_list_nodes_async_pager(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_nodes), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + cloud_tpu.Node(), + cloud_tpu.Node(), + ], + next_page_token='abc', + ), + cloud_tpu.ListNodesResponse( + nodes=[], + next_page_token='def', + ), + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + cloud_tpu.Node(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_nodes(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, cloud_tpu.Node) + for i in responses) + + +@pytest.mark.asyncio +async def test_list_nodes_async_pages(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_nodes), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + cloud_tpu.Node(), + cloud_tpu.Node(), + ], + next_page_token='abc', + ), + cloud_tpu.ListNodesResponse( + nodes=[], + next_page_token='def', + ), + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + cloud_tpu.Node(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_nodes(request={})).pages: # pragma: no branch + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.GetNodeRequest, + dict, +]) +def test_get_node(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.Node( + name='name_value', + description='description_value', + accelerator_type='accelerator_type_value', + ip_address='ip_address_value', + port='port_value', + state=cloud_tpu.Node.State.CREATING, + health_description='health_description_value', + tensorflow_version='tensorflow_version_value', + network='network_value', + cidr_block='cidr_block_value', + service_account='service_account_value', + health=cloud_tpu.Node.Health.HEALTHY, + use_service_networking=True, + api_version=cloud_tpu.Node.ApiVersion.V1_ALPHA1, + ) + response = client.get_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_tpu.Node) + assert response.name == 'name_value' + assert response.description == 'description_value' + assert response.accelerator_type == 'accelerator_type_value' + assert response.ip_address == 'ip_address_value' + assert response.port == 'port_value' + assert response.state == cloud_tpu.Node.State.CREATING + assert response.health_description == 'health_description_value' + assert response.tensorflow_version == 'tensorflow_version_value' + assert response.network == 'network_value' + assert response.cidr_block == 'cidr_block_value' + assert response.service_account == 'service_account_value' + assert response.health == cloud_tpu.Node.Health.HEALTHY + assert response.use_service_networking is True + assert response.api_version == cloud_tpu.Node.ApiVersion.V1_ALPHA1 + + +def test_get_node_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_node), + '__call__') as call: + client.get_node() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetNodeRequest() + +@pytest.mark.asyncio +async def test_get_node_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.GetNodeRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.Node( + name='name_value', + description='description_value', + accelerator_type='accelerator_type_value', + ip_address='ip_address_value', + port='port_value', + state=cloud_tpu.Node.State.CREATING, + health_description='health_description_value', + tensorflow_version='tensorflow_version_value', + network='network_value', + cidr_block='cidr_block_value', + service_account='service_account_value', + health=cloud_tpu.Node.Health.HEALTHY, + use_service_networking=True, + api_version=cloud_tpu.Node.ApiVersion.V1_ALPHA1, + )) + response = await client.get_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_tpu.Node) + assert response.name == 'name_value' + assert response.description == 'description_value' + assert response.accelerator_type == 'accelerator_type_value' + assert response.ip_address == 'ip_address_value' + assert response.port == 'port_value' + assert response.state == cloud_tpu.Node.State.CREATING + assert response.health_description == 'health_description_value' + assert response.tensorflow_version == 'tensorflow_version_value' + assert response.network == 'network_value' + assert response.cidr_block == 'cidr_block_value' + assert response.service_account == 'service_account_value' + assert response.health == cloud_tpu.Node.Health.HEALTHY + assert response.use_service_networking is True + assert response.api_version == cloud_tpu.Node.ApiVersion.V1_ALPHA1 + + +@pytest.mark.asyncio +async def test_get_node_async_from_dict(): + await test_get_node_async(request_type=dict) + + +def test_get_node_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.GetNodeRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_node), + '__call__') as call: + call.return_value = cloud_tpu.Node() + client.get_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_get_node_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.GetNodeRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_node), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.Node()) + await client.get_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +def test_get_node_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.Node() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_node( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_get_node_flattened_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_node( + cloud_tpu.GetNodeRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_get_node_flattened_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.Node() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.Node()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_node( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_get_node_flattened_error_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_node( + cloud_tpu.GetNodeRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.CreateNodeRequest, + dict, +]) +def test_create_node(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.create_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.CreateNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_create_node_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_node), + '__call__') as call: + client.create_node() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.CreateNodeRequest() + +@pytest.mark.asyncio +async def test_create_node_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.CreateNodeRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.create_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.CreateNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_create_node_async_from_dict(): + await test_create_node_async(request_type=dict) + + +def test_create_node_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.CreateNodeRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_node), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.create_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_create_node_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.CreateNodeRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_node), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.create_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +def test_create_node_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_node( + parent='parent_value', + node=cloud_tpu.Node(name='name_value'), + node_id='node_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].node + mock_val = cloud_tpu.Node(name='name_value') + assert arg == mock_val + arg = args[0].node_id + mock_val = 'node_id_value' + assert arg == mock_val + + +def test_create_node_flattened_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_node( + cloud_tpu.CreateNodeRequest(), + parent='parent_value', + node=cloud_tpu.Node(name='name_value'), + node_id='node_id_value', + ) + +@pytest.mark.asyncio +async def test_create_node_flattened_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_node( + parent='parent_value', + node=cloud_tpu.Node(name='name_value'), + node_id='node_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].node + mock_val = cloud_tpu.Node(name='name_value') + assert arg == mock_val + arg = args[0].node_id + mock_val = 'node_id_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_create_node_flattened_error_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.create_node( + cloud_tpu.CreateNodeRequest(), + parent='parent_value', + node=cloud_tpu.Node(name='name_value'), + node_id='node_id_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.DeleteNodeRequest, + dict, +]) +def test_delete_node(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.delete_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.DeleteNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_delete_node_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_node), + '__call__') as call: + client.delete_node() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.DeleteNodeRequest() + +@pytest.mark.asyncio +async def test_delete_node_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.DeleteNodeRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.delete_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.DeleteNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_delete_node_async_from_dict(): + await test_delete_node_async(request_type=dict) + + +def test_delete_node_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.DeleteNodeRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_node), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.delete_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_delete_node_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.DeleteNodeRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_node), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.delete_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +def test_delete_node_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.delete_node( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_delete_node_flattened_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_node( + cloud_tpu.DeleteNodeRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_delete_node_flattened_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.delete_node( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_delete_node_flattened_error_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.delete_node( + cloud_tpu.DeleteNodeRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.ReimageNodeRequest, + dict, +]) +def test_reimage_node(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.reimage_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.reimage_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.ReimageNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_reimage_node_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.reimage_node), + '__call__') as call: + client.reimage_node() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.ReimageNodeRequest() + +@pytest.mark.asyncio +async def test_reimage_node_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.ReimageNodeRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.reimage_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.reimage_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.ReimageNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_reimage_node_async_from_dict(): + await test_reimage_node_async(request_type=dict) + + +def test_reimage_node_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.ReimageNodeRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.reimage_node), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.reimage_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_reimage_node_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.ReimageNodeRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.reimage_node), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.reimage_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.StopNodeRequest, + dict, +]) +def test_stop_node(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.stop_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.stop_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.StopNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_stop_node_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.stop_node), + '__call__') as call: + client.stop_node() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.StopNodeRequest() + +@pytest.mark.asyncio +async def test_stop_node_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.StopNodeRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.stop_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.stop_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.StopNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_stop_node_async_from_dict(): + await test_stop_node_async(request_type=dict) + + +def test_stop_node_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.StopNodeRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.stop_node), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.stop_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_stop_node_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.StopNodeRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.stop_node), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.stop_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.StartNodeRequest, + dict, +]) +def test_start_node(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.start_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.start_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.StartNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_start_node_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.start_node), + '__call__') as call: + client.start_node() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.StartNodeRequest() + +@pytest.mark.asyncio +async def test_start_node_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.StartNodeRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.start_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.start_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.StartNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_start_node_async_from_dict(): + await test_start_node_async(request_type=dict) + + +def test_start_node_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.StartNodeRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.start_node), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.start_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_start_node_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.StartNodeRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.start_node), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.start_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.ListTensorFlowVersionsRequest, + dict, +]) +def test_list_tensor_flow_versions(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_tensor_flow_versions), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.ListTensorFlowVersionsResponse( + next_page_token='next_page_token_value', + unreachable=['unreachable_value'], + ) + response = client.list_tensor_flow_versions(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.ListTensorFlowVersionsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListTensorFlowVersionsPager) + assert response.next_page_token == 'next_page_token_value' + assert response.unreachable == ['unreachable_value'] + + +def test_list_tensor_flow_versions_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_tensor_flow_versions), + '__call__') as call: + client.list_tensor_flow_versions() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.ListTensorFlowVersionsRequest() + +@pytest.mark.asyncio +async def test_list_tensor_flow_versions_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.ListTensorFlowVersionsRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_tensor_flow_versions), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.ListTensorFlowVersionsResponse( + next_page_token='next_page_token_value', + unreachable=['unreachable_value'], + )) + response = await client.list_tensor_flow_versions(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.ListTensorFlowVersionsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListTensorFlowVersionsAsyncPager) + assert response.next_page_token == 'next_page_token_value' + assert response.unreachable == ['unreachable_value'] + + +@pytest.mark.asyncio +async def test_list_tensor_flow_versions_async_from_dict(): + await test_list_tensor_flow_versions_async(request_type=dict) + + +def test_list_tensor_flow_versions_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.ListTensorFlowVersionsRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_tensor_flow_versions), + '__call__') as call: + call.return_value = cloud_tpu.ListTensorFlowVersionsResponse() + client.list_tensor_flow_versions(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_list_tensor_flow_versions_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.ListTensorFlowVersionsRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_tensor_flow_versions), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.ListTensorFlowVersionsResponse()) + await client.list_tensor_flow_versions(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +def test_list_tensor_flow_versions_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_tensor_flow_versions), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.ListTensorFlowVersionsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_tensor_flow_versions( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + + +def test_list_tensor_flow_versions_flattened_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_tensor_flow_versions( + cloud_tpu.ListTensorFlowVersionsRequest(), + parent='parent_value', + ) + +@pytest.mark.asyncio +async def test_list_tensor_flow_versions_flattened_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_tensor_flow_versions), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.ListTensorFlowVersionsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.ListTensorFlowVersionsResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_tensor_flow_versions( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_list_tensor_flow_versions_flattened_error_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_tensor_flow_versions( + cloud_tpu.ListTensorFlowVersionsRequest(), + parent='parent_value', + ) + + +def test_list_tensor_flow_versions_pager(transport_name: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_tensor_flow_versions), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListTensorFlowVersionsResponse( + tensorflow_versions=[ + cloud_tpu.TensorFlowVersion(), + cloud_tpu.TensorFlowVersion(), + cloud_tpu.TensorFlowVersion(), + ], + next_page_token='abc', + ), + cloud_tpu.ListTensorFlowVersionsResponse( + tensorflow_versions=[], + next_page_token='def', + ), + cloud_tpu.ListTensorFlowVersionsResponse( + tensorflow_versions=[ + cloud_tpu.TensorFlowVersion(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListTensorFlowVersionsResponse( + tensorflow_versions=[ + cloud_tpu.TensorFlowVersion(), + cloud_tpu.TensorFlowVersion(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_tensor_flow_versions(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, cloud_tpu.TensorFlowVersion) + for i in results) +def test_list_tensor_flow_versions_pages(transport_name: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_tensor_flow_versions), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListTensorFlowVersionsResponse( + tensorflow_versions=[ + cloud_tpu.TensorFlowVersion(), + cloud_tpu.TensorFlowVersion(), + cloud_tpu.TensorFlowVersion(), + ], + next_page_token='abc', + ), + cloud_tpu.ListTensorFlowVersionsResponse( + tensorflow_versions=[], + next_page_token='def', + ), + cloud_tpu.ListTensorFlowVersionsResponse( + tensorflow_versions=[ + cloud_tpu.TensorFlowVersion(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListTensorFlowVersionsResponse( + tensorflow_versions=[ + cloud_tpu.TensorFlowVersion(), + cloud_tpu.TensorFlowVersion(), + ], + ), + RuntimeError, + ) + pages = list(client.list_tensor_flow_versions(request={}).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.asyncio +async def test_list_tensor_flow_versions_async_pager(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_tensor_flow_versions), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListTensorFlowVersionsResponse( + tensorflow_versions=[ + cloud_tpu.TensorFlowVersion(), + cloud_tpu.TensorFlowVersion(), + cloud_tpu.TensorFlowVersion(), + ], + next_page_token='abc', + ), + cloud_tpu.ListTensorFlowVersionsResponse( + tensorflow_versions=[], + next_page_token='def', + ), + cloud_tpu.ListTensorFlowVersionsResponse( + tensorflow_versions=[ + cloud_tpu.TensorFlowVersion(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListTensorFlowVersionsResponse( + tensorflow_versions=[ + cloud_tpu.TensorFlowVersion(), + cloud_tpu.TensorFlowVersion(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_tensor_flow_versions(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, cloud_tpu.TensorFlowVersion) + for i in responses) + + +@pytest.mark.asyncio +async def test_list_tensor_flow_versions_async_pages(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_tensor_flow_versions), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListTensorFlowVersionsResponse( + tensorflow_versions=[ + cloud_tpu.TensorFlowVersion(), + cloud_tpu.TensorFlowVersion(), + cloud_tpu.TensorFlowVersion(), + ], + next_page_token='abc', + ), + cloud_tpu.ListTensorFlowVersionsResponse( + tensorflow_versions=[], + next_page_token='def', + ), + cloud_tpu.ListTensorFlowVersionsResponse( + tensorflow_versions=[ + cloud_tpu.TensorFlowVersion(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListTensorFlowVersionsResponse( + tensorflow_versions=[ + cloud_tpu.TensorFlowVersion(), + cloud_tpu.TensorFlowVersion(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_tensor_flow_versions(request={})).pages: # pragma: no branch + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.GetTensorFlowVersionRequest, + dict, +]) +def test_get_tensor_flow_version(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_tensor_flow_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.TensorFlowVersion( + name='name_value', + version='version_value', + ) + response = client.get_tensor_flow_version(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetTensorFlowVersionRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_tpu.TensorFlowVersion) + assert response.name == 'name_value' + assert response.version == 'version_value' + + +def test_get_tensor_flow_version_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_tensor_flow_version), + '__call__') as call: + client.get_tensor_flow_version() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetTensorFlowVersionRequest() + +@pytest.mark.asyncio +async def test_get_tensor_flow_version_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.GetTensorFlowVersionRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_tensor_flow_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.TensorFlowVersion( + name='name_value', + version='version_value', + )) + response = await client.get_tensor_flow_version(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetTensorFlowVersionRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_tpu.TensorFlowVersion) + assert response.name == 'name_value' + assert response.version == 'version_value' + + +@pytest.mark.asyncio +async def test_get_tensor_flow_version_async_from_dict(): + await test_get_tensor_flow_version_async(request_type=dict) + + +def test_get_tensor_flow_version_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.GetTensorFlowVersionRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_tensor_flow_version), + '__call__') as call: + call.return_value = cloud_tpu.TensorFlowVersion() + client.get_tensor_flow_version(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_get_tensor_flow_version_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.GetTensorFlowVersionRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_tensor_flow_version), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.TensorFlowVersion()) + await client.get_tensor_flow_version(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +def test_get_tensor_flow_version_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_tensor_flow_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.TensorFlowVersion() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_tensor_flow_version( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_get_tensor_flow_version_flattened_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_tensor_flow_version( + cloud_tpu.GetTensorFlowVersionRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_get_tensor_flow_version_flattened_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_tensor_flow_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.TensorFlowVersion() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.TensorFlowVersion()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_tensor_flow_version( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_get_tensor_flow_version_flattened_error_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_tensor_flow_version( + cloud_tpu.GetTensorFlowVersionRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.ListAcceleratorTypesRequest, + dict, +]) +def test_list_accelerator_types(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_accelerator_types), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.ListAcceleratorTypesResponse( + next_page_token='next_page_token_value', + unreachable=['unreachable_value'], + ) + response = client.list_accelerator_types(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.ListAcceleratorTypesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListAcceleratorTypesPager) + assert response.next_page_token == 'next_page_token_value' + assert response.unreachable == ['unreachable_value'] + + +def test_list_accelerator_types_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_accelerator_types), + '__call__') as call: + client.list_accelerator_types() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.ListAcceleratorTypesRequest() + +@pytest.mark.asyncio +async def test_list_accelerator_types_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.ListAcceleratorTypesRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_accelerator_types), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.ListAcceleratorTypesResponse( + next_page_token='next_page_token_value', + unreachable=['unreachable_value'], + )) + response = await client.list_accelerator_types(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.ListAcceleratorTypesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListAcceleratorTypesAsyncPager) + assert response.next_page_token == 'next_page_token_value' + assert response.unreachable == ['unreachable_value'] + + +@pytest.mark.asyncio +async def test_list_accelerator_types_async_from_dict(): + await test_list_accelerator_types_async(request_type=dict) + + +def test_list_accelerator_types_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.ListAcceleratorTypesRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_accelerator_types), + '__call__') as call: + call.return_value = cloud_tpu.ListAcceleratorTypesResponse() + client.list_accelerator_types(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_list_accelerator_types_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.ListAcceleratorTypesRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_accelerator_types), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.ListAcceleratorTypesResponse()) + await client.list_accelerator_types(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +def test_list_accelerator_types_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_accelerator_types), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.ListAcceleratorTypesResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_accelerator_types( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + + +def test_list_accelerator_types_flattened_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_accelerator_types( + cloud_tpu.ListAcceleratorTypesRequest(), + parent='parent_value', + ) + +@pytest.mark.asyncio +async def test_list_accelerator_types_flattened_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_accelerator_types), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.ListAcceleratorTypesResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.ListAcceleratorTypesResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_accelerator_types( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_list_accelerator_types_flattened_error_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_accelerator_types( + cloud_tpu.ListAcceleratorTypesRequest(), + parent='parent_value', + ) + + +def test_list_accelerator_types_pager(transport_name: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_accelerator_types), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + ], + next_page_token='abc', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[], + next_page_token='def', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_accelerator_types(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, cloud_tpu.AcceleratorType) + for i in results) +def test_list_accelerator_types_pages(transport_name: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_accelerator_types), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + ], + next_page_token='abc', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[], + next_page_token='def', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + ], + ), + RuntimeError, + ) + pages = list(client.list_accelerator_types(request={}).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.asyncio +async def test_list_accelerator_types_async_pager(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_accelerator_types), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + ], + next_page_token='abc', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[], + next_page_token='def', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_accelerator_types(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, cloud_tpu.AcceleratorType) + for i in responses) + + +@pytest.mark.asyncio +async def test_list_accelerator_types_async_pages(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_accelerator_types), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + ], + next_page_token='abc', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[], + next_page_token='def', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_accelerator_types(request={})).pages: # pragma: no branch + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.GetAcceleratorTypeRequest, + dict, +]) +def test_get_accelerator_type(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_accelerator_type), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.AcceleratorType( + name='name_value', + type_='type__value', + ) + response = client.get_accelerator_type(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetAcceleratorTypeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_tpu.AcceleratorType) + assert response.name == 'name_value' + assert response.type_ == 'type__value' + + +def test_get_accelerator_type_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_accelerator_type), + '__call__') as call: + client.get_accelerator_type() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetAcceleratorTypeRequest() + +@pytest.mark.asyncio +async def test_get_accelerator_type_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.GetAcceleratorTypeRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_accelerator_type), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.AcceleratorType( + name='name_value', + type_='type__value', + )) + response = await client.get_accelerator_type(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetAcceleratorTypeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_tpu.AcceleratorType) + assert response.name == 'name_value' + assert response.type_ == 'type__value' + + +@pytest.mark.asyncio +async def test_get_accelerator_type_async_from_dict(): + await test_get_accelerator_type_async(request_type=dict) + + +def test_get_accelerator_type_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.GetAcceleratorTypeRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_accelerator_type), + '__call__') as call: + call.return_value = cloud_tpu.AcceleratorType() + client.get_accelerator_type(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_get_accelerator_type_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.GetAcceleratorTypeRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_accelerator_type), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.AcceleratorType()) + await client.get_accelerator_type(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +def test_get_accelerator_type_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_accelerator_type), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.AcceleratorType() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_accelerator_type( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_get_accelerator_type_flattened_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_accelerator_type( + cloud_tpu.GetAcceleratorTypeRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_get_accelerator_type_flattened_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_accelerator_type), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.AcceleratorType() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.AcceleratorType()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_accelerator_type( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_get_accelerator_type_flattened_error_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_accelerator_type( + cloud_tpu.GetAcceleratorTypeRequest(), + name='name_value', + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.TpuGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.TpuGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = TpuClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.TpuGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = TpuClient( + client_options=options, + transport=transport, + ) + + # It is an error to provide an api_key and a credential. + options = mock.Mock() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = TpuClient( + client_options=options, + credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.TpuGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = TpuClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.TpuGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = TpuClient(transport=transport) + assert client.transport is transport + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.TpuGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.TpuGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.TpuGrpcTransport, + transports.TpuGrpcAsyncIOTransport, +]) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + +@pytest.mark.parametrize("transport_name", [ + "grpc", +]) +def test_transport_kind(transport_name): + transport = TpuClient.get_transport_class(transport_name)( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert transport.kind == transport_name + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.TpuGrpcTransport, + ) + +def test_tpu_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.TpuTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json" + ) + + +def test_tpu_base_transport(): + # Instantiate the base transport. + with mock.patch('google.cloud.tpu_v1.services.tpu.transports.TpuTransport.__init__') as Transport: + Transport.return_value = None + transport = transports.TpuTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + 'list_nodes', + 'get_node', + 'create_node', + 'delete_node', + 'reimage_node', + 'stop_node', + 'start_node', + 'list_tensor_flow_versions', + 'get_tensor_flow_version', + 'list_accelerator_types', + 'get_accelerator_type', + 'get_location', + 'list_locations', + 'get_operation', + 'cancel_operation', + 'delete_operation', + 'list_operations', + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + with pytest.raises(NotImplementedError): + transport.close() + + # Additionally, the LRO client (a property) should + # also raise NotImplementedError + with pytest.raises(NotImplementedError): + transport.operations_client + + # Catch all for all remaining methods and properties + remainder = [ + 'kind', + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +def test_tpu_base_transport_with_credentials_file(): + # Instantiate the base transport with a credentials file + with mock.patch.object(google.auth, 'load_credentials_from_file', autospec=True) as load_creds, mock.patch('google.cloud.tpu_v1.services.tpu.transports.TpuTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.TpuTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with("credentials.json", + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id="octopus", + ) + + +def test_tpu_base_transport_with_adc(): + # Test the default credentials are used if credentials and credentials_file are None. + with mock.patch.object(google.auth, 'default', autospec=True) as adc, mock.patch('google.cloud.tpu_v1.services.tpu.transports.TpuTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.TpuTransport() + adc.assert_called_once() + + +def test_tpu_auth_adc(): + # If no credentials are provided, we should use ADC credentials. + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + TpuClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.TpuGrpcTransport, + transports.TpuGrpcAsyncIOTransport, + ], +) +def test_tpu_transport_auth_adc(transport_class): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + adc.assert_called_once_with( + scopes=["1", "2"], + default_scopes=( 'https://www.googleapis.com/auth/cloud-platform',), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.TpuGrpcTransport, + transports.TpuGrpcAsyncIOTransport, + ], +) +def test_tpu_transport_auth_gdch_credentials(transport_class): + host = 'https://language.com' + api_audience_tests = [None, 'https://language2.com'] + api_audience_expect = [host, 'https://language2.com'] + for t, e in zip(api_audience_tests, api_audience_expect): + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + gdch_mock = mock.MagicMock() + type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) + adc.return_value = (gdch_mock, None) + transport_class(host=host, api_audience=t) + gdch_mock.with_gdch_audience.assert_called_once_with( + e + ) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.TpuGrpcTransport, grpc_helpers), + (transports.TpuGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +def test_tpu_transport_create_channel(transport_class, grpc_helpers): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch.object( + grpc_helpers, "create_channel", autospec=True + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + adc.return_value = (creds, None) + transport_class( + quota_project_id="octopus", + scopes=["1", "2"] + ) + + create_channel.assert_called_with( + "tpu.googleapis.com:443", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + scopes=["1", "2"], + default_host="tpu.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("transport_class", [transports.TpuGrpcTransport, transports.TpuGrpcAsyncIOTransport]) +def test_tpu_grpc_transport_client_cert_source_for_mtls( + transport_class +): + cred = ga_credentials.AnonymousCredentials() + + # Check ssl_channel_credentials is used if provided. + with mock.patch.object(transport_class, "create_channel") as mock_create_channel: + mock_ssl_channel_creds = mock.Mock() + transport_class( + host="squid.clam.whelk", + credentials=cred, + ssl_channel_credentials=mock_ssl_channel_creds + ) + mock_create_channel.assert_called_once_with( + "squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_channel_creds, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls + # is used. + with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): + with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: + transport_class( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + expected_cert, expected_key = client_cert_source_callback() + mock_ssl_cred.assert_called_once_with( + certificate_chain=expected_cert, + private_key=expected_key + ) + + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", +]) +def test_tpu_host_no_port(transport_name): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='tpu.googleapis.com'), + transport=transport_name, + ) + assert client.transport._host == ( + 'tpu.googleapis.com:443' + ) + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", +]) +def test_tpu_host_with_port(transport_name): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='tpu.googleapis.com:8000'), + transport=transport_name, + ) + assert client.transport._host == ( + 'tpu.googleapis.com:8000' + ) + +def test_tpu_grpc_transport_channel(): + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.TpuGrpcTransport( + host="squid.clam.whelk", + channel=channel, + ) + assert transport.grpc_channel == channel + assert transport._host == "squid.clam.whelk:443" + assert transport._ssl_channel_credentials == None + + +def test_tpu_grpc_asyncio_transport_channel(): + channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.TpuGrpcAsyncIOTransport( + host="squid.clam.whelk", + channel=channel, + ) + assert transport.grpc_channel == channel + assert transport._host == "squid.clam.whelk:443" + assert transport._ssl_channel_credentials == None + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize("transport_class", [transports.TpuGrpcTransport, transports.TpuGrpcAsyncIOTransport]) +def test_tpu_transport_channel_mtls_with_client_cert_source( + transport_class +): + with mock.patch("grpc.ssl_channel_credentials", autospec=True) as grpc_ssl_channel_cred: + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_ssl_cred = mock.Mock() + grpc_ssl_channel_cred.return_value = mock_ssl_cred + + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + + cred = ga_credentials.AnonymousCredentials() + with pytest.warns(DeprecationWarning): + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (cred, None) + transport = transport_class( + host="squid.clam.whelk", + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=client_cert_source_callback, + ) + adc.assert_called_once() + + grpc_ssl_channel_cred.assert_called_once_with( + certificate_chain=b"cert bytes", private_key=b"key bytes" + ) + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + assert transport._ssl_channel_credentials == mock_ssl_cred + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize("transport_class", [transports.TpuGrpcTransport, transports.TpuGrpcAsyncIOTransport]) +def test_tpu_transport_channel_mtls_with_adc( + transport_class +): + mock_ssl_cred = mock.Mock() + with mock.patch.multiple( + "google.auth.transport.grpc.SslCredentials", + __init__=mock.Mock(return_value=None), + ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), + ): + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + mock_cred = mock.Mock() + + with pytest.warns(DeprecationWarning): + transport = transport_class( + host="squid.clam.whelk", + credentials=mock_cred, + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=None, + ) + + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=mock_cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + + +def test_tpu_grpc_lro_client(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.OperationsClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + +def test_tpu_grpc_lro_async_client(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc_asyncio', + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.OperationsAsyncClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + +def test_accelerator_type_path(): + project = "squid" + location = "clam" + accelerator_type = "whelk" + expected = "projects/{project}/locations/{location}/acceleratorTypes/{accelerator_type}".format(project=project, location=location, accelerator_type=accelerator_type, ) + actual = TpuClient.accelerator_type_path(project, location, accelerator_type) + assert expected == actual + + +def test_parse_accelerator_type_path(): + expected = { + "project": "octopus", + "location": "oyster", + "accelerator_type": "nudibranch", + } + path = TpuClient.accelerator_type_path(**expected) + + # Check that the path construction is reversible. + actual = TpuClient.parse_accelerator_type_path(path) + assert expected == actual + +def test_node_path(): + project = "cuttlefish" + location = "mussel" + node = "winkle" + expected = "projects/{project}/locations/{location}/nodes/{node}".format(project=project, location=location, node=node, ) + actual = TpuClient.node_path(project, location, node) + assert expected == actual + + +def test_parse_node_path(): + expected = { + "project": "nautilus", + "location": "scallop", + "node": "abalone", + } + path = TpuClient.node_path(**expected) + + # Check that the path construction is reversible. + actual = TpuClient.parse_node_path(path) + assert expected == actual + +def test_tensor_flow_version_path(): + project = "squid" + location = "clam" + tensor_flow_version = "whelk" + expected = "projects/{project}/locations/{location}/tensorFlowVersions/{tensor_flow_version}".format(project=project, location=location, tensor_flow_version=tensor_flow_version, ) + actual = TpuClient.tensor_flow_version_path(project, location, tensor_flow_version) + assert expected == actual + + +def test_parse_tensor_flow_version_path(): + expected = { + "project": "octopus", + "location": "oyster", + "tensor_flow_version": "nudibranch", + } + path = TpuClient.tensor_flow_version_path(**expected) + + # Check that the path construction is reversible. + actual = TpuClient.parse_tensor_flow_version_path(path) + assert expected == actual + +def test_common_billing_account_path(): + billing_account = "cuttlefish" + expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + actual = TpuClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "mussel", + } + path = TpuClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = TpuClient.parse_common_billing_account_path(path) + assert expected == actual + +def test_common_folder_path(): + folder = "winkle" + expected = "folders/{folder}".format(folder=folder, ) + actual = TpuClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "nautilus", + } + path = TpuClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = TpuClient.parse_common_folder_path(path) + assert expected == actual + +def test_common_organization_path(): + organization = "scallop" + expected = "organizations/{organization}".format(organization=organization, ) + actual = TpuClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "abalone", + } + path = TpuClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = TpuClient.parse_common_organization_path(path) + assert expected == actual + +def test_common_project_path(): + project = "squid" + expected = "projects/{project}".format(project=project, ) + actual = TpuClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "clam", + } + path = TpuClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = TpuClient.parse_common_project_path(path) + assert expected == actual + +def test_common_location_path(): + project = "whelk" + location = "octopus" + expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) + actual = TpuClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "oyster", + "location": "nudibranch", + } + path = TpuClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = TpuClient.parse_common_location_path(path) + assert expected == actual + + +def test_client_with_default_client_info(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object(transports.TpuTransport, '_prep_wrapped_messages') as prep: + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object(transports.TpuTransport, '_prep_wrapped_messages') as prep: + transport_class = TpuClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + +@pytest.mark.asyncio +async def test_transport_close_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc_asyncio", + ) + with mock.patch.object(type(getattr(client.transport, "grpc_channel")), "close") as close: + async with client: + close.assert_not_called() + close.assert_called_once() + + +def test_delete_operation(transport: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = operations_pb2.DeleteOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.delete_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert response is None +@pytest.mark.asyncio +async def test_delete_operation_async(transport: str = "grpc"): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = operations_pb2.DeleteOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + None + ) + response = await client.delete_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert response is None + +def test_delete_operation_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = operations_pb2.DeleteOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + call.return_value = None + + client.delete_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations",) in kw["metadata"] +@pytest.mark.asyncio +async def test_delete_operation_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = operations_pb2.DeleteOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + None + ) + await client.delete_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations",) in kw["metadata"] + +def test_delete_operation_from_dict(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = None + + response = client.delete_operation( + request={ + "name": "locations", + } + ) + call.assert_called() +@pytest.mark.asyncio +async def test_delete_operation_from_dict_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + None + ) + response = await client.delete_operation( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_cancel_operation(transport: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = operations_pb2.CancelOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.cancel_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert response is None +@pytest.mark.asyncio +async def test_cancel_operation_async(transport: str = "grpc"): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = operations_pb2.CancelOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + None + ) + response = await client.cancel_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert response is None + +def test_cancel_operation_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = operations_pb2.CancelOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + call.return_value = None + + client.cancel_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations",) in kw["metadata"] +@pytest.mark.asyncio +async def test_cancel_operation_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = operations_pb2.CancelOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + None + ) + await client.cancel_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations",) in kw["metadata"] + +def test_cancel_operation_from_dict(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = None + + response = client.cancel_operation( + request={ + "name": "locations", + } + ) + call.assert_called() +@pytest.mark.asyncio +async def test_cancel_operation_from_dict_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + None + ) + response = await client.cancel_operation( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_get_operation(transport: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = operations_pb2.GetOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation() + response = client.get_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, operations_pb2.Operation) +@pytest.mark.asyncio +async def test_get_operation_async(transport: str = "grpc"): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = operations_pb2.GetOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation() + ) + response = await client.get_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, operations_pb2.Operation) + +def test_get_operation_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = operations_pb2.GetOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + call.return_value = operations_pb2.Operation() + + client.get_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations",) in kw["metadata"] +@pytest.mark.asyncio +async def test_get_operation_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = operations_pb2.GetOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation() + ) + await client.get_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations",) in kw["metadata"] + +def test_get_operation_from_dict(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation() + + response = client.get_operation( + request={ + "name": "locations", + } + ) + call.assert_called() +@pytest.mark.asyncio +async def test_get_operation_from_dict_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation() + ) + response = await client.get_operation( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_list_operations(transport: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = operations_pb2.ListOperationsRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.ListOperationsResponse() + response = client.list_operations(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, operations_pb2.ListOperationsResponse) +@pytest.mark.asyncio +async def test_list_operations_async(transport: str = "grpc"): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = operations_pb2.ListOperationsRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.ListOperationsResponse() + ) + response = await client.list_operations(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, operations_pb2.ListOperationsResponse) + +def test_list_operations_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = operations_pb2.ListOperationsRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + call.return_value = operations_pb2.ListOperationsResponse() + + client.list_operations(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations",) in kw["metadata"] +@pytest.mark.asyncio +async def test_list_operations_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = operations_pb2.ListOperationsRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.ListOperationsResponse() + ) + await client.list_operations(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations",) in kw["metadata"] + +def test_list_operations_from_dict(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.ListOperationsResponse() + + response = client.list_operations( + request={ + "name": "locations", + } + ) + call.assert_called() +@pytest.mark.asyncio +async def test_list_operations_from_dict_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.ListOperationsResponse() + ) + response = await client.list_operations( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_list_locations(transport: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = locations_pb2.ListLocationsRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = locations_pb2.ListLocationsResponse() + response = client.list_locations(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, locations_pb2.ListLocationsResponse) +@pytest.mark.asyncio +async def test_list_locations_async(transport: str = "grpc"): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = locations_pb2.ListLocationsRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + locations_pb2.ListLocationsResponse() + ) + response = await client.list_locations(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, locations_pb2.ListLocationsResponse) + +def test_list_locations_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = locations_pb2.ListLocationsRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + call.return_value = locations_pb2.ListLocationsResponse() + + client.list_locations(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations",) in kw["metadata"] +@pytest.mark.asyncio +async def test_list_locations_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = locations_pb2.ListLocationsRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + locations_pb2.ListLocationsResponse() + ) + await client.list_locations(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations",) in kw["metadata"] + +def test_list_locations_from_dict(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = locations_pb2.ListLocationsResponse() + + response = client.list_locations( + request={ + "name": "locations", + } + ) + call.assert_called() +@pytest.mark.asyncio +async def test_list_locations_from_dict_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + locations_pb2.ListLocationsResponse() + ) + response = await client.list_locations( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_get_location(transport: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = locations_pb2.GetLocationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_location), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = locations_pb2.Location() + response = client.get_location(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, locations_pb2.Location) +@pytest.mark.asyncio +async def test_get_location_async(transport: str = "grpc_asyncio"): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = locations_pb2.GetLocationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_location), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + locations_pb2.Location() + ) + response = await client.get_location(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, locations_pb2.Location) + +def test_get_location_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials()) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = locations_pb2.GetLocationRequest() + request.name = "locations/abc" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_location), "__call__") as call: + call.return_value = locations_pb2.Location() + + client.get_location(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations/abc",) in kw["metadata"] +@pytest.mark.asyncio +async def test_get_location_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials() + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = locations_pb2.GetLocationRequest() + request.name = "locations/abc" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_location), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + locations_pb2.Location() + ) + await client.get_location(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations/abc",) in kw["metadata"] + +def test_get_location_from_dict(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = locations_pb2.Location() + + response = client.get_location( + request={ + "name": "locations/abc", + } + ) + call.assert_called() +@pytest.mark.asyncio +async def test_get_location_from_dict_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + locations_pb2.Location() + ) + response = await client.get_location( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_transport_close(): + transports = { + "grpc": "_grpc_channel", + } + + for transport, close_name in transports.items(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport + ) + with mock.patch.object(type(getattr(client.transport, close_name)), "close") as close: + with client: + close.assert_not_called() + close.assert_called_once() + +def test_client_ctx(): + transports = [ + 'grpc', + ] + for transport in transports: + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport + ) + # Test client calls underlying transport. + with mock.patch.object(type(client.transport), "close") as close: + close.assert_not_called() + with client: + pass + close.assert_called() + +@pytest.mark.parametrize("client_class,transport_class", [ + (TpuClient, transports.TpuGrpcTransport), + (TpuAsyncClient, transports.TpuGrpcAsyncIOTransport), +]) +def test_api_key_credentials(client_class, transport_class): + with mock.patch.object( + google.auth._default, "get_api_key_credentials", create=True + ) as get_api_key_credentials: + mock_cred = mock.Mock() + get_api_key_credentials.return_value = mock_cred + options = client_options.ClientOptions() + options.api_key = "api_key" + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=mock_cred, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) diff --git a/owl-bot-staging/v2/.coveragerc b/owl-bot-staging/v2/.coveragerc new file mode 100644 index 0000000..2800d3d --- /dev/null +++ b/owl-bot-staging/v2/.coveragerc @@ -0,0 +1,13 @@ +[run] +branch = True + +[report] +show_missing = True +omit = + google/cloud/tpu/__init__.py + google/cloud/tpu/gapic_version.py +exclude_lines = + # Re-enable the standard pragma + pragma: NO COVER + # Ignore debug-only repr + def __repr__ diff --git a/owl-bot-staging/v2/.flake8 b/owl-bot-staging/v2/.flake8 new file mode 100644 index 0000000..29227d4 --- /dev/null +++ b/owl-bot-staging/v2/.flake8 @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- +# +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Generated by synthtool. DO NOT EDIT! +[flake8] +ignore = E203, E266, E501, W503 +exclude = + # Exclude generated code. + **/proto/** + **/gapic/** + **/services/** + **/types/** + *_pb2.py + + # Standard linting exemptions. + **/.nox/** + __pycache__, + .git, + *.pyc, + conf.py diff --git a/owl-bot-staging/v2/MANIFEST.in b/owl-bot-staging/v2/MANIFEST.in new file mode 100644 index 0000000..b98fa8b --- /dev/null +++ b/owl-bot-staging/v2/MANIFEST.in @@ -0,0 +1,2 @@ +recursive-include google/cloud/tpu *.py +recursive-include google/cloud/tpu_v2 *.py diff --git a/owl-bot-staging/v2/README.rst b/owl-bot-staging/v2/README.rst new file mode 100644 index 0000000..a9af6a5 --- /dev/null +++ b/owl-bot-staging/v2/README.rst @@ -0,0 +1,49 @@ +Python Client for Google Cloud Tpu API +================================================= + +Quick Start +----------- + +In order to use this library, you first need to go through the following steps: + +1. `Select or create a Cloud Platform project.`_ +2. `Enable billing for your project.`_ +3. Enable the Google Cloud Tpu API. +4. `Setup Authentication.`_ + +.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project +.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project +.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html + +Installation +~~~~~~~~~~~~ + +Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to +create isolated Python environments. The basic problem it addresses is one of +dependencies and versions, and indirectly permissions. + +With `virtualenv`_, it's possible to install this library without needing system +install permissions, and without clashing with the installed system +dependencies. + +.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/ + + +Mac/Linux +^^^^^^^^^ + +.. code-block:: console + + python3 -m venv + source /bin/activate + /bin/pip install /path/to/library + + +Windows +^^^^^^^ + +.. code-block:: console + + python3 -m venv + \Scripts\activate + \Scripts\pip.exe install \path\to\library diff --git a/owl-bot-staging/v2/docs/conf.py b/owl-bot-staging/v2/docs/conf.py new file mode 100644 index 0000000..096ffc7 --- /dev/null +++ b/owl-bot-staging/v2/docs/conf.py @@ -0,0 +1,376 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# +# google-cloud-tpu documentation build configuration file +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os +import shlex + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath("..")) + +__version__ = "0.1.0" + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +needs_sphinx = "4.0.1" + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.autosummary", + "sphinx.ext.intersphinx", + "sphinx.ext.coverage", + "sphinx.ext.napoleon", + "sphinx.ext.todo", + "sphinx.ext.viewcode", +] + +# autodoc/autosummary flags +autoclass_content = "both" +autodoc_default_flags = ["members"] +autosummary_generate = True + + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +# Allow markdown includes (so releases.md can include CHANGLEOG.md) +# http://www.sphinx-doc.org/en/master/markdown.html +source_parsers = {".md": "recommonmark.parser.CommonMarkParser"} + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +source_suffix = [".rst", ".md"] + +# The encoding of source files. +# source_encoding = 'utf-8-sig' + +# The root toctree document. +root_doc = "index" + +# General information about the project. +project = u"google-cloud-tpu" +copyright = u"2022, Google, LLC" +author = u"Google APIs" # TODO: autogenerate this bit + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The full version, including alpha/beta/rc tags. +release = __version__ +# The short X.Y version. +version = ".".join(release.split(".")[0:2]) + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# today = '' +# Else, today_fmt is used as the format for a strftime call. +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ["_build"] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = "sphinx" + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = "alabaster" + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +html_theme_options = { + "description": "Google Cloud Client Libraries for Python", + "github_user": "googleapis", + "github_repo": "google-cloud-python", + "github_banner": True, + "font_family": "'Roboto', Georgia, sans", + "head_font_family": "'Roboto', Georgia, serif", + "code_font_family": "'Roboto Mono', 'Consolas', monospace", +} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +# html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ["_static"] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +# html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# html_additional_pages = {} + +# If false, no module index is generated. +# html_domain_indices = True + +# If false, no index is generated. +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' +# html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +# html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +# html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = "google-cloud-tpu-doc" + +# -- Options for warnings ------------------------------------------------------ + + +suppress_warnings = [ + # Temporarily suppress this to avoid "more than one target found for + # cross-reference" warning, which are intractable for us to avoid while in + # a mono-repo. + # See https://github.com/sphinx-doc/sphinx/blob + # /2a65ffeef5c107c19084fabdd706cdff3f52d93c/sphinx/domains/python.py#L843 + "ref.python" +] + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + # 'preamble': '', + # Latex figure (float) alignment + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ( + root_doc, + "google-cloud-tpu.tex", + u"google-cloud-tpu Documentation", + author, + "manual", + ) +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# latex_use_parts = False + +# If true, show page references after internal links. +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# latex_appendices = [] + +# If false, no module index is generated. +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ( + root_doc, + "google-cloud-tpu", + u"Google Cloud Tpu Documentation", + [author], + 1, + ) +] + +# If true, show URL addresses after external links. +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ( + root_doc, + "google-cloud-tpu", + u"google-cloud-tpu Documentation", + author, + "google-cloud-tpu", + "GAPIC library for Google Cloud Tpu API", + "APIs", + ) +] + +# Documents to append as an appendix to all manuals. +# texinfo_appendices = [] + +# If false, no module index is generated. +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# texinfo_no_detailmenu = False + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = { + "python": ("http://python.readthedocs.org/en/latest/", None), + "gax": ("https://gax-python.readthedocs.org/en/latest/", None), + "google-auth": ("https://google-auth.readthedocs.io/en/stable", None), + "google-gax": ("https://gax-python.readthedocs.io/en/latest/", None), + "google.api_core": ("https://googleapis.dev/python/google-api-core/latest/", None), + "grpc": ("https://grpc.io/grpc/python/", None), + "requests": ("http://requests.kennethreitz.org/en/stable/", None), + "proto": ("https://proto-plus-python.readthedocs.io/en/stable", None), + "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), +} + + +# Napoleon settings +napoleon_google_docstring = True +napoleon_numpy_docstring = True +napoleon_include_private_with_doc = False +napoleon_include_special_with_doc = True +napoleon_use_admonition_for_examples = False +napoleon_use_admonition_for_notes = False +napoleon_use_admonition_for_references = False +napoleon_use_ivar = False +napoleon_use_param = True +napoleon_use_rtype = True diff --git a/owl-bot-staging/v2/docs/index.rst b/owl-bot-staging/v2/docs/index.rst new file mode 100644 index 0000000..b6e7707 --- /dev/null +++ b/owl-bot-staging/v2/docs/index.rst @@ -0,0 +1,7 @@ +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + tpu_v2/services + tpu_v2/types diff --git a/owl-bot-staging/v2/docs/tpu_v2/services.rst b/owl-bot-staging/v2/docs/tpu_v2/services.rst new file mode 100644 index 0000000..ca30a02 --- /dev/null +++ b/owl-bot-staging/v2/docs/tpu_v2/services.rst @@ -0,0 +1,6 @@ +Services for Google Cloud Tpu v2 API +==================================== +.. toctree:: + :maxdepth: 2 + + tpu diff --git a/owl-bot-staging/v2/docs/tpu_v2/tpu.rst b/owl-bot-staging/v2/docs/tpu_v2/tpu.rst new file mode 100644 index 0000000..2c49cfc --- /dev/null +++ b/owl-bot-staging/v2/docs/tpu_v2/tpu.rst @@ -0,0 +1,10 @@ +Tpu +--------------------- + +.. automodule:: google.cloud.tpu_v2.services.tpu + :members: + :inherited-members: + +.. automodule:: google.cloud.tpu_v2.services.tpu.pagers + :members: + :inherited-members: diff --git a/owl-bot-staging/v2/docs/tpu_v2/types.rst b/owl-bot-staging/v2/docs/tpu_v2/types.rst new file mode 100644 index 0000000..e8a0674 --- /dev/null +++ b/owl-bot-staging/v2/docs/tpu_v2/types.rst @@ -0,0 +1,6 @@ +Types for Google Cloud Tpu v2 API +================================= + +.. automodule:: google.cloud.tpu_v2.types + :members: + :show-inheritance: diff --git a/owl-bot-staging/v2/google/cloud/tpu/__init__.py b/owl-bot-staging/v2/google/cloud/tpu/__init__.py new file mode 100644 index 0000000..e0068ce --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/tpu/__init__.py @@ -0,0 +1,97 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from google.cloud.tpu import gapic_version as package_version + +__version__ = package_version.__version__ + + +from google.cloud.tpu_v2.services.tpu.client import TpuClient +from google.cloud.tpu_v2.services.tpu.async_client import TpuAsyncClient + +from google.cloud.tpu_v2.types.cloud_tpu import AcceleratorConfig +from google.cloud.tpu_v2.types.cloud_tpu import AcceleratorType +from google.cloud.tpu_v2.types.cloud_tpu import AccessConfig +from google.cloud.tpu_v2.types.cloud_tpu import AttachedDisk +from google.cloud.tpu_v2.types.cloud_tpu import CreateNodeRequest +from google.cloud.tpu_v2.types.cloud_tpu import DeleteNodeRequest +from google.cloud.tpu_v2.types.cloud_tpu import GenerateServiceIdentityRequest +from google.cloud.tpu_v2.types.cloud_tpu import GenerateServiceIdentityResponse +from google.cloud.tpu_v2.types.cloud_tpu import GetAcceleratorTypeRequest +from google.cloud.tpu_v2.types.cloud_tpu import GetGuestAttributesRequest +from google.cloud.tpu_v2.types.cloud_tpu import GetGuestAttributesResponse +from google.cloud.tpu_v2.types.cloud_tpu import GetNodeRequest +from google.cloud.tpu_v2.types.cloud_tpu import GetRuntimeVersionRequest +from google.cloud.tpu_v2.types.cloud_tpu import GuestAttributes +from google.cloud.tpu_v2.types.cloud_tpu import GuestAttributesEntry +from google.cloud.tpu_v2.types.cloud_tpu import GuestAttributesValue +from google.cloud.tpu_v2.types.cloud_tpu import ListAcceleratorTypesRequest +from google.cloud.tpu_v2.types.cloud_tpu import ListAcceleratorTypesResponse +from google.cloud.tpu_v2.types.cloud_tpu import ListNodesRequest +from google.cloud.tpu_v2.types.cloud_tpu import ListNodesResponse +from google.cloud.tpu_v2.types.cloud_tpu import ListRuntimeVersionsRequest +from google.cloud.tpu_v2.types.cloud_tpu import ListRuntimeVersionsResponse +from google.cloud.tpu_v2.types.cloud_tpu import NetworkConfig +from google.cloud.tpu_v2.types.cloud_tpu import NetworkEndpoint +from google.cloud.tpu_v2.types.cloud_tpu import Node +from google.cloud.tpu_v2.types.cloud_tpu import OperationMetadata +from google.cloud.tpu_v2.types.cloud_tpu import RuntimeVersion +from google.cloud.tpu_v2.types.cloud_tpu import SchedulingConfig +from google.cloud.tpu_v2.types.cloud_tpu import ServiceAccount +from google.cloud.tpu_v2.types.cloud_tpu import ServiceIdentity +from google.cloud.tpu_v2.types.cloud_tpu import ShieldedInstanceConfig +from google.cloud.tpu_v2.types.cloud_tpu import StartNodeRequest +from google.cloud.tpu_v2.types.cloud_tpu import StopNodeRequest +from google.cloud.tpu_v2.types.cloud_tpu import Symptom +from google.cloud.tpu_v2.types.cloud_tpu import UpdateNodeRequest + +__all__ = ('TpuClient', + 'TpuAsyncClient', + 'AcceleratorConfig', + 'AcceleratorType', + 'AccessConfig', + 'AttachedDisk', + 'CreateNodeRequest', + 'DeleteNodeRequest', + 'GenerateServiceIdentityRequest', + 'GenerateServiceIdentityResponse', + 'GetAcceleratorTypeRequest', + 'GetGuestAttributesRequest', + 'GetGuestAttributesResponse', + 'GetNodeRequest', + 'GetRuntimeVersionRequest', + 'GuestAttributes', + 'GuestAttributesEntry', + 'GuestAttributesValue', + 'ListAcceleratorTypesRequest', + 'ListAcceleratorTypesResponse', + 'ListNodesRequest', + 'ListNodesResponse', + 'ListRuntimeVersionsRequest', + 'ListRuntimeVersionsResponse', + 'NetworkConfig', + 'NetworkEndpoint', + 'Node', + 'OperationMetadata', + 'RuntimeVersion', + 'SchedulingConfig', + 'ServiceAccount', + 'ServiceIdentity', + 'ShieldedInstanceConfig', + 'StartNodeRequest', + 'StopNodeRequest', + 'Symptom', + 'UpdateNodeRequest', +) diff --git a/owl-bot-staging/v2/google/cloud/tpu/gapic_version.py b/owl-bot-staging/v2/google/cloud/tpu/gapic_version.py new file mode 100644 index 0000000..405b1ce --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/tpu/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +__version__ = "0.1.0" # {x-release-please-version} diff --git a/owl-bot-staging/v2/google/cloud/tpu/py.typed b/owl-bot-staging/v2/google/cloud/tpu/py.typed new file mode 100644 index 0000000..e122051 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/tpu/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-tpu package uses inline types. diff --git a/owl-bot-staging/v2/google/cloud/tpu_v2/__init__.py b/owl-bot-staging/v2/google/cloud/tpu_v2/__init__.py new file mode 100644 index 0000000..24dd5bc --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/tpu_v2/__init__.py @@ -0,0 +1,98 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from google.cloud.tpu_v2 import gapic_version as package_version + +__version__ = package_version.__version__ + + +from .services.tpu import TpuClient +from .services.tpu import TpuAsyncClient + +from .types.cloud_tpu import AcceleratorConfig +from .types.cloud_tpu import AcceleratorType +from .types.cloud_tpu import AccessConfig +from .types.cloud_tpu import AttachedDisk +from .types.cloud_tpu import CreateNodeRequest +from .types.cloud_tpu import DeleteNodeRequest +from .types.cloud_tpu import GenerateServiceIdentityRequest +from .types.cloud_tpu import GenerateServiceIdentityResponse +from .types.cloud_tpu import GetAcceleratorTypeRequest +from .types.cloud_tpu import GetGuestAttributesRequest +from .types.cloud_tpu import GetGuestAttributesResponse +from .types.cloud_tpu import GetNodeRequest +from .types.cloud_tpu import GetRuntimeVersionRequest +from .types.cloud_tpu import GuestAttributes +from .types.cloud_tpu import GuestAttributesEntry +from .types.cloud_tpu import GuestAttributesValue +from .types.cloud_tpu import ListAcceleratorTypesRequest +from .types.cloud_tpu import ListAcceleratorTypesResponse +from .types.cloud_tpu import ListNodesRequest +from .types.cloud_tpu import ListNodesResponse +from .types.cloud_tpu import ListRuntimeVersionsRequest +from .types.cloud_tpu import ListRuntimeVersionsResponse +from .types.cloud_tpu import NetworkConfig +from .types.cloud_tpu import NetworkEndpoint +from .types.cloud_tpu import Node +from .types.cloud_tpu import OperationMetadata +from .types.cloud_tpu import RuntimeVersion +from .types.cloud_tpu import SchedulingConfig +from .types.cloud_tpu import ServiceAccount +from .types.cloud_tpu import ServiceIdentity +from .types.cloud_tpu import ShieldedInstanceConfig +from .types.cloud_tpu import StartNodeRequest +from .types.cloud_tpu import StopNodeRequest +from .types.cloud_tpu import Symptom +from .types.cloud_tpu import UpdateNodeRequest + +__all__ = ( + 'TpuAsyncClient', +'AcceleratorConfig', +'AcceleratorType', +'AccessConfig', +'AttachedDisk', +'CreateNodeRequest', +'DeleteNodeRequest', +'GenerateServiceIdentityRequest', +'GenerateServiceIdentityResponse', +'GetAcceleratorTypeRequest', +'GetGuestAttributesRequest', +'GetGuestAttributesResponse', +'GetNodeRequest', +'GetRuntimeVersionRequest', +'GuestAttributes', +'GuestAttributesEntry', +'GuestAttributesValue', +'ListAcceleratorTypesRequest', +'ListAcceleratorTypesResponse', +'ListNodesRequest', +'ListNodesResponse', +'ListRuntimeVersionsRequest', +'ListRuntimeVersionsResponse', +'NetworkConfig', +'NetworkEndpoint', +'Node', +'OperationMetadata', +'RuntimeVersion', +'SchedulingConfig', +'ServiceAccount', +'ServiceIdentity', +'ShieldedInstanceConfig', +'StartNodeRequest', +'StopNodeRequest', +'Symptom', +'TpuClient', +'UpdateNodeRequest', +) diff --git a/owl-bot-staging/v2/google/cloud/tpu_v2/gapic_metadata.json b/owl-bot-staging/v2/google/cloud/tpu_v2/gapic_metadata.json new file mode 100644 index 0000000..fd9a15f --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/tpu_v2/gapic_metadata.json @@ -0,0 +1,223 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.cloud.tpu_v2", + "protoPackage": "google.cloud.tpu.v2", + "schema": "1.0", + "services": { + "Tpu": { + "clients": { + "grpc": { + "libraryClient": "TpuClient", + "rpcs": { + "CreateNode": { + "methods": [ + "create_node" + ] + }, + "DeleteNode": { + "methods": [ + "delete_node" + ] + }, + "GenerateServiceIdentity": { + "methods": [ + "generate_service_identity" + ] + }, + "GetAcceleratorType": { + "methods": [ + "get_accelerator_type" + ] + }, + "GetGuestAttributes": { + "methods": [ + "get_guest_attributes" + ] + }, + "GetNode": { + "methods": [ + "get_node" + ] + }, + "GetRuntimeVersion": { + "methods": [ + "get_runtime_version" + ] + }, + "ListAcceleratorTypes": { + "methods": [ + "list_accelerator_types" + ] + }, + "ListNodes": { + "methods": [ + "list_nodes" + ] + }, + "ListRuntimeVersions": { + "methods": [ + "list_runtime_versions" + ] + }, + "StartNode": { + "methods": [ + "start_node" + ] + }, + "StopNode": { + "methods": [ + "stop_node" + ] + }, + "UpdateNode": { + "methods": [ + "update_node" + ] + } + } + }, + "grpc-async": { + "libraryClient": "TpuAsyncClient", + "rpcs": { + "CreateNode": { + "methods": [ + "create_node" + ] + }, + "DeleteNode": { + "methods": [ + "delete_node" + ] + }, + "GenerateServiceIdentity": { + "methods": [ + "generate_service_identity" + ] + }, + "GetAcceleratorType": { + "methods": [ + "get_accelerator_type" + ] + }, + "GetGuestAttributes": { + "methods": [ + "get_guest_attributes" + ] + }, + "GetNode": { + "methods": [ + "get_node" + ] + }, + "GetRuntimeVersion": { + "methods": [ + "get_runtime_version" + ] + }, + "ListAcceleratorTypes": { + "methods": [ + "list_accelerator_types" + ] + }, + "ListNodes": { + "methods": [ + "list_nodes" + ] + }, + "ListRuntimeVersions": { + "methods": [ + "list_runtime_versions" + ] + }, + "StartNode": { + "methods": [ + "start_node" + ] + }, + "StopNode": { + "methods": [ + "stop_node" + ] + }, + "UpdateNode": { + "methods": [ + "update_node" + ] + } + } + }, + "rest": { + "libraryClient": "TpuClient", + "rpcs": { + "CreateNode": { + "methods": [ + "create_node" + ] + }, + "DeleteNode": { + "methods": [ + "delete_node" + ] + }, + "GenerateServiceIdentity": { + "methods": [ + "generate_service_identity" + ] + }, + "GetAcceleratorType": { + "methods": [ + "get_accelerator_type" + ] + }, + "GetGuestAttributes": { + "methods": [ + "get_guest_attributes" + ] + }, + "GetNode": { + "methods": [ + "get_node" + ] + }, + "GetRuntimeVersion": { + "methods": [ + "get_runtime_version" + ] + }, + "ListAcceleratorTypes": { + "methods": [ + "list_accelerator_types" + ] + }, + "ListNodes": { + "methods": [ + "list_nodes" + ] + }, + "ListRuntimeVersions": { + "methods": [ + "list_runtime_versions" + ] + }, + "StartNode": { + "methods": [ + "start_node" + ] + }, + "StopNode": { + "methods": [ + "stop_node" + ] + }, + "UpdateNode": { + "methods": [ + "update_node" + ] + } + } + } + } + } + } +} diff --git a/owl-bot-staging/v2/google/cloud/tpu_v2/gapic_version.py b/owl-bot-staging/v2/google/cloud/tpu_v2/gapic_version.py new file mode 100644 index 0000000..405b1ce --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/tpu_v2/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +__version__ = "0.1.0" # {x-release-please-version} diff --git a/owl-bot-staging/v2/google/cloud/tpu_v2/py.typed b/owl-bot-staging/v2/google/cloud/tpu_v2/py.typed new file mode 100644 index 0000000..e122051 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/tpu_v2/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-tpu package uses inline types. diff --git a/owl-bot-staging/v2/google/cloud/tpu_v2/services/__init__.py b/owl-bot-staging/v2/google/cloud/tpu_v2/services/__init__.py new file mode 100644 index 0000000..e8e1c38 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/tpu_v2/services/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/__init__.py b/owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/__init__.py new file mode 100644 index 0000000..23e6818 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .client import TpuClient +from .async_client import TpuAsyncClient + +__all__ = ( + 'TpuClient', + 'TpuAsyncClient', +) diff --git a/owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/async_client.py b/owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/async_client.py new file mode 100644 index 0000000..30a00c2 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/async_client.py @@ -0,0 +1,1885 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import functools +import re +from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union + +from google.cloud.tpu_v2 import gapic_version as package_version + +from google.api_core.client_options import ClientOptions +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + +from google.api_core import operation # type: ignore +from google.api_core import operation_async # type: ignore +from google.cloud.location import locations_pb2 # type: ignore +from google.cloud.tpu_v2.services.tpu import pagers +from google.cloud.tpu_v2.types import cloud_tpu +from google.longrunning import operations_pb2 +from google.protobuf import empty_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from .transports.base import TpuTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import TpuGrpcAsyncIOTransport +from .client import TpuClient + + +class TpuAsyncClient: + """Manages TPU nodes and other resources + TPU API v2 + """ + + _client: TpuClient + + DEFAULT_ENDPOINT = TpuClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = TpuClient.DEFAULT_MTLS_ENDPOINT + + accelerator_type_path = staticmethod(TpuClient.accelerator_type_path) + parse_accelerator_type_path = staticmethod(TpuClient.parse_accelerator_type_path) + node_path = staticmethod(TpuClient.node_path) + parse_node_path = staticmethod(TpuClient.parse_node_path) + runtime_version_path = staticmethod(TpuClient.runtime_version_path) + parse_runtime_version_path = staticmethod(TpuClient.parse_runtime_version_path) + common_billing_account_path = staticmethod(TpuClient.common_billing_account_path) + parse_common_billing_account_path = staticmethod(TpuClient.parse_common_billing_account_path) + common_folder_path = staticmethod(TpuClient.common_folder_path) + parse_common_folder_path = staticmethod(TpuClient.parse_common_folder_path) + common_organization_path = staticmethod(TpuClient.common_organization_path) + parse_common_organization_path = staticmethod(TpuClient.parse_common_organization_path) + common_project_path = staticmethod(TpuClient.common_project_path) + parse_common_project_path = staticmethod(TpuClient.parse_common_project_path) + common_location_path = staticmethod(TpuClient.common_location_path) + parse_common_location_path = staticmethod(TpuClient.parse_common_location_path) + + @classmethod + def from_service_account_info(cls, info: dict, *args, **kwargs): + """Creates an instance of this client using the provided credentials + info. + + Args: + info (dict): The service account private key info. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + TpuAsyncClient: The constructed client. + """ + return TpuClient.from_service_account_info.__func__(TpuAsyncClient, info, *args, **kwargs) # type: ignore + + @classmethod + def from_service_account_file(cls, filename: str, *args, **kwargs): + """Creates an instance of this client using the provided credentials + file. + + Args: + filename (str): The path to the service account private key json + file. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + TpuAsyncClient: The constructed client. + """ + return TpuClient.from_service_account_file.__func__(TpuAsyncClient, filename, *args, **kwargs) # type: ignore + + from_service_account_json = from_service_account_file + + @classmethod + def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[ClientOptions] = None): + """Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variable is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + return TpuClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore + + @property + def transport(self) -> TpuTransport: + """Returns the transport used by the client instance. + + Returns: + TpuTransport: The transport used by the client instance. + """ + return self._client.transport + + get_transport_class = functools.partial(type(TpuClient).get_transport_class, type(TpuClient)) + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Union[str, TpuTransport] = "grpc_asyncio", + client_options: Optional[ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the tpu client. + + Args: + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + transport (Union[str, ~.TpuTransport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (ClientOptions): Custom options for the client. It + won't take effect if a ``transport`` instance is provided. + (1) The ``api_endpoint`` property can be used to override the + default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT + environment variable can also be used to override the endpoint: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto switch to the + default mTLS endpoint if client certificate is present, this is + the default value). However, the ``api_endpoint`` property takes + precedence if provided. + (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide client certificate for mutual TLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + """ + self._client = TpuClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + + ) + + async def list_nodes(self, + request: Optional[Union[cloud_tpu.ListNodesRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListNodesAsyncPager: + r"""Lists nodes. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2 + + async def sample_list_nodes(): + # Create a client + client = tpu_v2.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2.ListNodesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_nodes(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v2.types.ListNodesRequest, dict]]): + The request object. Request for + [ListNodes][google.cloud.tpu.v2.Tpu.ListNodes]. + parent (:class:`str`): + Required. The parent resource name. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2.services.tpu.pagers.ListNodesAsyncPager: + Response for + [ListNodes][google.cloud.tpu.v2.Tpu.ListNodes]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_tpu.ListNodesRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_nodes, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListNodesAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_node(self, + request: Optional[Union[cloud_tpu.GetNodeRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_tpu.Node: + r"""Gets the details of a node. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2 + + async def sample_get_node(): + # Create a client + client = tpu_v2.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2.GetNodeRequest( + name="name_value", + ) + + # Make the request + response = await client.get_node(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v2.types.GetNodeRequest, dict]]): + The request object. Request for [GetNode][google.cloud.tpu.v2.Tpu.GetNode]. + name (:class:`str`): + Required. The resource name. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2.types.Node: + A TPU instance. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_tpu.GetNodeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.get_node, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def create_node(self, + request: Optional[Union[cloud_tpu.CreateNodeRequest, dict]] = None, + *, + parent: Optional[str] = None, + node: Optional[cloud_tpu.Node] = None, + node_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Creates a node. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2 + + async def sample_create_node(): + # Create a client + client = tpu_v2.TpuAsyncClient() + + # Initialize request argument(s) + node = tpu_v2.Node() + node.accelerator_type = "accelerator_type_value" + node.runtime_version = "runtime_version_value" + + request = tpu_v2.CreateNodeRequest( + parent="parent_value", + node=node, + ) + + # Make the request + operation = client.create_node(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v2.types.CreateNodeRequest, dict]]): + The request object. Request for + [CreateNode][google.cloud.tpu.v2.Tpu.CreateNode]. + parent (:class:`str`): + Required. The parent resource name. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + node (:class:`google.cloud.tpu_v2.types.Node`): + Required. The node. + This corresponds to the ``node`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + node_id (:class:`str`): + The unqualified resource name. + This corresponds to the ``node_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.tpu_v2.types.Node` A TPU instance. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, node, node_id]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_tpu.CreateNodeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if node is not None: + request.node = node + if node_id is not None: + request.node_id = node_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.create_node, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_tpu.Node, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + async def delete_node(self, + request: Optional[Union[cloud_tpu.DeleteNodeRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Deletes a node. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2 + + async def sample_delete_node(): + # Create a client + client = tpu_v2.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2.DeleteNodeRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_node(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v2.types.DeleteNodeRequest, dict]]): + The request object. Request for + [DeleteNode][google.cloud.tpu.v2.Tpu.DeleteNode]. + name (:class:`str`): + Required. The resource name. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to + use it as the request or the response type of an API + method. For instance: + + service Foo { + rpc Bar(google.protobuf.Empty) returns + (google.protobuf.Empty); + + } + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_tpu.DeleteNodeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.delete_node, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + empty_pb2.Empty, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + async def stop_node(self, + request: Optional[Union[cloud_tpu.StopNodeRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Stops a node. This operation is only available with + single TPU nodes. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2 + + async def sample_stop_node(): + # Create a client + client = tpu_v2.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2.StopNodeRequest( + name="name_value", + ) + + # Make the request + operation = client.stop_node(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v2.types.StopNodeRequest, dict]]): + The request object. Request for + [StopNode][google.cloud.tpu.v2.Tpu.StopNode]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.tpu_v2.types.Node` A TPU instance. + + """ + # Create or coerce a protobuf request object. + request = cloud_tpu.StopNodeRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.stop_node, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_tpu.Node, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + async def start_node(self, + request: Optional[Union[cloud_tpu.StartNodeRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Starts a node. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2 + + async def sample_start_node(): + # Create a client + client = tpu_v2.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2.StartNodeRequest( + name="name_value", + ) + + # Make the request + operation = client.start_node(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v2.types.StartNodeRequest, dict]]): + The request object. Request for + [StartNode][google.cloud.tpu.v2.Tpu.StartNode]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.tpu_v2.types.Node` A TPU instance. + + """ + # Create or coerce a protobuf request object. + request = cloud_tpu.StartNodeRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.start_node, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_tpu.Node, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + async def update_node(self, + request: Optional[Union[cloud_tpu.UpdateNodeRequest, dict]] = None, + *, + node: Optional[cloud_tpu.Node] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Updates the configurations of a node. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2 + + async def sample_update_node(): + # Create a client + client = tpu_v2.TpuAsyncClient() + + # Initialize request argument(s) + node = tpu_v2.Node() + node.accelerator_type = "accelerator_type_value" + node.runtime_version = "runtime_version_value" + + request = tpu_v2.UpdateNodeRequest( + node=node, + ) + + # Make the request + operation = client.update_node(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v2.types.UpdateNodeRequest, dict]]): + The request object. Request for + [UpdateNode][google.cloud.tpu.v2.Tpu.UpdateNode]. + node (:class:`google.cloud.tpu_v2.types.Node`): + Required. The node. Only fields specified in update_mask + are updated. + + This corresponds to the ``node`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): + Required. Mask of fields from [Node][Tpu.Node] to + update. Supported fields: [description, tags, labels, + metadata, network_config.enable_external_ips]. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.tpu_v2.types.Node` A TPU instance. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([node, update_mask]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_tpu.UpdateNodeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if node is not None: + request.node = node + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.update_node, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("node.name", request.node.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_tpu.Node, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + async def generate_service_identity(self, + request: Optional[Union[cloud_tpu.GenerateServiceIdentityRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_tpu.GenerateServiceIdentityResponse: + r"""Generates the Cloud TPU service identity for the + project. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2 + + async def sample_generate_service_identity(): + # Create a client + client = tpu_v2.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2.GenerateServiceIdentityRequest( + parent="parent_value", + ) + + # Make the request + response = await client.generate_service_identity(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v2.types.GenerateServiceIdentityRequest, dict]]): + The request object. Request for + [GenerateServiceIdentity][google.cloud.tpu.v2.Tpu.GenerateServiceIdentity]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2.types.GenerateServiceIdentityResponse: + Response for + [GenerateServiceIdentity][google.cloud.tpu.v2.Tpu.GenerateServiceIdentity]. + + """ + # Create or coerce a protobuf request object. + request = cloud_tpu.GenerateServiceIdentityRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.generate_service_identity, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def list_accelerator_types(self, + request: Optional[Union[cloud_tpu.ListAcceleratorTypesRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListAcceleratorTypesAsyncPager: + r"""Lists accelerator types supported by this API. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2 + + async def sample_list_accelerator_types(): + # Create a client + client = tpu_v2.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2.ListAcceleratorTypesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_accelerator_types(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v2.types.ListAcceleratorTypesRequest, dict]]): + The request object. Request for + [ListAcceleratorTypes][google.cloud.tpu.v2.Tpu.ListAcceleratorTypes]. + parent (:class:`str`): + Required. The parent resource name. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2.services.tpu.pagers.ListAcceleratorTypesAsyncPager: + Response for + [ListAcceleratorTypes][google.cloud.tpu.v2.Tpu.ListAcceleratorTypes]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_tpu.ListAcceleratorTypesRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_accelerator_types, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListAcceleratorTypesAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_accelerator_type(self, + request: Optional[Union[cloud_tpu.GetAcceleratorTypeRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_tpu.AcceleratorType: + r"""Gets AcceleratorType. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2 + + async def sample_get_accelerator_type(): + # Create a client + client = tpu_v2.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2.GetAcceleratorTypeRequest( + name="name_value", + ) + + # Make the request + response = await client.get_accelerator_type(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v2.types.GetAcceleratorTypeRequest, dict]]): + The request object. Request for + [GetAcceleratorType][google.cloud.tpu.v2.Tpu.GetAcceleratorType]. + name (:class:`str`): + Required. The resource name. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2.types.AcceleratorType: + A accelerator type that a Node can be + configured with. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_tpu.GetAcceleratorTypeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.get_accelerator_type, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def list_runtime_versions(self, + request: Optional[Union[cloud_tpu.ListRuntimeVersionsRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListRuntimeVersionsAsyncPager: + r"""Lists runtime versions supported by this API. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2 + + async def sample_list_runtime_versions(): + # Create a client + client = tpu_v2.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2.ListRuntimeVersionsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_runtime_versions(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v2.types.ListRuntimeVersionsRequest, dict]]): + The request object. Request for + [ListRuntimeVersions][google.cloud.tpu.v2.Tpu.ListRuntimeVersions]. + parent (:class:`str`): + Required. The parent resource name. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2.services.tpu.pagers.ListRuntimeVersionsAsyncPager: + Response for + [ListRuntimeVersions][google.cloud.tpu.v2.Tpu.ListRuntimeVersions]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_tpu.ListRuntimeVersionsRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_runtime_versions, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListRuntimeVersionsAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_runtime_version(self, + request: Optional[Union[cloud_tpu.GetRuntimeVersionRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_tpu.RuntimeVersion: + r"""Gets a runtime version. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2 + + async def sample_get_runtime_version(): + # Create a client + client = tpu_v2.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2.GetRuntimeVersionRequest( + name="name_value", + ) + + # Make the request + response = await client.get_runtime_version(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v2.types.GetRuntimeVersionRequest, dict]]): + The request object. Request for + [GetRuntimeVersion][google.cloud.tpu.v2.Tpu.GetRuntimeVersion]. + name (:class:`str`): + Required. The resource name. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2.types.RuntimeVersion: + A runtime version that a Node can be + configured with. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_tpu.GetRuntimeVersionRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.get_runtime_version, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_guest_attributes(self, + request: Optional[Union[cloud_tpu.GetGuestAttributesRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_tpu.GetGuestAttributesResponse: + r"""Retrieves the guest attributes for the node. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2 + + async def sample_get_guest_attributes(): + # Create a client + client = tpu_v2.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2.GetGuestAttributesRequest( + name="name_value", + ) + + # Make the request + response = await client.get_guest_attributes(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v2.types.GetGuestAttributesRequest, dict]]): + The request object. Request for + [GetGuestAttributes][google.cloud.tpu.v2.Tpu.GetGuestAttributes]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2.types.GetGuestAttributesResponse: + Response for + [GetGuestAttributes][google.cloud.tpu.v2.Tpu.GetGuestAttributes]. + + """ + # Create or coerce a protobuf request object. + request = cloud_tpu.GetGuestAttributesRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.get_guest_attributes, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def list_operations( + self, + request: Optional[operations_pb2.ListOperationsRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.ListOperationsResponse: + r"""Lists operations that match the specified filter in the request. + + Args: + request (:class:`~.operations_pb2.ListOperationsRequest`): + The request object. Request message for + `ListOperations` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.ListOperationsResponse: + Response message for ``ListOperations`` method. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.ListOperationsRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.list_operations, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + response = await rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + async def get_operation( + self, + request: Optional[operations_pb2.GetOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.Operation: + r"""Gets the latest state of a long-running operation. + + Args: + request (:class:`~.operations_pb2.GetOperationRequest`): + The request object. Request message for + `GetOperation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.Operation: + An ``Operation`` object. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.GetOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.get_operation, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + response = await rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + async def delete_operation( + self, + request: Optional[operations_pb2.DeleteOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes a long-running operation. + + This method indicates that the client is no longer interested + in the operation result. It does not cancel the operation. + If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + + Args: + request (:class:`~.operations_pb2.DeleteOperationRequest`): + The request object. Request message for + `DeleteOperation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + None + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.DeleteOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.delete_operation, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + async def cancel_operation( + self, + request: Optional[operations_pb2.CancelOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Starts asynchronous cancellation on a long-running operation. + + The server makes a best effort to cancel the operation, but success + is not guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + + Args: + request (:class:`~.operations_pb2.CancelOperationRequest`): + The request object. Request message for + `CancelOperation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + None + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.CancelOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.cancel_operation, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + async def get_location( + self, + request: Optional[locations_pb2.GetLocationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> locations_pb2.Location: + r"""Gets information about a location. + + Args: + request (:class:`~.location_pb2.GetLocationRequest`): + The request object. Request message for + `GetLocation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.location_pb2.Location: + Location object. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = locations_pb2.GetLocationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.get_location, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + response = await rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + async def list_locations( + self, + request: Optional[locations_pb2.ListLocationsRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> locations_pb2.ListLocationsResponse: + r"""Lists information about the supported locations for this service. + + Args: + request (:class:`~.location_pb2.ListLocationsRequest`): + The request object. Request message for + `ListLocations` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.location_pb2.ListLocationsResponse: + Response message for ``ListLocations`` method. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = locations_pb2.ListLocationsRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.list_locations, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + response = await rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + async def __aenter__(self): + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__all__ = ( + "TpuAsyncClient", +) diff --git a/owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/client.py b/owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/client.py new file mode 100644 index 0000000..9f11ec3 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/client.py @@ -0,0 +1,2106 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import os +import re +from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast + +from google.cloud.tpu_v2 import gapic_version as package_version + +from google.api_core import client_options as client_options_lib +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.oauth2 import service_account # type: ignore + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + +from google.api_core import operation # type: ignore +from google.api_core import operation_async # type: ignore +from google.cloud.location import locations_pb2 # type: ignore +from google.cloud.tpu_v2.services.tpu import pagers +from google.cloud.tpu_v2.types import cloud_tpu +from google.longrunning import operations_pb2 +from google.protobuf import empty_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from .transports.base import TpuTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import TpuGrpcTransport +from .transports.grpc_asyncio import TpuGrpcAsyncIOTransport +from .transports.rest import TpuRestTransport + + +class TpuClientMeta(type): + """Metaclass for the Tpu client. + + This provides class-level methods for building and retrieving + support objects (e.g. transport) without polluting the client instance + objects. + """ + _transport_registry = OrderedDict() # type: Dict[str, Type[TpuTransport]] + _transport_registry["grpc"] = TpuGrpcTransport + _transport_registry["grpc_asyncio"] = TpuGrpcAsyncIOTransport + _transport_registry["rest"] = TpuRestTransport + + def get_transport_class(cls, + label: Optional[str] = None, + ) -> Type[TpuTransport]: + """Returns an appropriate transport class. + + Args: + label: The name of the desired transport. If none is + provided, then the first transport in the registry is used. + + Returns: + The transport class to use. + """ + # If a specific transport is requested, return that one. + if label: + return cls._transport_registry[label] + + # No transport is requested; return the default (that is, the first one + # in the dictionary). + return next(iter(cls._transport_registry.values())) + + +class TpuClient(metaclass=TpuClientMeta): + """Manages TPU nodes and other resources + TPU API v2 + """ + + @staticmethod + def _get_default_mtls_endpoint(api_endpoint): + """Converts api endpoint to mTLS endpoint. + + Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to + "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. + Args: + api_endpoint (Optional[str]): the api endpoint to convert. + Returns: + str: converted mTLS api endpoint. + """ + if not api_endpoint: + return api_endpoint + + mtls_endpoint_re = re.compile( + r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" + ) + + m = mtls_endpoint_re.match(api_endpoint) + name, mtls, sandbox, googledomain = m.groups() + if mtls or not googledomain: + return api_endpoint + + if sandbox: + return api_endpoint.replace( + "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" + ) + + return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") + + DEFAULT_ENDPOINT = "tpu.googleapis.com" + DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore + DEFAULT_ENDPOINT + ) + + @classmethod + def from_service_account_info(cls, info: dict, *args, **kwargs): + """Creates an instance of this client using the provided credentials + info. + + Args: + info (dict): The service account private key info. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + TpuClient: The constructed client. + """ + credentials = service_account.Credentials.from_service_account_info(info) + kwargs["credentials"] = credentials + return cls(*args, **kwargs) + + @classmethod + def from_service_account_file(cls, filename: str, *args, **kwargs): + """Creates an instance of this client using the provided credentials + file. + + Args: + filename (str): The path to the service account private key json + file. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + TpuClient: The constructed client. + """ + credentials = service_account.Credentials.from_service_account_file( + filename) + kwargs["credentials"] = credentials + return cls(*args, **kwargs) + + from_service_account_json = from_service_account_file + + @property + def transport(self) -> TpuTransport: + """Returns the transport used by the client instance. + + Returns: + TpuTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def accelerator_type_path(project: str,location: str,accelerator_type: str,) -> str: + """Returns a fully-qualified accelerator_type string.""" + return "projects/{project}/locations/{location}/acceleratorTypes/{accelerator_type}".format(project=project, location=location, accelerator_type=accelerator_type, ) + + @staticmethod + def parse_accelerator_type_path(path: str) -> Dict[str,str]: + """Parses a accelerator_type path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/acceleratorTypes/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def node_path(project: str,location: str,node: str,) -> str: + """Returns a fully-qualified node string.""" + return "projects/{project}/locations/{location}/nodes/{node}".format(project=project, location=location, node=node, ) + + @staticmethod + def parse_node_path(path: str) -> Dict[str,str]: + """Parses a node path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/nodes/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def runtime_version_path(project: str,location: str,runtime_version: str,) -> str: + """Returns a fully-qualified runtime_version string.""" + return "projects/{project}/locations/{location}/runtimeVersions/{runtime_version}".format(project=project, location=location, runtime_version=runtime_version, ) + + @staticmethod + def parse_runtime_version_path(path: str) -> Dict[str,str]: + """Parses a runtime_version path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/runtimeVersions/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_billing_account_path(billing_account: str, ) -> str: + """Returns a fully-qualified billing_account string.""" + return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + + @staticmethod + def parse_common_billing_account_path(path: str) -> Dict[str,str]: + """Parse a billing_account path into its component segments.""" + m = re.match(r"^billingAccounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_folder_path(folder: str, ) -> str: + """Returns a fully-qualified folder string.""" + return "folders/{folder}".format(folder=folder, ) + + @staticmethod + def parse_common_folder_path(path: str) -> Dict[str,str]: + """Parse a folder path into its component segments.""" + m = re.match(r"^folders/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_organization_path(organization: str, ) -> str: + """Returns a fully-qualified organization string.""" + return "organizations/{organization}".format(organization=organization, ) + + @staticmethod + def parse_common_organization_path(path: str) -> Dict[str,str]: + """Parse a organization path into its component segments.""" + m = re.match(r"^organizations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_project_path(project: str, ) -> str: + """Returns a fully-qualified project string.""" + return "projects/{project}".format(project=project, ) + + @staticmethod + def parse_common_project_path(path: str) -> Dict[str,str]: + """Parse a project path into its component segments.""" + m = re.match(r"^projects/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_location_path(project: str, location: str, ) -> str: + """Returns a fully-qualified location string.""" + return "projects/{project}/locations/{location}".format(project=project, location=location, ) + + @staticmethod + def parse_common_location_path(path: str) -> Dict[str,str]: + """Parse a location path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @classmethod + def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_options_lib.ClientOptions] = None): + """Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variable is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + if client_options is None: + client_options = client_options_lib.ClientOptions() + use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") + use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_client_cert not in ("true", "false"): + raise ValueError("Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`") + if use_mtls_endpoint not in ("auto", "never", "always"): + raise MutualTLSChannelError("Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`") + + # Figure out the client cert source to use. + client_cert_source = None + if use_client_cert == "true": + if client_options.client_cert_source: + client_cert_source = client_options.client_cert_source + elif mtls.has_default_client_cert_source(): + client_cert_source = mtls.default_client_cert_source() + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): + api_endpoint = cls.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = cls.DEFAULT_ENDPOINT + + return api_endpoint, client_cert_source + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[Union[str, TpuTransport]] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the tpu client. + + Args: + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + transport (Union[str, TpuTransport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): Custom options for the + client. It won't take effect if a ``transport`` instance is provided. + (1) The ``api_endpoint`` property can be used to override the + default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT + environment variable can also be used to override the endpoint: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto switch to the + default mTLS endpoint if client certificate is present, this is + the default value). However, the ``api_endpoint`` property takes + precedence if provided. + (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide client certificate for mutual TLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + """ + if isinstance(client_options, dict): + client_options = client_options_lib.from_dict(client_options) + if client_options is None: + client_options = client_options_lib.ClientOptions() + client_options = cast(client_options_lib.ClientOptions, client_options) + + api_endpoint, client_cert_source_func = self.get_mtls_endpoint_and_cert_source(client_options) + + api_key_value = getattr(client_options, "api_key", None) + if api_key_value and credentials: + raise ValueError("client_options.api_key and credentials are mutually exclusive") + + # Save or instantiate the transport. + # Ordinarily, we provide the transport, but allowing a custom transport + # instance provides an extensibility point for unusual situations. + if isinstance(transport, TpuTransport): + # transport is a TpuTransport instance. + if credentials or client_options.credentials_file or api_key_value: + raise ValueError("When providing a transport instance, " + "provide its credentials directly.") + if client_options.scopes: + raise ValueError( + "When providing a transport instance, provide its scopes " + "directly." + ) + self._transport = transport + else: + import google.auth._default # type: ignore + + if api_key_value and hasattr(google.auth._default, "get_api_key_credentials"): + credentials = google.auth._default.get_api_key_credentials(api_key_value) + + Transport = type(self).get_transport_class(transport) + self._transport = Transport( + credentials=credentials, + credentials_file=client_options.credentials_file, + host=api_endpoint, + scopes=client_options.scopes, + client_cert_source_for_mtls=client_cert_source_func, + quota_project_id=client_options.quota_project_id, + client_info=client_info, + always_use_jwt_access=True, + api_audience=client_options.api_audience, + ) + + def list_nodes(self, + request: Optional[Union[cloud_tpu.ListNodesRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListNodesPager: + r"""Lists nodes. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2 + + def sample_list_nodes(): + # Create a client + client = tpu_v2.TpuClient() + + # Initialize request argument(s) + request = tpu_v2.ListNodesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_nodes(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.tpu_v2.types.ListNodesRequest, dict]): + The request object. Request for + [ListNodes][google.cloud.tpu.v2.Tpu.ListNodes]. + parent (str): + Required. The parent resource name. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2.services.tpu.pagers.ListNodesPager: + Response for + [ListNodes][google.cloud.tpu.v2.Tpu.ListNodes]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.ListNodesRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.ListNodesRequest): + request = cloud_tpu.ListNodesRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_nodes] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListNodesPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_node(self, + request: Optional[Union[cloud_tpu.GetNodeRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_tpu.Node: + r"""Gets the details of a node. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2 + + def sample_get_node(): + # Create a client + client = tpu_v2.TpuClient() + + # Initialize request argument(s) + request = tpu_v2.GetNodeRequest( + name="name_value", + ) + + # Make the request + response = client.get_node(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.tpu_v2.types.GetNodeRequest, dict]): + The request object. Request for [GetNode][google.cloud.tpu.v2.Tpu.GetNode]. + name (str): + Required. The resource name. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2.types.Node: + A TPU instance. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.GetNodeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.GetNodeRequest): + request = cloud_tpu.GetNodeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_node] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def create_node(self, + request: Optional[Union[cloud_tpu.CreateNodeRequest, dict]] = None, + *, + parent: Optional[str] = None, + node: Optional[cloud_tpu.Node] = None, + node_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Creates a node. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2 + + def sample_create_node(): + # Create a client + client = tpu_v2.TpuClient() + + # Initialize request argument(s) + node = tpu_v2.Node() + node.accelerator_type = "accelerator_type_value" + node.runtime_version = "runtime_version_value" + + request = tpu_v2.CreateNodeRequest( + parent="parent_value", + node=node, + ) + + # Make the request + operation = client.create_node(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.tpu_v2.types.CreateNodeRequest, dict]): + The request object. Request for + [CreateNode][google.cloud.tpu.v2.Tpu.CreateNode]. + parent (str): + Required. The parent resource name. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + node (google.cloud.tpu_v2.types.Node): + Required. The node. + This corresponds to the ``node`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + node_id (str): + The unqualified resource name. + This corresponds to the ``node_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.tpu_v2.types.Node` A TPU instance. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, node, node_id]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.CreateNodeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.CreateNodeRequest): + request = cloud_tpu.CreateNodeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if node is not None: + request.node = node + if node_id is not None: + request.node_id = node_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_node] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_tpu.Node, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + def delete_node(self, + request: Optional[Union[cloud_tpu.DeleteNodeRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Deletes a node. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2 + + def sample_delete_node(): + # Create a client + client = tpu_v2.TpuClient() + + # Initialize request argument(s) + request = tpu_v2.DeleteNodeRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_node(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.tpu_v2.types.DeleteNodeRequest, dict]): + The request object. Request for + [DeleteNode][google.cloud.tpu.v2.Tpu.DeleteNode]. + name (str): + Required. The resource name. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to + use it as the request or the response type of an API + method. For instance: + + service Foo { + rpc Bar(google.protobuf.Empty) returns + (google.protobuf.Empty); + + } + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.DeleteNodeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.DeleteNodeRequest): + request = cloud_tpu.DeleteNodeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.delete_node] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + empty_pb2.Empty, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + def stop_node(self, + request: Optional[Union[cloud_tpu.StopNodeRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Stops a node. This operation is only available with + single TPU nodes. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2 + + def sample_stop_node(): + # Create a client + client = tpu_v2.TpuClient() + + # Initialize request argument(s) + request = tpu_v2.StopNodeRequest( + name="name_value", + ) + + # Make the request + operation = client.stop_node(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.tpu_v2.types.StopNodeRequest, dict]): + The request object. Request for + [StopNode][google.cloud.tpu.v2.Tpu.StopNode]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.tpu_v2.types.Node` A TPU instance. + + """ + # Create or coerce a protobuf request object. + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.StopNodeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.StopNodeRequest): + request = cloud_tpu.StopNodeRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.stop_node] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_tpu.Node, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + def start_node(self, + request: Optional[Union[cloud_tpu.StartNodeRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Starts a node. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2 + + def sample_start_node(): + # Create a client + client = tpu_v2.TpuClient() + + # Initialize request argument(s) + request = tpu_v2.StartNodeRequest( + name="name_value", + ) + + # Make the request + operation = client.start_node(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.tpu_v2.types.StartNodeRequest, dict]): + The request object. Request for + [StartNode][google.cloud.tpu.v2.Tpu.StartNode]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.tpu_v2.types.Node` A TPU instance. + + """ + # Create or coerce a protobuf request object. + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.StartNodeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.StartNodeRequest): + request = cloud_tpu.StartNodeRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.start_node] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_tpu.Node, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + def update_node(self, + request: Optional[Union[cloud_tpu.UpdateNodeRequest, dict]] = None, + *, + node: Optional[cloud_tpu.Node] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Updates the configurations of a node. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2 + + def sample_update_node(): + # Create a client + client = tpu_v2.TpuClient() + + # Initialize request argument(s) + node = tpu_v2.Node() + node.accelerator_type = "accelerator_type_value" + node.runtime_version = "runtime_version_value" + + request = tpu_v2.UpdateNodeRequest( + node=node, + ) + + # Make the request + operation = client.update_node(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.tpu_v2.types.UpdateNodeRequest, dict]): + The request object. Request for + [UpdateNode][google.cloud.tpu.v2.Tpu.UpdateNode]. + node (google.cloud.tpu_v2.types.Node): + Required. The node. Only fields specified in update_mask + are updated. + + This corresponds to the ``node`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Required. Mask of fields from [Node][Tpu.Node] to + update. Supported fields: [description, tags, labels, + metadata, network_config.enable_external_ips]. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.tpu_v2.types.Node` A TPU instance. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([node, update_mask]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.UpdateNodeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.UpdateNodeRequest): + request = cloud_tpu.UpdateNodeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if node is not None: + request.node = node + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.update_node] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("node.name", request.node.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_tpu.Node, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + def generate_service_identity(self, + request: Optional[Union[cloud_tpu.GenerateServiceIdentityRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_tpu.GenerateServiceIdentityResponse: + r"""Generates the Cloud TPU service identity for the + project. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2 + + def sample_generate_service_identity(): + # Create a client + client = tpu_v2.TpuClient() + + # Initialize request argument(s) + request = tpu_v2.GenerateServiceIdentityRequest( + parent="parent_value", + ) + + # Make the request + response = client.generate_service_identity(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.tpu_v2.types.GenerateServiceIdentityRequest, dict]): + The request object. Request for + [GenerateServiceIdentity][google.cloud.tpu.v2.Tpu.GenerateServiceIdentity]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2.types.GenerateServiceIdentityResponse: + Response for + [GenerateServiceIdentity][google.cloud.tpu.v2.Tpu.GenerateServiceIdentity]. + + """ + # Create or coerce a protobuf request object. + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.GenerateServiceIdentityRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.GenerateServiceIdentityRequest): + request = cloud_tpu.GenerateServiceIdentityRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.generate_service_identity] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def list_accelerator_types(self, + request: Optional[Union[cloud_tpu.ListAcceleratorTypesRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListAcceleratorTypesPager: + r"""Lists accelerator types supported by this API. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2 + + def sample_list_accelerator_types(): + # Create a client + client = tpu_v2.TpuClient() + + # Initialize request argument(s) + request = tpu_v2.ListAcceleratorTypesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_accelerator_types(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.tpu_v2.types.ListAcceleratorTypesRequest, dict]): + The request object. Request for + [ListAcceleratorTypes][google.cloud.tpu.v2.Tpu.ListAcceleratorTypes]. + parent (str): + Required. The parent resource name. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2.services.tpu.pagers.ListAcceleratorTypesPager: + Response for + [ListAcceleratorTypes][google.cloud.tpu.v2.Tpu.ListAcceleratorTypes]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.ListAcceleratorTypesRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.ListAcceleratorTypesRequest): + request = cloud_tpu.ListAcceleratorTypesRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_accelerator_types] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListAcceleratorTypesPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_accelerator_type(self, + request: Optional[Union[cloud_tpu.GetAcceleratorTypeRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_tpu.AcceleratorType: + r"""Gets AcceleratorType. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2 + + def sample_get_accelerator_type(): + # Create a client + client = tpu_v2.TpuClient() + + # Initialize request argument(s) + request = tpu_v2.GetAcceleratorTypeRequest( + name="name_value", + ) + + # Make the request + response = client.get_accelerator_type(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.tpu_v2.types.GetAcceleratorTypeRequest, dict]): + The request object. Request for + [GetAcceleratorType][google.cloud.tpu.v2.Tpu.GetAcceleratorType]. + name (str): + Required. The resource name. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2.types.AcceleratorType: + A accelerator type that a Node can be + configured with. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.GetAcceleratorTypeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.GetAcceleratorTypeRequest): + request = cloud_tpu.GetAcceleratorTypeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_accelerator_type] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def list_runtime_versions(self, + request: Optional[Union[cloud_tpu.ListRuntimeVersionsRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListRuntimeVersionsPager: + r"""Lists runtime versions supported by this API. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2 + + def sample_list_runtime_versions(): + # Create a client + client = tpu_v2.TpuClient() + + # Initialize request argument(s) + request = tpu_v2.ListRuntimeVersionsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_runtime_versions(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.tpu_v2.types.ListRuntimeVersionsRequest, dict]): + The request object. Request for + [ListRuntimeVersions][google.cloud.tpu.v2.Tpu.ListRuntimeVersions]. + parent (str): + Required. The parent resource name. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2.services.tpu.pagers.ListRuntimeVersionsPager: + Response for + [ListRuntimeVersions][google.cloud.tpu.v2.Tpu.ListRuntimeVersions]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.ListRuntimeVersionsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.ListRuntimeVersionsRequest): + request = cloud_tpu.ListRuntimeVersionsRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_runtime_versions] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListRuntimeVersionsPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_runtime_version(self, + request: Optional[Union[cloud_tpu.GetRuntimeVersionRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_tpu.RuntimeVersion: + r"""Gets a runtime version. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2 + + def sample_get_runtime_version(): + # Create a client + client = tpu_v2.TpuClient() + + # Initialize request argument(s) + request = tpu_v2.GetRuntimeVersionRequest( + name="name_value", + ) + + # Make the request + response = client.get_runtime_version(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.tpu_v2.types.GetRuntimeVersionRequest, dict]): + The request object. Request for + [GetRuntimeVersion][google.cloud.tpu.v2.Tpu.GetRuntimeVersion]. + name (str): + Required. The resource name. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2.types.RuntimeVersion: + A runtime version that a Node can be + configured with. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.GetRuntimeVersionRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.GetRuntimeVersionRequest): + request = cloud_tpu.GetRuntimeVersionRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_runtime_version] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_guest_attributes(self, + request: Optional[Union[cloud_tpu.GetGuestAttributesRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_tpu.GetGuestAttributesResponse: + r"""Retrieves the guest attributes for the node. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2 + + def sample_get_guest_attributes(): + # Create a client + client = tpu_v2.TpuClient() + + # Initialize request argument(s) + request = tpu_v2.GetGuestAttributesRequest( + name="name_value", + ) + + # Make the request + response = client.get_guest_attributes(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.tpu_v2.types.GetGuestAttributesRequest, dict]): + The request object. Request for + [GetGuestAttributes][google.cloud.tpu.v2.Tpu.GetGuestAttributes]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2.types.GetGuestAttributesResponse: + Response for + [GetGuestAttributes][google.cloud.tpu.v2.Tpu.GetGuestAttributes]. + + """ + # Create or coerce a protobuf request object. + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.GetGuestAttributesRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.GetGuestAttributesRequest): + request = cloud_tpu.GetGuestAttributesRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_guest_attributes] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def __enter__(self) -> "TpuClient": + return self + + def __exit__(self, type, value, traceback): + """Releases underlying transport's resources. + + .. warning:: + ONLY use as a context manager if the transport is NOT shared + with other clients! Exiting the with block will CLOSE the transport + and may cause errors in other clients! + """ + self.transport.close() + + def list_operations( + self, + request: Optional[operations_pb2.ListOperationsRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.ListOperationsResponse: + r"""Lists operations that match the specified filter in the request. + + Args: + request (:class:`~.operations_pb2.ListOperationsRequest`): + The request object. Request message for + `ListOperations` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.ListOperationsResponse: + Response message for ``ListOperations`` method. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.ListOperationsRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.list_operations, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + response = rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + def get_operation( + self, + request: Optional[operations_pb2.GetOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.Operation: + r"""Gets the latest state of a long-running operation. + + Args: + request (:class:`~.operations_pb2.GetOperationRequest`): + The request object. Request message for + `GetOperation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.Operation: + An ``Operation`` object. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.GetOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.get_operation, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + response = rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + def delete_operation( + self, + request: Optional[operations_pb2.DeleteOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes a long-running operation. + + This method indicates that the client is no longer interested + in the operation result. It does not cancel the operation. + If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + + Args: + request (:class:`~.operations_pb2.DeleteOperationRequest`): + The request object. Request message for + `DeleteOperation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + None + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.DeleteOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.delete_operation, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + def cancel_operation( + self, + request: Optional[operations_pb2.CancelOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Starts asynchronous cancellation on a long-running operation. + + The server makes a best effort to cancel the operation, but success + is not guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + + Args: + request (:class:`~.operations_pb2.CancelOperationRequest`): + The request object. Request message for + `CancelOperation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + None + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.CancelOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.cancel_operation, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + def get_location( + self, + request: Optional[locations_pb2.GetLocationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> locations_pb2.Location: + r"""Gets information about a location. + + Args: + request (:class:`~.location_pb2.GetLocationRequest`): + The request object. Request message for + `GetLocation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.location_pb2.Location: + Location object. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = locations_pb2.GetLocationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.get_location, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + response = rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + def list_locations( + self, + request: Optional[locations_pb2.ListLocationsRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> locations_pb2.ListLocationsResponse: + r"""Lists information about the supported locations for this service. + + Args: + request (:class:`~.location_pb2.ListLocationsRequest`): + The request object. Request message for + `ListLocations` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.location_pb2.ListLocationsResponse: + Response message for ``ListLocations`` method. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = locations_pb2.ListLocationsRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.list_locations, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + response = rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__all__ = ( + "TpuClient", +) diff --git a/owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/pagers.py b/owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/pagers.py new file mode 100644 index 0000000..a2c2a0e --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/pagers.py @@ -0,0 +1,381 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from typing import Any, AsyncIterator, Awaitable, Callable, Sequence, Tuple, Optional, Iterator + +from google.cloud.tpu_v2.types import cloud_tpu + + +class ListNodesPager: + """A pager for iterating through ``list_nodes`` requests. + + This class thinly wraps an initial + :class:`google.cloud.tpu_v2.types.ListNodesResponse` object, and + provides an ``__iter__`` method to iterate through its + ``nodes`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListNodes`` requests and continue to iterate + through the ``nodes`` field on the + corresponding responses. + + All the usual :class:`google.cloud.tpu_v2.types.ListNodesResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., cloud_tpu.ListNodesResponse], + request: cloud_tpu.ListNodesRequest, + response: cloud_tpu.ListNodesResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.tpu_v2.types.ListNodesRequest): + The initial request object. + response (google.cloud.tpu_v2.types.ListNodesResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_tpu.ListNodesRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[cloud_tpu.ListNodesResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[cloud_tpu.Node]: + for page in self.pages: + yield from page.nodes + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListNodesAsyncPager: + """A pager for iterating through ``list_nodes`` requests. + + This class thinly wraps an initial + :class:`google.cloud.tpu_v2.types.ListNodesResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``nodes`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListNodes`` requests and continue to iterate + through the ``nodes`` field on the + corresponding responses. + + All the usual :class:`google.cloud.tpu_v2.types.ListNodesResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., Awaitable[cloud_tpu.ListNodesResponse]], + request: cloud_tpu.ListNodesRequest, + response: cloud_tpu.ListNodesResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.tpu_v2.types.ListNodesRequest): + The initial request object. + response (google.cloud.tpu_v2.types.ListNodesResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_tpu.ListNodesRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[cloud_tpu.ListNodesResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + def __aiter__(self) -> AsyncIterator[cloud_tpu.Node]: + async def async_generator(): + async for page in self.pages: + for response in page.nodes: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListAcceleratorTypesPager: + """A pager for iterating through ``list_accelerator_types`` requests. + + This class thinly wraps an initial + :class:`google.cloud.tpu_v2.types.ListAcceleratorTypesResponse` object, and + provides an ``__iter__`` method to iterate through its + ``accelerator_types`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListAcceleratorTypes`` requests and continue to iterate + through the ``accelerator_types`` field on the + corresponding responses. + + All the usual :class:`google.cloud.tpu_v2.types.ListAcceleratorTypesResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., cloud_tpu.ListAcceleratorTypesResponse], + request: cloud_tpu.ListAcceleratorTypesRequest, + response: cloud_tpu.ListAcceleratorTypesResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.tpu_v2.types.ListAcceleratorTypesRequest): + The initial request object. + response (google.cloud.tpu_v2.types.ListAcceleratorTypesResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_tpu.ListAcceleratorTypesRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[cloud_tpu.ListAcceleratorTypesResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[cloud_tpu.AcceleratorType]: + for page in self.pages: + yield from page.accelerator_types + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListAcceleratorTypesAsyncPager: + """A pager for iterating through ``list_accelerator_types`` requests. + + This class thinly wraps an initial + :class:`google.cloud.tpu_v2.types.ListAcceleratorTypesResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``accelerator_types`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListAcceleratorTypes`` requests and continue to iterate + through the ``accelerator_types`` field on the + corresponding responses. + + All the usual :class:`google.cloud.tpu_v2.types.ListAcceleratorTypesResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., Awaitable[cloud_tpu.ListAcceleratorTypesResponse]], + request: cloud_tpu.ListAcceleratorTypesRequest, + response: cloud_tpu.ListAcceleratorTypesResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.tpu_v2.types.ListAcceleratorTypesRequest): + The initial request object. + response (google.cloud.tpu_v2.types.ListAcceleratorTypesResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_tpu.ListAcceleratorTypesRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[cloud_tpu.ListAcceleratorTypesResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + def __aiter__(self) -> AsyncIterator[cloud_tpu.AcceleratorType]: + async def async_generator(): + async for page in self.pages: + for response in page.accelerator_types: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListRuntimeVersionsPager: + """A pager for iterating through ``list_runtime_versions`` requests. + + This class thinly wraps an initial + :class:`google.cloud.tpu_v2.types.ListRuntimeVersionsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``runtime_versions`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListRuntimeVersions`` requests and continue to iterate + through the ``runtime_versions`` field on the + corresponding responses. + + All the usual :class:`google.cloud.tpu_v2.types.ListRuntimeVersionsResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., cloud_tpu.ListRuntimeVersionsResponse], + request: cloud_tpu.ListRuntimeVersionsRequest, + response: cloud_tpu.ListRuntimeVersionsResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.tpu_v2.types.ListRuntimeVersionsRequest): + The initial request object. + response (google.cloud.tpu_v2.types.ListRuntimeVersionsResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_tpu.ListRuntimeVersionsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[cloud_tpu.ListRuntimeVersionsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[cloud_tpu.RuntimeVersion]: + for page in self.pages: + yield from page.runtime_versions + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListRuntimeVersionsAsyncPager: + """A pager for iterating through ``list_runtime_versions`` requests. + + This class thinly wraps an initial + :class:`google.cloud.tpu_v2.types.ListRuntimeVersionsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``runtime_versions`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListRuntimeVersions`` requests and continue to iterate + through the ``runtime_versions`` field on the + corresponding responses. + + All the usual :class:`google.cloud.tpu_v2.types.ListRuntimeVersionsResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., Awaitable[cloud_tpu.ListRuntimeVersionsResponse]], + request: cloud_tpu.ListRuntimeVersionsRequest, + response: cloud_tpu.ListRuntimeVersionsResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.tpu_v2.types.ListRuntimeVersionsRequest): + The initial request object. + response (google.cloud.tpu_v2.types.ListRuntimeVersionsResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_tpu.ListRuntimeVersionsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[cloud_tpu.ListRuntimeVersionsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + def __aiter__(self) -> AsyncIterator[cloud_tpu.RuntimeVersion]: + async def async_generator(): + async for page in self.pages: + for response in page.runtime_versions: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) diff --git a/owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/transports/__init__.py b/owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/transports/__init__.py new file mode 100644 index 0000000..2ce2e18 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/transports/__init__.py @@ -0,0 +1,38 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +from typing import Dict, Type + +from .base import TpuTransport +from .grpc import TpuGrpcTransport +from .grpc_asyncio import TpuGrpcAsyncIOTransport +from .rest import TpuRestTransport +from .rest import TpuRestInterceptor + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[TpuTransport]] +_transport_registry['grpc'] = TpuGrpcTransport +_transport_registry['grpc_asyncio'] = TpuGrpcAsyncIOTransport +_transport_registry['rest'] = TpuRestTransport + +__all__ = ( + 'TpuTransport', + 'TpuGrpcTransport', + 'TpuGrpcAsyncIOTransport', + 'TpuRestTransport', + 'TpuRestInterceptor', +) diff --git a/owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/transports/base.py b/owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/transports/base.py new file mode 100644 index 0000000..6490914 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/transports/base.py @@ -0,0 +1,377 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import abc +from typing import Awaitable, Callable, Dict, Optional, Sequence, Union + +from google.cloud.tpu_v2 import gapic_version as package_version + +import google.auth # type: ignore +import google.api_core +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.api_core import operations_v1 +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.location import locations_pb2 # type: ignore +from google.cloud.tpu_v2.types import cloud_tpu +from google.longrunning import operations_pb2 +from google.longrunning import operations_pb2 # type: ignore + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +class TpuTransport(abc.ABC): + """Abstract transport class for Tpu.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/cloud-platform', + ) + + DEFAULT_HOST: str = 'tpu.googleapis.com' + def __init__( + self, *, + host: str = DEFAULT_HOST, + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + **kwargs, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A list of scopes. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + """ + + scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES} + + # Save the scopes. + self._scopes = scopes + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") + + if credentials_file is not None: + credentials, _ = google.auth.load_credentials_from_file( + credentials_file, + **scopes_kwargs, + quota_project_id=quota_project_id + ) + elif credentials is None: + credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) + # Don't apply audience if the credentials file passed from user. + if hasattr(credentials, "with_gdch_audience"): + credentials = credentials.with_gdch_audience(api_audience if api_audience else host) + + # If the credentials are service account credentials, then always try to use self signed JWT. + if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): + credentials = credentials.with_always_use_jwt_access(True) + + # Save the credentials. + self._credentials = credentials + + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.list_nodes: gapic_v1.method.wrap_method( + self.list_nodes, + default_timeout=None, + client_info=client_info, + ), + self.get_node: gapic_v1.method.wrap_method( + self.get_node, + default_timeout=None, + client_info=client_info, + ), + self.create_node: gapic_v1.method.wrap_method( + self.create_node, + default_timeout=None, + client_info=client_info, + ), + self.delete_node: gapic_v1.method.wrap_method( + self.delete_node, + default_timeout=None, + client_info=client_info, + ), + self.stop_node: gapic_v1.method.wrap_method( + self.stop_node, + default_timeout=None, + client_info=client_info, + ), + self.start_node: gapic_v1.method.wrap_method( + self.start_node, + default_timeout=None, + client_info=client_info, + ), + self.update_node: gapic_v1.method.wrap_method( + self.update_node, + default_timeout=None, + client_info=client_info, + ), + self.generate_service_identity: gapic_v1.method.wrap_method( + self.generate_service_identity, + default_timeout=None, + client_info=client_info, + ), + self.list_accelerator_types: gapic_v1.method.wrap_method( + self.list_accelerator_types, + default_timeout=None, + client_info=client_info, + ), + self.get_accelerator_type: gapic_v1.method.wrap_method( + self.get_accelerator_type, + default_timeout=None, + client_info=client_info, + ), + self.list_runtime_versions: gapic_v1.method.wrap_method( + self.list_runtime_versions, + default_timeout=None, + client_info=client_info, + ), + self.get_runtime_version: gapic_v1.method.wrap_method( + self.get_runtime_version, + default_timeout=None, + client_info=client_info, + ), + self.get_guest_attributes: gapic_v1.method.wrap_method( + self.get_guest_attributes, + default_timeout=None, + client_info=client_info, + ), + } + + def close(self): + """Closes resources associated with the transport. + + .. warning:: + Only call this method if the transport is NOT shared + with other clients - this may cause errors in other clients! + """ + raise NotImplementedError() + + @property + def operations_client(self): + """Return the client designed to process long-running operations.""" + raise NotImplementedError() + + @property + def list_nodes(self) -> Callable[ + [cloud_tpu.ListNodesRequest], + Union[ + cloud_tpu.ListNodesResponse, + Awaitable[cloud_tpu.ListNodesResponse] + ]]: + raise NotImplementedError() + + @property + def get_node(self) -> Callable[ + [cloud_tpu.GetNodeRequest], + Union[ + cloud_tpu.Node, + Awaitable[cloud_tpu.Node] + ]]: + raise NotImplementedError() + + @property + def create_node(self) -> Callable[ + [cloud_tpu.CreateNodeRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def delete_node(self) -> Callable[ + [cloud_tpu.DeleteNodeRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def stop_node(self) -> Callable[ + [cloud_tpu.StopNodeRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def start_node(self) -> Callable[ + [cloud_tpu.StartNodeRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def update_node(self) -> Callable[ + [cloud_tpu.UpdateNodeRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def generate_service_identity(self) -> Callable[ + [cloud_tpu.GenerateServiceIdentityRequest], + Union[ + cloud_tpu.GenerateServiceIdentityResponse, + Awaitable[cloud_tpu.GenerateServiceIdentityResponse] + ]]: + raise NotImplementedError() + + @property + def list_accelerator_types(self) -> Callable[ + [cloud_tpu.ListAcceleratorTypesRequest], + Union[ + cloud_tpu.ListAcceleratorTypesResponse, + Awaitable[cloud_tpu.ListAcceleratorTypesResponse] + ]]: + raise NotImplementedError() + + @property + def get_accelerator_type(self) -> Callable[ + [cloud_tpu.GetAcceleratorTypeRequest], + Union[ + cloud_tpu.AcceleratorType, + Awaitable[cloud_tpu.AcceleratorType] + ]]: + raise NotImplementedError() + + @property + def list_runtime_versions(self) -> Callable[ + [cloud_tpu.ListRuntimeVersionsRequest], + Union[ + cloud_tpu.ListRuntimeVersionsResponse, + Awaitable[cloud_tpu.ListRuntimeVersionsResponse] + ]]: + raise NotImplementedError() + + @property + def get_runtime_version(self) -> Callable[ + [cloud_tpu.GetRuntimeVersionRequest], + Union[ + cloud_tpu.RuntimeVersion, + Awaitable[cloud_tpu.RuntimeVersion] + ]]: + raise NotImplementedError() + + @property + def get_guest_attributes(self) -> Callable[ + [cloud_tpu.GetGuestAttributesRequest], + Union[ + cloud_tpu.GetGuestAttributesResponse, + Awaitable[cloud_tpu.GetGuestAttributesResponse] + ]]: + raise NotImplementedError() + + @property + def list_operations( + self, + ) -> Callable[ + [operations_pb2.ListOperationsRequest], + Union[operations_pb2.ListOperationsResponse, Awaitable[operations_pb2.ListOperationsResponse]], + ]: + raise NotImplementedError() + + @property + def get_operation( + self, + ) -> Callable[ + [operations_pb2.GetOperationRequest], + Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]], + ]: + raise NotImplementedError() + + @property + def cancel_operation( + self, + ) -> Callable[ + [operations_pb2.CancelOperationRequest], + None, + ]: + raise NotImplementedError() + + @property + def delete_operation( + self, + ) -> Callable[ + [operations_pb2.DeleteOperationRequest], + None, + ]: + raise NotImplementedError() + + @property + def get_location(self, + ) -> Callable[ + [locations_pb2.GetLocationRequest], + Union[locations_pb2.Location, Awaitable[locations_pb2.Location]], + ]: + raise NotImplementedError() + + @property + def list_locations(self, + ) -> Callable[ + [locations_pb2.ListLocationsRequest], + Union[locations_pb2.ListLocationsResponse, Awaitable[locations_pb2.ListLocationsResponse]], + ]: + raise NotImplementedError() + + @property + def kind(self) -> str: + raise NotImplementedError() + + +__all__ = ( + 'TpuTransport', +) diff --git a/owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/transports/grpc.py b/owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/transports/grpc.py new file mode 100644 index 0000000..be68329 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/transports/grpc.py @@ -0,0 +1,708 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import grpc_helpers +from google.api_core import operations_v1 +from google.api_core import gapic_v1 +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore + +from google.cloud.location import locations_pb2 # type: ignore +from google.cloud.tpu_v2.types import cloud_tpu +from google.longrunning import operations_pb2 +from google.longrunning import operations_pb2 # type: ignore +from .base import TpuTransport, DEFAULT_CLIENT_INFO + + +class TpuGrpcTransport(TpuTransport): + """gRPC backend transport for Tpu. + + Manages TPU nodes and other resources + TPU API v2 + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + _stubs: Dict[str, Callable] + + def __init__(self, *, + host: str = 'tpu.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[grpc.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + channel (Optional[grpc.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + self._operations_client: Optional[operations_v1.OperationsClient] = None + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @classmethod + def create_channel(cls, + host: str = 'tpu.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> grpc.Channel: + """Create and return a gRPC channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + grpc.Channel: A gRPC channel object. + + Raises: + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service. + """ + return self._grpc_channel + + @property + def operations_client(self) -> operations_v1.OperationsClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Quick check: Only create a new client if we do not already have one. + if self._operations_client is None: + self._operations_client = operations_v1.OperationsClient( + self.grpc_channel + ) + + # Return the client from cache. + return self._operations_client + + @property + def list_nodes(self) -> Callable[ + [cloud_tpu.ListNodesRequest], + cloud_tpu.ListNodesResponse]: + r"""Return a callable for the list nodes method over gRPC. + + Lists nodes. + + Returns: + Callable[[~.ListNodesRequest], + ~.ListNodesResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_nodes' not in self._stubs: + self._stubs['list_nodes'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2.Tpu/ListNodes', + request_serializer=cloud_tpu.ListNodesRequest.serialize, + response_deserializer=cloud_tpu.ListNodesResponse.deserialize, + ) + return self._stubs['list_nodes'] + + @property + def get_node(self) -> Callable[ + [cloud_tpu.GetNodeRequest], + cloud_tpu.Node]: + r"""Return a callable for the get node method over gRPC. + + Gets the details of a node. + + Returns: + Callable[[~.GetNodeRequest], + ~.Node]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_node' not in self._stubs: + self._stubs['get_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2.Tpu/GetNode', + request_serializer=cloud_tpu.GetNodeRequest.serialize, + response_deserializer=cloud_tpu.Node.deserialize, + ) + return self._stubs['get_node'] + + @property + def create_node(self) -> Callable[ + [cloud_tpu.CreateNodeRequest], + operations_pb2.Operation]: + r"""Return a callable for the create node method over gRPC. + + Creates a node. + + Returns: + Callable[[~.CreateNodeRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'create_node' not in self._stubs: + self._stubs['create_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2.Tpu/CreateNode', + request_serializer=cloud_tpu.CreateNodeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['create_node'] + + @property + def delete_node(self) -> Callable[ + [cloud_tpu.DeleteNodeRequest], + operations_pb2.Operation]: + r"""Return a callable for the delete node method over gRPC. + + Deletes a node. + + Returns: + Callable[[~.DeleteNodeRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_node' not in self._stubs: + self._stubs['delete_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2.Tpu/DeleteNode', + request_serializer=cloud_tpu.DeleteNodeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['delete_node'] + + @property + def stop_node(self) -> Callable[ + [cloud_tpu.StopNodeRequest], + operations_pb2.Operation]: + r"""Return a callable for the stop node method over gRPC. + + Stops a node. This operation is only available with + single TPU nodes. + + Returns: + Callable[[~.StopNodeRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'stop_node' not in self._stubs: + self._stubs['stop_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2.Tpu/StopNode', + request_serializer=cloud_tpu.StopNodeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['stop_node'] + + @property + def start_node(self) -> Callable[ + [cloud_tpu.StartNodeRequest], + operations_pb2.Operation]: + r"""Return a callable for the start node method over gRPC. + + Starts a node. + + Returns: + Callable[[~.StartNodeRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'start_node' not in self._stubs: + self._stubs['start_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2.Tpu/StartNode', + request_serializer=cloud_tpu.StartNodeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['start_node'] + + @property + def update_node(self) -> Callable[ + [cloud_tpu.UpdateNodeRequest], + operations_pb2.Operation]: + r"""Return a callable for the update node method over gRPC. + + Updates the configurations of a node. + + Returns: + Callable[[~.UpdateNodeRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'update_node' not in self._stubs: + self._stubs['update_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2.Tpu/UpdateNode', + request_serializer=cloud_tpu.UpdateNodeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['update_node'] + + @property + def generate_service_identity(self) -> Callable[ + [cloud_tpu.GenerateServiceIdentityRequest], + cloud_tpu.GenerateServiceIdentityResponse]: + r"""Return a callable for the generate service identity method over gRPC. + + Generates the Cloud TPU service identity for the + project. + + Returns: + Callable[[~.GenerateServiceIdentityRequest], + ~.GenerateServiceIdentityResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'generate_service_identity' not in self._stubs: + self._stubs['generate_service_identity'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2.Tpu/GenerateServiceIdentity', + request_serializer=cloud_tpu.GenerateServiceIdentityRequest.serialize, + response_deserializer=cloud_tpu.GenerateServiceIdentityResponse.deserialize, + ) + return self._stubs['generate_service_identity'] + + @property + def list_accelerator_types(self) -> Callable[ + [cloud_tpu.ListAcceleratorTypesRequest], + cloud_tpu.ListAcceleratorTypesResponse]: + r"""Return a callable for the list accelerator types method over gRPC. + + Lists accelerator types supported by this API. + + Returns: + Callable[[~.ListAcceleratorTypesRequest], + ~.ListAcceleratorTypesResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_accelerator_types' not in self._stubs: + self._stubs['list_accelerator_types'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2.Tpu/ListAcceleratorTypes', + request_serializer=cloud_tpu.ListAcceleratorTypesRequest.serialize, + response_deserializer=cloud_tpu.ListAcceleratorTypesResponse.deserialize, + ) + return self._stubs['list_accelerator_types'] + + @property + def get_accelerator_type(self) -> Callable[ + [cloud_tpu.GetAcceleratorTypeRequest], + cloud_tpu.AcceleratorType]: + r"""Return a callable for the get accelerator type method over gRPC. + + Gets AcceleratorType. + + Returns: + Callable[[~.GetAcceleratorTypeRequest], + ~.AcceleratorType]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_accelerator_type' not in self._stubs: + self._stubs['get_accelerator_type'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2.Tpu/GetAcceleratorType', + request_serializer=cloud_tpu.GetAcceleratorTypeRequest.serialize, + response_deserializer=cloud_tpu.AcceleratorType.deserialize, + ) + return self._stubs['get_accelerator_type'] + + @property + def list_runtime_versions(self) -> Callable[ + [cloud_tpu.ListRuntimeVersionsRequest], + cloud_tpu.ListRuntimeVersionsResponse]: + r"""Return a callable for the list runtime versions method over gRPC. + + Lists runtime versions supported by this API. + + Returns: + Callable[[~.ListRuntimeVersionsRequest], + ~.ListRuntimeVersionsResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_runtime_versions' not in self._stubs: + self._stubs['list_runtime_versions'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2.Tpu/ListRuntimeVersions', + request_serializer=cloud_tpu.ListRuntimeVersionsRequest.serialize, + response_deserializer=cloud_tpu.ListRuntimeVersionsResponse.deserialize, + ) + return self._stubs['list_runtime_versions'] + + @property + def get_runtime_version(self) -> Callable[ + [cloud_tpu.GetRuntimeVersionRequest], + cloud_tpu.RuntimeVersion]: + r"""Return a callable for the get runtime version method over gRPC. + + Gets a runtime version. + + Returns: + Callable[[~.GetRuntimeVersionRequest], + ~.RuntimeVersion]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_runtime_version' not in self._stubs: + self._stubs['get_runtime_version'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2.Tpu/GetRuntimeVersion', + request_serializer=cloud_tpu.GetRuntimeVersionRequest.serialize, + response_deserializer=cloud_tpu.RuntimeVersion.deserialize, + ) + return self._stubs['get_runtime_version'] + + @property + def get_guest_attributes(self) -> Callable[ + [cloud_tpu.GetGuestAttributesRequest], + cloud_tpu.GetGuestAttributesResponse]: + r"""Return a callable for the get guest attributes method over gRPC. + + Retrieves the guest attributes for the node. + + Returns: + Callable[[~.GetGuestAttributesRequest], + ~.GetGuestAttributesResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_guest_attributes' not in self._stubs: + self._stubs['get_guest_attributes'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2.Tpu/GetGuestAttributes', + request_serializer=cloud_tpu.GetGuestAttributesRequest.serialize, + response_deserializer=cloud_tpu.GetGuestAttributesResponse.deserialize, + ) + return self._stubs['get_guest_attributes'] + + def close(self): + self.grpc_channel.close() + + @property + def delete_operation( + self, + ) -> Callable[[operations_pb2.DeleteOperationRequest], None]: + r"""Return a callable for the delete_operation method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "delete_operation" not in self._stubs: + self._stubs["delete_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/DeleteOperation", + request_serializer=operations_pb2.DeleteOperationRequest.SerializeToString, + response_deserializer=None, + ) + return self._stubs["delete_operation"] + + @property + def cancel_operation( + self, + ) -> Callable[[operations_pb2.CancelOperationRequest], None]: + r"""Return a callable for the cancel_operation method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "cancel_operation" not in self._stubs: + self._stubs["cancel_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/CancelOperation", + request_serializer=operations_pb2.CancelOperationRequest.SerializeToString, + response_deserializer=None, + ) + return self._stubs["cancel_operation"] + + @property + def get_operation( + self, + ) -> Callable[[operations_pb2.GetOperationRequest], operations_pb2.Operation]: + r"""Return a callable for the get_operation method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_operation" not in self._stubs: + self._stubs["get_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/GetOperation", + request_serializer=operations_pb2.GetOperationRequest.SerializeToString, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["get_operation"] + + @property + def list_operations( + self, + ) -> Callable[[operations_pb2.ListOperationsRequest], operations_pb2.ListOperationsResponse]: + r"""Return a callable for the list_operations method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_operations" not in self._stubs: + self._stubs["list_operations"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/ListOperations", + request_serializer=operations_pb2.ListOperationsRequest.SerializeToString, + response_deserializer=operations_pb2.ListOperationsResponse.FromString, + ) + return self._stubs["list_operations"] + + @property + def list_locations( + self, + ) -> Callable[[locations_pb2.ListLocationsRequest], locations_pb2.ListLocationsResponse]: + r"""Return a callable for the list locations method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_locations" not in self._stubs: + self._stubs["list_locations"] = self.grpc_channel.unary_unary( + "/google.cloud.location.Locations/ListLocations", + request_serializer=locations_pb2.ListLocationsRequest.SerializeToString, + response_deserializer=locations_pb2.ListLocationsResponse.FromString, + ) + return self._stubs["list_locations"] + + @property + def get_location( + self, + ) -> Callable[[locations_pb2.GetLocationRequest], locations_pb2.Location]: + r"""Return a callable for the list locations method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_location" not in self._stubs: + self._stubs["get_location"] = self.grpc_channel.unary_unary( + "/google.cloud.location.Locations/GetLocation", + request_serializer=locations_pb2.GetLocationRequest.SerializeToString, + response_deserializer=locations_pb2.Location.FromString, + ) + return self._stubs["get_location"] + + @property + def kind(self) -> str: + return "grpc" + + +__all__ = ( + 'TpuGrpcTransport', +) diff --git a/owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/transports/grpc_asyncio.py b/owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/transports/grpc_asyncio.py new file mode 100644 index 0000000..9f99222 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/transports/grpc_asyncio.py @@ -0,0 +1,707 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers_async +from google.api_core import operations_v1 +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore +from grpc.experimental import aio # type: ignore + +from google.cloud.location import locations_pb2 # type: ignore +from google.cloud.tpu_v2.types import cloud_tpu +from google.longrunning import operations_pb2 +from google.longrunning import operations_pb2 # type: ignore +from .base import TpuTransport, DEFAULT_CLIENT_INFO +from .grpc import TpuGrpcTransport + + +class TpuGrpcAsyncIOTransport(TpuTransport): + """gRPC AsyncIO backend transport for Tpu. + + Manages TPU nodes and other resources + TPU API v2 + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + + _grpc_channel: aio.Channel + _stubs: Dict[str, Callable] = {} + + @classmethod + def create_channel(cls, + host: str = 'tpu.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> aio.Channel: + """Create and return a gRPC AsyncIO channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + aio.Channel: A gRPC AsyncIO channel object. + """ + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + def __init__(self, *, + host: str = 'tpu.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[aio.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + channel (Optional[aio.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + self._operations_client: Optional[operations_v1.OperationsAsyncClient] = None + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @property + def grpc_channel(self) -> aio.Channel: + """Create the channel designed to connect to this service. + + This property caches on the instance; repeated calls return + the same channel. + """ + # Return the channel from cache. + return self._grpc_channel + + @property + def operations_client(self) -> operations_v1.OperationsAsyncClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Quick check: Only create a new client if we do not already have one. + if self._operations_client is None: + self._operations_client = operations_v1.OperationsAsyncClient( + self.grpc_channel + ) + + # Return the client from cache. + return self._operations_client + + @property + def list_nodes(self) -> Callable[ + [cloud_tpu.ListNodesRequest], + Awaitable[cloud_tpu.ListNodesResponse]]: + r"""Return a callable for the list nodes method over gRPC. + + Lists nodes. + + Returns: + Callable[[~.ListNodesRequest], + Awaitable[~.ListNodesResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_nodes' not in self._stubs: + self._stubs['list_nodes'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2.Tpu/ListNodes', + request_serializer=cloud_tpu.ListNodesRequest.serialize, + response_deserializer=cloud_tpu.ListNodesResponse.deserialize, + ) + return self._stubs['list_nodes'] + + @property + def get_node(self) -> Callable[ + [cloud_tpu.GetNodeRequest], + Awaitable[cloud_tpu.Node]]: + r"""Return a callable for the get node method over gRPC. + + Gets the details of a node. + + Returns: + Callable[[~.GetNodeRequest], + Awaitable[~.Node]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_node' not in self._stubs: + self._stubs['get_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2.Tpu/GetNode', + request_serializer=cloud_tpu.GetNodeRequest.serialize, + response_deserializer=cloud_tpu.Node.deserialize, + ) + return self._stubs['get_node'] + + @property + def create_node(self) -> Callable[ + [cloud_tpu.CreateNodeRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the create node method over gRPC. + + Creates a node. + + Returns: + Callable[[~.CreateNodeRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'create_node' not in self._stubs: + self._stubs['create_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2.Tpu/CreateNode', + request_serializer=cloud_tpu.CreateNodeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['create_node'] + + @property + def delete_node(self) -> Callable[ + [cloud_tpu.DeleteNodeRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the delete node method over gRPC. + + Deletes a node. + + Returns: + Callable[[~.DeleteNodeRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_node' not in self._stubs: + self._stubs['delete_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2.Tpu/DeleteNode', + request_serializer=cloud_tpu.DeleteNodeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['delete_node'] + + @property + def stop_node(self) -> Callable[ + [cloud_tpu.StopNodeRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the stop node method over gRPC. + + Stops a node. This operation is only available with + single TPU nodes. + + Returns: + Callable[[~.StopNodeRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'stop_node' not in self._stubs: + self._stubs['stop_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2.Tpu/StopNode', + request_serializer=cloud_tpu.StopNodeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['stop_node'] + + @property + def start_node(self) -> Callable[ + [cloud_tpu.StartNodeRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the start node method over gRPC. + + Starts a node. + + Returns: + Callable[[~.StartNodeRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'start_node' not in self._stubs: + self._stubs['start_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2.Tpu/StartNode', + request_serializer=cloud_tpu.StartNodeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['start_node'] + + @property + def update_node(self) -> Callable[ + [cloud_tpu.UpdateNodeRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the update node method over gRPC. + + Updates the configurations of a node. + + Returns: + Callable[[~.UpdateNodeRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'update_node' not in self._stubs: + self._stubs['update_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2.Tpu/UpdateNode', + request_serializer=cloud_tpu.UpdateNodeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['update_node'] + + @property + def generate_service_identity(self) -> Callable[ + [cloud_tpu.GenerateServiceIdentityRequest], + Awaitable[cloud_tpu.GenerateServiceIdentityResponse]]: + r"""Return a callable for the generate service identity method over gRPC. + + Generates the Cloud TPU service identity for the + project. + + Returns: + Callable[[~.GenerateServiceIdentityRequest], + Awaitable[~.GenerateServiceIdentityResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'generate_service_identity' not in self._stubs: + self._stubs['generate_service_identity'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2.Tpu/GenerateServiceIdentity', + request_serializer=cloud_tpu.GenerateServiceIdentityRequest.serialize, + response_deserializer=cloud_tpu.GenerateServiceIdentityResponse.deserialize, + ) + return self._stubs['generate_service_identity'] + + @property + def list_accelerator_types(self) -> Callable[ + [cloud_tpu.ListAcceleratorTypesRequest], + Awaitable[cloud_tpu.ListAcceleratorTypesResponse]]: + r"""Return a callable for the list accelerator types method over gRPC. + + Lists accelerator types supported by this API. + + Returns: + Callable[[~.ListAcceleratorTypesRequest], + Awaitable[~.ListAcceleratorTypesResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_accelerator_types' not in self._stubs: + self._stubs['list_accelerator_types'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2.Tpu/ListAcceleratorTypes', + request_serializer=cloud_tpu.ListAcceleratorTypesRequest.serialize, + response_deserializer=cloud_tpu.ListAcceleratorTypesResponse.deserialize, + ) + return self._stubs['list_accelerator_types'] + + @property + def get_accelerator_type(self) -> Callable[ + [cloud_tpu.GetAcceleratorTypeRequest], + Awaitable[cloud_tpu.AcceleratorType]]: + r"""Return a callable for the get accelerator type method over gRPC. + + Gets AcceleratorType. + + Returns: + Callable[[~.GetAcceleratorTypeRequest], + Awaitable[~.AcceleratorType]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_accelerator_type' not in self._stubs: + self._stubs['get_accelerator_type'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2.Tpu/GetAcceleratorType', + request_serializer=cloud_tpu.GetAcceleratorTypeRequest.serialize, + response_deserializer=cloud_tpu.AcceleratorType.deserialize, + ) + return self._stubs['get_accelerator_type'] + + @property + def list_runtime_versions(self) -> Callable[ + [cloud_tpu.ListRuntimeVersionsRequest], + Awaitable[cloud_tpu.ListRuntimeVersionsResponse]]: + r"""Return a callable for the list runtime versions method over gRPC. + + Lists runtime versions supported by this API. + + Returns: + Callable[[~.ListRuntimeVersionsRequest], + Awaitable[~.ListRuntimeVersionsResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_runtime_versions' not in self._stubs: + self._stubs['list_runtime_versions'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2.Tpu/ListRuntimeVersions', + request_serializer=cloud_tpu.ListRuntimeVersionsRequest.serialize, + response_deserializer=cloud_tpu.ListRuntimeVersionsResponse.deserialize, + ) + return self._stubs['list_runtime_versions'] + + @property + def get_runtime_version(self) -> Callable[ + [cloud_tpu.GetRuntimeVersionRequest], + Awaitable[cloud_tpu.RuntimeVersion]]: + r"""Return a callable for the get runtime version method over gRPC. + + Gets a runtime version. + + Returns: + Callable[[~.GetRuntimeVersionRequest], + Awaitable[~.RuntimeVersion]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_runtime_version' not in self._stubs: + self._stubs['get_runtime_version'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2.Tpu/GetRuntimeVersion', + request_serializer=cloud_tpu.GetRuntimeVersionRequest.serialize, + response_deserializer=cloud_tpu.RuntimeVersion.deserialize, + ) + return self._stubs['get_runtime_version'] + + @property + def get_guest_attributes(self) -> Callable[ + [cloud_tpu.GetGuestAttributesRequest], + Awaitable[cloud_tpu.GetGuestAttributesResponse]]: + r"""Return a callable for the get guest attributes method over gRPC. + + Retrieves the guest attributes for the node. + + Returns: + Callable[[~.GetGuestAttributesRequest], + Awaitable[~.GetGuestAttributesResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_guest_attributes' not in self._stubs: + self._stubs['get_guest_attributes'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2.Tpu/GetGuestAttributes', + request_serializer=cloud_tpu.GetGuestAttributesRequest.serialize, + response_deserializer=cloud_tpu.GetGuestAttributesResponse.deserialize, + ) + return self._stubs['get_guest_attributes'] + + def close(self): + return self.grpc_channel.close() + + @property + def delete_operation( + self, + ) -> Callable[[operations_pb2.DeleteOperationRequest], None]: + r"""Return a callable for the delete_operation method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "delete_operation" not in self._stubs: + self._stubs["delete_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/DeleteOperation", + request_serializer=operations_pb2.DeleteOperationRequest.SerializeToString, + response_deserializer=None, + ) + return self._stubs["delete_operation"] + + @property + def cancel_operation( + self, + ) -> Callable[[operations_pb2.CancelOperationRequest], None]: + r"""Return a callable for the cancel_operation method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "cancel_operation" not in self._stubs: + self._stubs["cancel_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/CancelOperation", + request_serializer=operations_pb2.CancelOperationRequest.SerializeToString, + response_deserializer=None, + ) + return self._stubs["cancel_operation"] + + @property + def get_operation( + self, + ) -> Callable[[operations_pb2.GetOperationRequest], operations_pb2.Operation]: + r"""Return a callable for the get_operation method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_operation" not in self._stubs: + self._stubs["get_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/GetOperation", + request_serializer=operations_pb2.GetOperationRequest.SerializeToString, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["get_operation"] + + @property + def list_operations( + self, + ) -> Callable[[operations_pb2.ListOperationsRequest], operations_pb2.ListOperationsResponse]: + r"""Return a callable for the list_operations method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_operations" not in self._stubs: + self._stubs["list_operations"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/ListOperations", + request_serializer=operations_pb2.ListOperationsRequest.SerializeToString, + response_deserializer=operations_pb2.ListOperationsResponse.FromString, + ) + return self._stubs["list_operations"] + + @property + def list_locations( + self, + ) -> Callable[[locations_pb2.ListLocationsRequest], locations_pb2.ListLocationsResponse]: + r"""Return a callable for the list locations method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_locations" not in self._stubs: + self._stubs["list_locations"] = self.grpc_channel.unary_unary( + "/google.cloud.location.Locations/ListLocations", + request_serializer=locations_pb2.ListLocationsRequest.SerializeToString, + response_deserializer=locations_pb2.ListLocationsResponse.FromString, + ) + return self._stubs["list_locations"] + + @property + def get_location( + self, + ) -> Callable[[locations_pb2.GetLocationRequest], locations_pb2.Location]: + r"""Return a callable for the list locations method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_location" not in self._stubs: + self._stubs["get_location"] = self.grpc_channel.unary_unary( + "/google.cloud.location.Locations/GetLocation", + request_serializer=locations_pb2.GetLocationRequest.SerializeToString, + response_deserializer=locations_pb2.Location.FromString, + ) + return self._stubs["get_location"] + + +__all__ = ( + 'TpuGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/transports/rest.py b/owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/transports/rest.py new file mode 100644 index 0000000..a87b142 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/tpu_v2/services/tpu/transports/rest.py @@ -0,0 +1,2247 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from google.auth.transport.requests import AuthorizedSession # type: ignore +import json # type: ignore +import grpc # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from google.api_core import operations_v1 +from google.cloud.location import locations_pb2 # type: ignore +from google.longrunning import operations_pb2 +from requests import __version__ as requests_version +import dataclasses +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + + +from google.cloud.tpu_v2.types import cloud_tpu +from google.longrunning import operations_pb2 # type: ignore + +from .base import TpuTransport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class TpuRestInterceptor: + """Interceptor for Tpu. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the TpuRestTransport. + + .. code-block:: python + class MyCustomTpuInterceptor(TpuRestInterceptor): + def pre_create_node(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_node(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_delete_node(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_delete_node(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_generate_service_identity(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_generate_service_identity(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_accelerator_type(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_accelerator_type(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_guest_attributes(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_guest_attributes(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_node(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_node(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_runtime_version(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_runtime_version(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_accelerator_types(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_accelerator_types(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_nodes(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_nodes(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_runtime_versions(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_runtime_versions(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_start_node(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_start_node(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_stop_node(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_stop_node(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_node(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_node(self, response): + logging.log(f"Received response: {response}") + return response + + transport = TpuRestTransport(interceptor=MyCustomTpuInterceptor()) + client = TpuClient(transport=transport) + + + """ + def pre_create_node(self, request: cloud_tpu.CreateNodeRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_tpu.CreateNodeRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for create_node + + Override in a subclass to manipulate the request or metadata + before they are sent to the Tpu server. + """ + return request, metadata + + def post_create_node(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for create_node + + Override in a subclass to manipulate the response + after it is returned by the Tpu server but before + it is returned to user code. + """ + return response + def pre_delete_node(self, request: cloud_tpu.DeleteNodeRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_tpu.DeleteNodeRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for delete_node + + Override in a subclass to manipulate the request or metadata + before they are sent to the Tpu server. + """ + return request, metadata + + def post_delete_node(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for delete_node + + Override in a subclass to manipulate the response + after it is returned by the Tpu server but before + it is returned to user code. + """ + return response + def pre_generate_service_identity(self, request: cloud_tpu.GenerateServiceIdentityRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_tpu.GenerateServiceIdentityRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for generate_service_identity + + Override in a subclass to manipulate the request or metadata + before they are sent to the Tpu server. + """ + return request, metadata + + def post_generate_service_identity(self, response: cloud_tpu.GenerateServiceIdentityResponse) -> cloud_tpu.GenerateServiceIdentityResponse: + """Post-rpc interceptor for generate_service_identity + + Override in a subclass to manipulate the response + after it is returned by the Tpu server but before + it is returned to user code. + """ + return response + def pre_get_accelerator_type(self, request: cloud_tpu.GetAcceleratorTypeRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_tpu.GetAcceleratorTypeRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_accelerator_type + + Override in a subclass to manipulate the request or metadata + before they are sent to the Tpu server. + """ + return request, metadata + + def post_get_accelerator_type(self, response: cloud_tpu.AcceleratorType) -> cloud_tpu.AcceleratorType: + """Post-rpc interceptor for get_accelerator_type + + Override in a subclass to manipulate the response + after it is returned by the Tpu server but before + it is returned to user code. + """ + return response + def pre_get_guest_attributes(self, request: cloud_tpu.GetGuestAttributesRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_tpu.GetGuestAttributesRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_guest_attributes + + Override in a subclass to manipulate the request or metadata + before they are sent to the Tpu server. + """ + return request, metadata + + def post_get_guest_attributes(self, response: cloud_tpu.GetGuestAttributesResponse) -> cloud_tpu.GetGuestAttributesResponse: + """Post-rpc interceptor for get_guest_attributes + + Override in a subclass to manipulate the response + after it is returned by the Tpu server but before + it is returned to user code. + """ + return response + def pre_get_node(self, request: cloud_tpu.GetNodeRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_tpu.GetNodeRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_node + + Override in a subclass to manipulate the request or metadata + before they are sent to the Tpu server. + """ + return request, metadata + + def post_get_node(self, response: cloud_tpu.Node) -> cloud_tpu.Node: + """Post-rpc interceptor for get_node + + Override in a subclass to manipulate the response + after it is returned by the Tpu server but before + it is returned to user code. + """ + return response + def pre_get_runtime_version(self, request: cloud_tpu.GetRuntimeVersionRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_tpu.GetRuntimeVersionRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_runtime_version + + Override in a subclass to manipulate the request or metadata + before they are sent to the Tpu server. + """ + return request, metadata + + def post_get_runtime_version(self, response: cloud_tpu.RuntimeVersion) -> cloud_tpu.RuntimeVersion: + """Post-rpc interceptor for get_runtime_version + + Override in a subclass to manipulate the response + after it is returned by the Tpu server but before + it is returned to user code. + """ + return response + def pre_list_accelerator_types(self, request: cloud_tpu.ListAcceleratorTypesRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_tpu.ListAcceleratorTypesRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_accelerator_types + + Override in a subclass to manipulate the request or metadata + before they are sent to the Tpu server. + """ + return request, metadata + + def post_list_accelerator_types(self, response: cloud_tpu.ListAcceleratorTypesResponse) -> cloud_tpu.ListAcceleratorTypesResponse: + """Post-rpc interceptor for list_accelerator_types + + Override in a subclass to manipulate the response + after it is returned by the Tpu server but before + it is returned to user code. + """ + return response + def pre_list_nodes(self, request: cloud_tpu.ListNodesRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_tpu.ListNodesRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_nodes + + Override in a subclass to manipulate the request or metadata + before they are sent to the Tpu server. + """ + return request, metadata + + def post_list_nodes(self, response: cloud_tpu.ListNodesResponse) -> cloud_tpu.ListNodesResponse: + """Post-rpc interceptor for list_nodes + + Override in a subclass to manipulate the response + after it is returned by the Tpu server but before + it is returned to user code. + """ + return response + def pre_list_runtime_versions(self, request: cloud_tpu.ListRuntimeVersionsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_tpu.ListRuntimeVersionsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_runtime_versions + + Override in a subclass to manipulate the request or metadata + before they are sent to the Tpu server. + """ + return request, metadata + + def post_list_runtime_versions(self, response: cloud_tpu.ListRuntimeVersionsResponse) -> cloud_tpu.ListRuntimeVersionsResponse: + """Post-rpc interceptor for list_runtime_versions + + Override in a subclass to manipulate the response + after it is returned by the Tpu server but before + it is returned to user code. + """ + return response + def pre_start_node(self, request: cloud_tpu.StartNodeRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_tpu.StartNodeRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for start_node + + Override in a subclass to manipulate the request or metadata + before they are sent to the Tpu server. + """ + return request, metadata + + def post_start_node(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for start_node + + Override in a subclass to manipulate the response + after it is returned by the Tpu server but before + it is returned to user code. + """ + return response + def pre_stop_node(self, request: cloud_tpu.StopNodeRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_tpu.StopNodeRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for stop_node + + Override in a subclass to manipulate the request or metadata + before they are sent to the Tpu server. + """ + return request, metadata + + def post_stop_node(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for stop_node + + Override in a subclass to manipulate the response + after it is returned by the Tpu server but before + it is returned to user code. + """ + return response + def pre_update_node(self, request: cloud_tpu.UpdateNodeRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[cloud_tpu.UpdateNodeRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for update_node + + Override in a subclass to manipulate the request or metadata + before they are sent to the Tpu server. + """ + return request, metadata + + def post_update_node(self, response: operations_pb2.Operation) -> operations_pb2.Operation: + """Post-rpc interceptor for update_node + + Override in a subclass to manipulate the response + after it is returned by the Tpu server but before + it is returned to user code. + """ + return response + + def pre_get_location( + self, request: locations_pb2.GetLocationRequest, metadata: Sequence[Tuple[str, str]] + ) -> Tuple[locations_pb2.GetLocationRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_location + + Override in a subclass to manipulate the request or metadata + before they are sent to the Tpu server. + """ + return request, metadata + + def post_get_location( + self, response: locations_pb2.Location + ) -> locations_pb2.Location: + """Post-rpc interceptor for get_location + + Override in a subclass to manipulate the response + after it is returned by the Tpu server but before + it is returned to user code. + """ + return response + def pre_list_locations( + self, request: locations_pb2.ListLocationsRequest, metadata: Sequence[Tuple[str, str]] + ) -> Tuple[locations_pb2.ListLocationsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_locations + + Override in a subclass to manipulate the request or metadata + before they are sent to the Tpu server. + """ + return request, metadata + + def post_list_locations( + self, response: locations_pb2.ListLocationsResponse + ) -> locations_pb2.ListLocationsResponse: + """Post-rpc interceptor for list_locations + + Override in a subclass to manipulate the response + after it is returned by the Tpu server but before + it is returned to user code. + """ + return response + def pre_cancel_operation( + self, request: operations_pb2.CancelOperationRequest, metadata: Sequence[Tuple[str, str]] + ) -> Tuple[operations_pb2.CancelOperationRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for cancel_operation + + Override in a subclass to manipulate the request or metadata + before they are sent to the Tpu server. + """ + return request, metadata + + def post_cancel_operation( + self, response: None + ) -> None: + """Post-rpc interceptor for cancel_operation + + Override in a subclass to manipulate the response + after it is returned by the Tpu server but before + it is returned to user code. + """ + return response + def pre_delete_operation( + self, request: operations_pb2.DeleteOperationRequest, metadata: Sequence[Tuple[str, str]] + ) -> Tuple[operations_pb2.DeleteOperationRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for delete_operation + + Override in a subclass to manipulate the request or metadata + before they are sent to the Tpu server. + """ + return request, metadata + + def post_delete_operation( + self, response: None + ) -> None: + """Post-rpc interceptor for delete_operation + + Override in a subclass to manipulate the response + after it is returned by the Tpu server but before + it is returned to user code. + """ + return response + def pre_get_operation( + self, request: operations_pb2.GetOperationRequest, metadata: Sequence[Tuple[str, str]] + ) -> Tuple[operations_pb2.GetOperationRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_operation + + Override in a subclass to manipulate the request or metadata + before they are sent to the Tpu server. + """ + return request, metadata + + def post_get_operation( + self, response: operations_pb2.Operation + ) -> operations_pb2.Operation: + """Post-rpc interceptor for get_operation + + Override in a subclass to manipulate the response + after it is returned by the Tpu server but before + it is returned to user code. + """ + return response + def pre_list_operations( + self, request: operations_pb2.ListOperationsRequest, metadata: Sequence[Tuple[str, str]] + ) -> Tuple[operations_pb2.ListOperationsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_operations + + Override in a subclass to manipulate the request or metadata + before they are sent to the Tpu server. + """ + return request, metadata + + def post_list_operations( + self, response: operations_pb2.ListOperationsResponse + ) -> operations_pb2.ListOperationsResponse: + """Post-rpc interceptor for list_operations + + Override in a subclass to manipulate the response + after it is returned by the Tpu server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class TpuRestStub: + _session: AuthorizedSession + _host: str + _interceptor: TpuRestInterceptor + + +class TpuRestTransport(TpuTransport): + """REST backend transport for Tpu. + + Manages TPU nodes and other resources + TPU API v2 + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends JSON representations of protocol buffers over HTTP/1.1 + + """ + + def __init__(self, *, + host: str = 'tpu.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[Callable[[ + ], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = 'https', + interceptor: Optional[TpuRestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST) + self._operations_client: Optional[operations_v1.AbstractOperationsClient] = None + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or TpuRestInterceptor() + self._prep_wrapped_messages(client_info) + + @property + def operations_client(self) -> operations_v1.AbstractOperationsClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Only create a new client if we do not already have one. + if self._operations_client is None: + http_options: Dict[str, List[Dict[str, str]]] = { + 'google.longrunning.Operations.CancelOperation': [ + { + 'method': 'post', + 'uri': '/v2/{name=projects/*/locations/*/operations/*}:cancel', + }, + ], + 'google.longrunning.Operations.DeleteOperation': [ + { + 'method': 'delete', + 'uri': '/v2/{name=projects/*/locations/*/operations/*}', + }, + ], + 'google.longrunning.Operations.GetOperation': [ + { + 'method': 'get', + 'uri': '/v2/{name=projects/*/locations/*/operations/*}', + }, + ], + 'google.longrunning.Operations.ListOperations': [ + { + 'method': 'get', + 'uri': '/v2/{name=projects/*/locations/*}/operations', + }, + ], + } + + rest_transport = operations_v1.OperationsRestTransport( + host=self._host, + # use the credentials which are saved + credentials=self._credentials, + scopes=self._scopes, + http_options=http_options, + path_prefix="v2") + + self._operations_client = operations_v1.AbstractOperationsClient(transport=rest_transport) + + # Return the client from cache. + return self._operations_client + + class _CreateNode(TpuRestStub): + def __hash__(self): + return hash("CreateNode") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_tpu.CreateNodeRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the create node method over HTTP. + + Args: + request (~.cloud_tpu.CreateNodeRequest): + The request object. Request for + [CreateNode][google.cloud.tpu.v2.Tpu.CreateNode]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v2/{parent=projects/*/locations/*}/nodes', + 'body': 'node', + }, + ] + request, metadata = self._interceptor.pre_create_node(request, metadata) + pb_request = cloud_tpu.CreateNodeRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_create_node(resp) + return resp + + class _DeleteNode(TpuRestStub): + def __hash__(self): + return hash("DeleteNode") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_tpu.DeleteNodeRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the delete node method over HTTP. + + Args: + request (~.cloud_tpu.DeleteNodeRequest): + The request object. Request for + [DeleteNode][google.cloud.tpu.v2.Tpu.DeleteNode]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'delete', + 'uri': '/v2/{name=projects/*/locations/*/nodes/*}', + }, + ] + request, metadata = self._interceptor.pre_delete_node(request, metadata) + pb_request = cloud_tpu.DeleteNodeRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_delete_node(resp) + return resp + + class _GenerateServiceIdentity(TpuRestStub): + def __hash__(self): + return hash("GenerateServiceIdentity") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_tpu.GenerateServiceIdentityRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> cloud_tpu.GenerateServiceIdentityResponse: + r"""Call the generate service identity method over HTTP. + + Args: + request (~.cloud_tpu.GenerateServiceIdentityRequest): + The request object. Request for + [GenerateServiceIdentity][google.cloud.tpu.v2.Tpu.GenerateServiceIdentity]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.cloud_tpu.GenerateServiceIdentityResponse: + Response for + [GenerateServiceIdentity][google.cloud.tpu.v2.Tpu.GenerateServiceIdentity]. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v2/{parent=projects/*/locations/*}:generateServiceIdentity', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_generate_service_identity(request, metadata) + pb_request = cloud_tpu.GenerateServiceIdentityRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = cloud_tpu.GenerateServiceIdentityResponse() + pb_resp = cloud_tpu.GenerateServiceIdentityResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_generate_service_identity(resp) + return resp + + class _GetAcceleratorType(TpuRestStub): + def __hash__(self): + return hash("GetAcceleratorType") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_tpu.GetAcceleratorTypeRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> cloud_tpu.AcceleratorType: + r"""Call the get accelerator type method over HTTP. + + Args: + request (~.cloud_tpu.GetAcceleratorTypeRequest): + The request object. Request for + [GetAcceleratorType][google.cloud.tpu.v2.Tpu.GetAcceleratorType]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.cloud_tpu.AcceleratorType: + A accelerator type that a Node can be + configured with. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/{name=projects/*/locations/*/acceleratorTypes/*}', + }, + ] + request, metadata = self._interceptor.pre_get_accelerator_type(request, metadata) + pb_request = cloud_tpu.GetAcceleratorTypeRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = cloud_tpu.AcceleratorType() + pb_resp = cloud_tpu.AcceleratorType.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_accelerator_type(resp) + return resp + + class _GetGuestAttributes(TpuRestStub): + def __hash__(self): + return hash("GetGuestAttributes") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_tpu.GetGuestAttributesRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> cloud_tpu.GetGuestAttributesResponse: + r"""Call the get guest attributes method over HTTP. + + Args: + request (~.cloud_tpu.GetGuestAttributesRequest): + The request object. Request for + [GetGuestAttributes][google.cloud.tpu.v2.Tpu.GetGuestAttributes]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.cloud_tpu.GetGuestAttributesResponse: + Response for + [GetGuestAttributes][google.cloud.tpu.v2.Tpu.GetGuestAttributes]. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v2/{name=projects/*/locations/*/nodes/*}:getGuestAttributes', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_get_guest_attributes(request, metadata) + pb_request = cloud_tpu.GetGuestAttributesRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = cloud_tpu.GetGuestAttributesResponse() + pb_resp = cloud_tpu.GetGuestAttributesResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_guest_attributes(resp) + return resp + + class _GetNode(TpuRestStub): + def __hash__(self): + return hash("GetNode") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_tpu.GetNodeRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> cloud_tpu.Node: + r"""Call the get node method over HTTP. + + Args: + request (~.cloud_tpu.GetNodeRequest): + The request object. Request for [GetNode][google.cloud.tpu.v2.Tpu.GetNode]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.cloud_tpu.Node: + A TPU instance. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/{name=projects/*/locations/*/nodes/*}', + }, + ] + request, metadata = self._interceptor.pre_get_node(request, metadata) + pb_request = cloud_tpu.GetNodeRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = cloud_tpu.Node() + pb_resp = cloud_tpu.Node.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_node(resp) + return resp + + class _GetRuntimeVersion(TpuRestStub): + def __hash__(self): + return hash("GetRuntimeVersion") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_tpu.GetRuntimeVersionRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> cloud_tpu.RuntimeVersion: + r"""Call the get runtime version method over HTTP. + + Args: + request (~.cloud_tpu.GetRuntimeVersionRequest): + The request object. Request for + [GetRuntimeVersion][google.cloud.tpu.v2.Tpu.GetRuntimeVersion]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.cloud_tpu.RuntimeVersion: + A runtime version that a Node can be + configured with. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/{name=projects/*/locations/*/runtimeVersions/*}', + }, + ] + request, metadata = self._interceptor.pre_get_runtime_version(request, metadata) + pb_request = cloud_tpu.GetRuntimeVersionRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = cloud_tpu.RuntimeVersion() + pb_resp = cloud_tpu.RuntimeVersion.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_runtime_version(resp) + return resp + + class _ListAcceleratorTypes(TpuRestStub): + def __hash__(self): + return hash("ListAcceleratorTypes") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_tpu.ListAcceleratorTypesRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> cloud_tpu.ListAcceleratorTypesResponse: + r"""Call the list accelerator types method over HTTP. + + Args: + request (~.cloud_tpu.ListAcceleratorTypesRequest): + The request object. Request for + [ListAcceleratorTypes][google.cloud.tpu.v2.Tpu.ListAcceleratorTypes]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.cloud_tpu.ListAcceleratorTypesResponse: + Response for + [ListAcceleratorTypes][google.cloud.tpu.v2.Tpu.ListAcceleratorTypes]. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/{parent=projects/*/locations/*}/acceleratorTypes', + }, + ] + request, metadata = self._interceptor.pre_list_accelerator_types(request, metadata) + pb_request = cloud_tpu.ListAcceleratorTypesRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = cloud_tpu.ListAcceleratorTypesResponse() + pb_resp = cloud_tpu.ListAcceleratorTypesResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_accelerator_types(resp) + return resp + + class _ListNodes(TpuRestStub): + def __hash__(self): + return hash("ListNodes") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_tpu.ListNodesRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> cloud_tpu.ListNodesResponse: + r"""Call the list nodes method over HTTP. + + Args: + request (~.cloud_tpu.ListNodesRequest): + The request object. Request for + [ListNodes][google.cloud.tpu.v2.Tpu.ListNodes]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.cloud_tpu.ListNodesResponse: + Response for + [ListNodes][google.cloud.tpu.v2.Tpu.ListNodes]. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/{parent=projects/*/locations/*}/nodes', + }, + ] + request, metadata = self._interceptor.pre_list_nodes(request, metadata) + pb_request = cloud_tpu.ListNodesRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = cloud_tpu.ListNodesResponse() + pb_resp = cloud_tpu.ListNodesResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_nodes(resp) + return resp + + class _ListRuntimeVersions(TpuRestStub): + def __hash__(self): + return hash("ListRuntimeVersions") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_tpu.ListRuntimeVersionsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> cloud_tpu.ListRuntimeVersionsResponse: + r"""Call the list runtime versions method over HTTP. + + Args: + request (~.cloud_tpu.ListRuntimeVersionsRequest): + The request object. Request for + [ListRuntimeVersions][google.cloud.tpu.v2.Tpu.ListRuntimeVersions]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.cloud_tpu.ListRuntimeVersionsResponse: + Response for + [ListRuntimeVersions][google.cloud.tpu.v2.Tpu.ListRuntimeVersions]. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/{parent=projects/*/locations/*}/runtimeVersions', + }, + ] + request, metadata = self._interceptor.pre_list_runtime_versions(request, metadata) + pb_request = cloud_tpu.ListRuntimeVersionsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = cloud_tpu.ListRuntimeVersionsResponse() + pb_resp = cloud_tpu.ListRuntimeVersionsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_runtime_versions(resp) + return resp + + class _StartNode(TpuRestStub): + def __hash__(self): + return hash("StartNode") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_tpu.StartNodeRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the start node method over HTTP. + + Args: + request (~.cloud_tpu.StartNodeRequest): + The request object. Request for + [StartNode][google.cloud.tpu.v2.Tpu.StartNode]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v2/{name=projects/*/locations/*/nodes/*}:start', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_start_node(request, metadata) + pb_request = cloud_tpu.StartNodeRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_start_node(resp) + return resp + + class _StopNode(TpuRestStub): + def __hash__(self): + return hash("StopNode") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_tpu.StopNodeRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the stop node method over HTTP. + + Args: + request (~.cloud_tpu.StopNodeRequest): + The request object. Request for + [StopNode][google.cloud.tpu.v2.Tpu.StopNode]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v2/{name=projects/*/locations/*/nodes/*}:stop', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_stop_node(request, metadata) + pb_request = cloud_tpu.StopNodeRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_stop_node(resp) + return resp + + class _UpdateNode(TpuRestStub): + def __hash__(self): + return hash("UpdateNode") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "updateMask" : {}, } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: cloud_tpu.UpdateNodeRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + r"""Call the update node method over HTTP. + + Args: + request (~.cloud_tpu.UpdateNodeRequest): + The request object. Request for + [UpdateNode][google.cloud.tpu.v2.Tpu.UpdateNode]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'patch', + 'uri': '/v2/{node.name=projects/*/locations/*/nodes/*}', + 'body': 'node', + }, + ] + request, metadata = self._interceptor.pre_update_node(request, metadata) + pb_request = cloud_tpu.UpdateNodeRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_node(resp) + return resp + + @property + def create_node(self) -> Callable[ + [cloud_tpu.CreateNodeRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._CreateNode(self._session, self._host, self._interceptor) # type: ignore + + @property + def delete_node(self) -> Callable[ + [cloud_tpu.DeleteNodeRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._DeleteNode(self._session, self._host, self._interceptor) # type: ignore + + @property + def generate_service_identity(self) -> Callable[ + [cloud_tpu.GenerateServiceIdentityRequest], + cloud_tpu.GenerateServiceIdentityResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._GenerateServiceIdentity(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_accelerator_type(self) -> Callable[ + [cloud_tpu.GetAcceleratorTypeRequest], + cloud_tpu.AcceleratorType]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._GetAcceleratorType(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_guest_attributes(self) -> Callable[ + [cloud_tpu.GetGuestAttributesRequest], + cloud_tpu.GetGuestAttributesResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._GetGuestAttributes(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_node(self) -> Callable[ + [cloud_tpu.GetNodeRequest], + cloud_tpu.Node]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._GetNode(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_runtime_version(self) -> Callable[ + [cloud_tpu.GetRuntimeVersionRequest], + cloud_tpu.RuntimeVersion]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._GetRuntimeVersion(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_accelerator_types(self) -> Callable[ + [cloud_tpu.ListAcceleratorTypesRequest], + cloud_tpu.ListAcceleratorTypesResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListAcceleratorTypes(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_nodes(self) -> Callable[ + [cloud_tpu.ListNodesRequest], + cloud_tpu.ListNodesResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListNodes(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_runtime_versions(self) -> Callable[ + [cloud_tpu.ListRuntimeVersionsRequest], + cloud_tpu.ListRuntimeVersionsResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListRuntimeVersions(self._session, self._host, self._interceptor) # type: ignore + + @property + def start_node(self) -> Callable[ + [cloud_tpu.StartNodeRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._StartNode(self._session, self._host, self._interceptor) # type: ignore + + @property + def stop_node(self) -> Callable[ + [cloud_tpu.StopNodeRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._StopNode(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_node(self) -> Callable[ + [cloud_tpu.UpdateNodeRequest], + operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._UpdateNode(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_location(self): + return self._GetLocation(self._session, self._host, self._interceptor) # type: ignore + + class _GetLocation(TpuRestStub): + def __call__(self, + request: locations_pb2.GetLocationRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> locations_pb2.Location: + + r"""Call the get location method over HTTP. + + Args: + request (locations_pb2.GetLocationRequest): + The request object for GetLocation method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + locations_pb2.Location: Response from GetLocation method. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/{name=projects/*/locations/*}', + }, + ] + + request, metadata = self._interceptor.pre_get_location(request, metadata) + request_kwargs = json_format.MessageToDict(request) + transcoded_request = path_template.transcode( + http_options, **request_kwargs) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json.dumps(transcoded_request['query_params'])) + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + resp = locations_pb2.Location() + resp = json_format.Parse(response.content.decode("utf-8"), resp) + resp = self._interceptor.post_get_location(resp) + return resp + + @property + def list_locations(self): + return self._ListLocations(self._session, self._host, self._interceptor) # type: ignore + + class _ListLocations(TpuRestStub): + def __call__(self, + request: locations_pb2.ListLocationsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> locations_pb2.ListLocationsResponse: + + r"""Call the list locations method over HTTP. + + Args: + request (locations_pb2.ListLocationsRequest): + The request object for ListLocations method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + locations_pb2.ListLocationsResponse: Response from ListLocations method. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/{name=projects/*}/locations', + }, + ] + + request, metadata = self._interceptor.pre_list_locations(request, metadata) + request_kwargs = json_format.MessageToDict(request) + transcoded_request = path_template.transcode( + http_options, **request_kwargs) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json.dumps(transcoded_request['query_params'])) + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + resp = locations_pb2.ListLocationsResponse() + resp = json_format.Parse(response.content.decode("utf-8"), resp) + resp = self._interceptor.post_list_locations(resp) + return resp + + @property + def cancel_operation(self): + return self._CancelOperation(self._session, self._host, self._interceptor) # type: ignore + + class _CancelOperation(TpuRestStub): + def __call__(self, + request: operations_pb2.CancelOperationRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> None: + + r"""Call the cancel operation method over HTTP. + + Args: + request (operations_pb2.CancelOperationRequest): + The request object for CancelOperation method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v2/{name=projects/*/locations/*/operations/*}:cancel', + }, + ] + + request, metadata = self._interceptor.pre_cancel_operation(request, metadata) + request_kwargs = json_format.MessageToDict(request) + transcoded_request = path_template.transcode( + http_options, **request_kwargs) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json.dumps(transcoded_request['query_params'])) + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + return self._interceptor.post_cancel_operation(None) + + @property + def delete_operation(self): + return self._DeleteOperation(self._session, self._host, self._interceptor) # type: ignore + + class _DeleteOperation(TpuRestStub): + def __call__(self, + request: operations_pb2.DeleteOperationRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> None: + + r"""Call the delete operation method over HTTP. + + Args: + request (operations_pb2.DeleteOperationRequest): + The request object for DeleteOperation method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'delete', + 'uri': '/v2/{name=projects/*/locations/*/operations/*}', + }, + ] + + request, metadata = self._interceptor.pre_delete_operation(request, metadata) + request_kwargs = json_format.MessageToDict(request) + transcoded_request = path_template.transcode( + http_options, **request_kwargs) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json.dumps(transcoded_request['query_params'])) + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + return self._interceptor.post_delete_operation(None) + + @property + def get_operation(self): + return self._GetOperation(self._session, self._host, self._interceptor) # type: ignore + + class _GetOperation(TpuRestStub): + def __call__(self, + request: operations_pb2.GetOperationRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.Operation: + + r"""Call the get operation method over HTTP. + + Args: + request (operations_pb2.GetOperationRequest): + The request object for GetOperation method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + operations_pb2.Operation: Response from GetOperation method. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/{name=projects/*/locations/*/operations/*}', + }, + ] + + request, metadata = self._interceptor.pre_get_operation(request, metadata) + request_kwargs = json_format.MessageToDict(request) + transcoded_request = path_template.transcode( + http_options, **request_kwargs) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json.dumps(transcoded_request['query_params'])) + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + resp = operations_pb2.Operation() + resp = json_format.Parse(response.content.decode("utf-8"), resp) + resp = self._interceptor.post_get_operation(resp) + return resp + + @property + def list_operations(self): + return self._ListOperations(self._session, self._host, self._interceptor) # type: ignore + + class _ListOperations(TpuRestStub): + def __call__(self, + request: operations_pb2.ListOperationsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> operations_pb2.ListOperationsResponse: + + r"""Call the list operations method over HTTP. + + Args: + request (operations_pb2.ListOperationsRequest): + The request object for ListOperations method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + operations_pb2.ListOperationsResponse: Response from ListOperations method. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/{name=projects/*/locations/*}/operations', + }, + ] + + request, metadata = self._interceptor.pre_list_operations(request, metadata) + request_kwargs = json_format.MessageToDict(request) + transcoded_request = path_template.transcode( + http_options, **request_kwargs) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json.dumps(transcoded_request['query_params'])) + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + resp = operations_pb2.ListOperationsResponse() + resp = json_format.Parse(response.content.decode("utf-8"), resp) + resp = self._interceptor.post_list_operations(resp) + return resp + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__=( + 'TpuRestTransport', +) diff --git a/owl-bot-staging/v2/google/cloud/tpu_v2/types/__init__.py b/owl-bot-staging/v2/google/cloud/tpu_v2/types/__init__.py new file mode 100644 index 0000000..c5f36ce --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/tpu_v2/types/__init__.py @@ -0,0 +1,90 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .cloud_tpu import ( + AcceleratorConfig, + AcceleratorType, + AccessConfig, + AttachedDisk, + CreateNodeRequest, + DeleteNodeRequest, + GenerateServiceIdentityRequest, + GenerateServiceIdentityResponse, + GetAcceleratorTypeRequest, + GetGuestAttributesRequest, + GetGuestAttributesResponse, + GetNodeRequest, + GetRuntimeVersionRequest, + GuestAttributes, + GuestAttributesEntry, + GuestAttributesValue, + ListAcceleratorTypesRequest, + ListAcceleratorTypesResponse, + ListNodesRequest, + ListNodesResponse, + ListRuntimeVersionsRequest, + ListRuntimeVersionsResponse, + NetworkConfig, + NetworkEndpoint, + Node, + OperationMetadata, + RuntimeVersion, + SchedulingConfig, + ServiceAccount, + ServiceIdentity, + ShieldedInstanceConfig, + StartNodeRequest, + StopNodeRequest, + Symptom, + UpdateNodeRequest, +) + +__all__ = ( + 'AcceleratorConfig', + 'AcceleratorType', + 'AccessConfig', + 'AttachedDisk', + 'CreateNodeRequest', + 'DeleteNodeRequest', + 'GenerateServiceIdentityRequest', + 'GenerateServiceIdentityResponse', + 'GetAcceleratorTypeRequest', + 'GetGuestAttributesRequest', + 'GetGuestAttributesResponse', + 'GetNodeRequest', + 'GetRuntimeVersionRequest', + 'GuestAttributes', + 'GuestAttributesEntry', + 'GuestAttributesValue', + 'ListAcceleratorTypesRequest', + 'ListAcceleratorTypesResponse', + 'ListNodesRequest', + 'ListNodesResponse', + 'ListRuntimeVersionsRequest', + 'ListRuntimeVersionsResponse', + 'NetworkConfig', + 'NetworkEndpoint', + 'Node', + 'OperationMetadata', + 'RuntimeVersion', + 'SchedulingConfig', + 'ServiceAccount', + 'ServiceIdentity', + 'ShieldedInstanceConfig', + 'StartNodeRequest', + 'StopNodeRequest', + 'Symptom', + 'UpdateNodeRequest', +) diff --git a/owl-bot-staging/v2/google/cloud/tpu_v2/types/cloud_tpu.py b/owl-bot-staging/v2/google/cloud/tpu_v2/types/cloud_tpu.py new file mode 100644 index 0000000..8fba7e9 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/tpu_v2/types/cloud_tpu.py @@ -0,0 +1,1243 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from __future__ import annotations + +from typing import MutableMapping, MutableSequence + +import proto # type: ignore + +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.tpu.v2', + manifest={ + 'GuestAttributes', + 'GuestAttributesValue', + 'GuestAttributesEntry', + 'AttachedDisk', + 'SchedulingConfig', + 'NetworkEndpoint', + 'AccessConfig', + 'NetworkConfig', + 'ServiceAccount', + 'Node', + 'ListNodesRequest', + 'ListNodesResponse', + 'GetNodeRequest', + 'CreateNodeRequest', + 'DeleteNodeRequest', + 'StopNodeRequest', + 'StartNodeRequest', + 'UpdateNodeRequest', + 'ServiceIdentity', + 'GenerateServiceIdentityRequest', + 'GenerateServiceIdentityResponse', + 'AcceleratorType', + 'GetAcceleratorTypeRequest', + 'ListAcceleratorTypesRequest', + 'ListAcceleratorTypesResponse', + 'RuntimeVersion', + 'GetRuntimeVersionRequest', + 'ListRuntimeVersionsRequest', + 'ListRuntimeVersionsResponse', + 'OperationMetadata', + 'Symptom', + 'GetGuestAttributesRequest', + 'GetGuestAttributesResponse', + 'AcceleratorConfig', + 'ShieldedInstanceConfig', + }, +) + + +class GuestAttributes(proto.Message): + r"""A guest attributes. + + Attributes: + query_path (str): + The path to be queried. This can be the + default namespace ('/') or a nested namespace + ('/\/') or a specified key + ('/\/\') + query_value (google.cloud.tpu_v2.types.GuestAttributesValue): + The value of the requested queried path. + """ + + query_path: str = proto.Field( + proto.STRING, + number=1, + ) + query_value: 'GuestAttributesValue' = proto.Field( + proto.MESSAGE, + number=2, + message='GuestAttributesValue', + ) + + +class GuestAttributesValue(proto.Message): + r"""Array of guest attribute namespace/key/value tuples. + + Attributes: + items (MutableSequence[google.cloud.tpu_v2.types.GuestAttributesEntry]): + The list of guest attributes entries. + """ + + items: MutableSequence['GuestAttributesEntry'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='GuestAttributesEntry', + ) + + +class GuestAttributesEntry(proto.Message): + r"""A guest attributes namespace/key/value entry. + + Attributes: + namespace (str): + Namespace for the guest attribute entry. + key (str): + Key for the guest attribute entry. + value (str): + Value for the guest attribute entry. + """ + + namespace: str = proto.Field( + proto.STRING, + number=1, + ) + key: str = proto.Field( + proto.STRING, + number=2, + ) + value: str = proto.Field( + proto.STRING, + number=3, + ) + + +class AttachedDisk(proto.Message): + r"""A node-attached disk resource. + Next ID: 8; + + Attributes: + source_disk (str): + Specifies the full path to an existing disk. + For example: + "projects/my-project/zones/us-central1-c/disks/my-disk". + mode (google.cloud.tpu_v2.types.AttachedDisk.DiskMode): + The mode in which to attach this disk. If not specified, the + default is READ_WRITE mode. Only applicable to data_disks. + """ + class DiskMode(proto.Enum): + r"""The different mode of the attached disk. + + Values: + DISK_MODE_UNSPECIFIED (0): + The disk mode is not known/set. + READ_WRITE (1): + Attaches the disk in read-write mode. Only + one TPU node can attach a disk in read-write + mode at a time. + READ_ONLY (2): + Attaches the disk in read-only mode. Multiple + TPU nodes can attach a disk in read-only mode at + a time. + """ + DISK_MODE_UNSPECIFIED = 0 + READ_WRITE = 1 + READ_ONLY = 2 + + source_disk: str = proto.Field( + proto.STRING, + number=3, + ) + mode: DiskMode = proto.Field( + proto.ENUM, + number=4, + enum=DiskMode, + ) + + +class SchedulingConfig(proto.Message): + r"""Sets the scheduling options for this node. + + Attributes: + preemptible (bool): + Defines whether the node is preemptible. + reserved (bool): + Whether the node is created under a + reservation. + """ + + preemptible: bool = proto.Field( + proto.BOOL, + number=1, + ) + reserved: bool = proto.Field( + proto.BOOL, + number=2, + ) + + +class NetworkEndpoint(proto.Message): + r"""A network endpoint over which a TPU worker can be reached. + + Attributes: + ip_address (str): + The internal IP address of this network + endpoint. + port (int): + The port of this network endpoint. + access_config (google.cloud.tpu_v2.types.AccessConfig): + The access config for the TPU worker. + """ + + ip_address: str = proto.Field( + proto.STRING, + number=1, + ) + port: int = proto.Field( + proto.INT32, + number=2, + ) + access_config: 'AccessConfig' = proto.Field( + proto.MESSAGE, + number=5, + message='AccessConfig', + ) + + +class AccessConfig(proto.Message): + r"""An access config attached to the TPU worker. + + Attributes: + external_ip (str): + Output only. An external IP address + associated with the TPU worker. + """ + + external_ip: str = proto.Field( + proto.STRING, + number=1, + ) + + +class NetworkConfig(proto.Message): + r"""Network related configurations. + + Attributes: + network (str): + The name of the network for the TPU node. It + must be a preexisting Google Compute Engine + network. If none is provided, "default" will be + used. + subnetwork (str): + The name of the subnetwork for the TPU node. + It must be a preexisting Google Compute Engine + subnetwork. If none is provided, "default" will + be used. + enable_external_ips (bool): + Indicates that external IP addresses would be + associated with the TPU workers. If set to + false, the specified subnetwork or network + should have Private Google Access enabled. + can_ip_forward (bool): + Allows the TPU node to send and receive + packets with non-matching destination or source + IPs. This is required if you plan to use the TPU + workers to forward routes. + """ + + network: str = proto.Field( + proto.STRING, + number=1, + ) + subnetwork: str = proto.Field( + proto.STRING, + number=2, + ) + enable_external_ips: bool = proto.Field( + proto.BOOL, + number=3, + ) + can_ip_forward: bool = proto.Field( + proto.BOOL, + number=4, + ) + + +class ServiceAccount(proto.Message): + r"""A service account. + + Attributes: + email (str): + Email address of the service account. If + empty, default Compute service account will be + used. + scope (MutableSequence[str]): + The list of scopes to be made available for + this service account. If empty, access to all + Cloud APIs will be allowed. + """ + + email: str = proto.Field( + proto.STRING, + number=1, + ) + scope: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=2, + ) + + +class Node(proto.Message): + r"""A TPU instance. + + Attributes: + name (str): + Output only. Immutable. The name of the TPU. + description (str): + The user-supplied description of the TPU. + Maximum of 512 characters. + accelerator_type (str): + Required. The type of hardware accelerators + associated with this node. + state (google.cloud.tpu_v2.types.Node.State): + Output only. The current state for the TPU + Node. + health_description (str): + Output only. If this field is populated, it + contains a description of why the TPU Node is + unhealthy. + runtime_version (str): + Required. The runtime version running in the + Node. + network_config (google.cloud.tpu_v2.types.NetworkConfig): + Network configurations for the TPU node. + cidr_block (str): + The CIDR block that the TPU node will use + when selecting an IP address. This CIDR block + must be a /29 block; the Compute Engine networks + API forbids a smaller block, and using a larger + block would be wasteful (a node can only consume + one IP address). Errors will occur if the CIDR + block has already been used for a currently + existing TPU node, the CIDR block conflicts with + any subnetworks in the user's provided network, + or the provided network is peered with another + network that is using that CIDR block. + service_account (google.cloud.tpu_v2.types.ServiceAccount): + The Google Cloud Platform Service Account to + be used by the TPU node VMs. If None is + specified, the default compute service account + will be used. + create_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time when the node was + created. + scheduling_config (google.cloud.tpu_v2.types.SchedulingConfig): + The scheduling options for this node. + network_endpoints (MutableSequence[google.cloud.tpu_v2.types.NetworkEndpoint]): + Output only. The network endpoints where TPU + workers can be accessed and sent work. It is + recommended that runtime clients of the node + reach out to the 0th entry in this map first. + health (google.cloud.tpu_v2.types.Node.Health): + The health status of the TPU node. + labels (MutableMapping[str, str]): + Resource labels to represent user-provided + metadata. + metadata (MutableMapping[str, str]): + Custom metadata to apply to the TPU Node. + Can set startup-script and shutdown-script + tags (MutableSequence[str]): + Tags to apply to the TPU Node. Tags are used + to identify valid sources or targets for network + firewalls. + id (int): + Output only. The unique identifier for the + TPU Node. + data_disks (MutableSequence[google.cloud.tpu_v2.types.AttachedDisk]): + The additional data disks for the Node. + api_version (google.cloud.tpu_v2.types.Node.ApiVersion): + Output only. The API version that created + this Node. + symptoms (MutableSequence[google.cloud.tpu_v2.types.Symptom]): + Output only. The Symptoms that have occurred + to the TPU Node. + shielded_instance_config (google.cloud.tpu_v2.types.ShieldedInstanceConfig): + Shielded Instance options. + accelerator_config (google.cloud.tpu_v2.types.AcceleratorConfig): + The AccleratorConfig for the TPU Node. + """ + class State(proto.Enum): + r"""Represents the different states of a TPU node during its + lifecycle. + + Values: + STATE_UNSPECIFIED (0): + TPU node state is not known/set. + CREATING (1): + TPU node is being created. + READY (2): + TPU node has been created. + RESTARTING (3): + TPU node is restarting. + REIMAGING (4): + TPU node is undergoing reimaging. + DELETING (5): + TPU node is being deleted. + REPAIRING (6): + TPU node is being repaired and may be unusable. Details can + be found in the ``help_description`` field. + STOPPED (8): + TPU node is stopped. + STOPPING (9): + TPU node is currently stopping. + STARTING (10): + TPU node is currently starting. + PREEMPTED (11): + TPU node has been preempted. Only applies to + Preemptible TPU Nodes. + TERMINATED (12): + TPU node has been terminated due to + maintenance or has reached the end of its life + cycle (for preemptible nodes). + HIDING (13): + TPU node is currently hiding. + HIDDEN (14): + TPU node has been hidden. + UNHIDING (15): + TPU node is currently unhiding. + """ + STATE_UNSPECIFIED = 0 + CREATING = 1 + READY = 2 + RESTARTING = 3 + REIMAGING = 4 + DELETING = 5 + REPAIRING = 6 + STOPPED = 8 + STOPPING = 9 + STARTING = 10 + PREEMPTED = 11 + TERMINATED = 12 + HIDING = 13 + HIDDEN = 14 + UNHIDING = 15 + + class Health(proto.Enum): + r"""Health defines the status of a TPU node as reported by + Health Monitor. + + Values: + HEALTH_UNSPECIFIED (0): + Health status is unknown: not initialized or + failed to retrieve. + HEALTHY (1): + The resource is healthy. + TIMEOUT (3): + The resource is unresponsive. + UNHEALTHY_TENSORFLOW (4): + The in-guest ML stack is unhealthy. + UNHEALTHY_MAINTENANCE (5): + The node is under maintenance/priority boost + caused rescheduling and will resume running once + rescheduled. + """ + HEALTH_UNSPECIFIED = 0 + HEALTHY = 1 + TIMEOUT = 3 + UNHEALTHY_TENSORFLOW = 4 + UNHEALTHY_MAINTENANCE = 5 + + class ApiVersion(proto.Enum): + r"""TPU API Version. + + Values: + API_VERSION_UNSPECIFIED (0): + API version is unknown. + V1_ALPHA1 (1): + TPU API V1Alpha1 version. + V1 (2): + TPU API V1 version. + V2_ALPHA1 (3): + TPU API V2Alpha1 version. + V2 (4): + TPU API V2 version. + """ + API_VERSION_UNSPECIFIED = 0 + V1_ALPHA1 = 1 + V1 = 2 + V2_ALPHA1 = 3 + V2 = 4 + + name: str = proto.Field( + proto.STRING, + number=1, + ) + description: str = proto.Field( + proto.STRING, + number=3, + ) + accelerator_type: str = proto.Field( + proto.STRING, + number=5, + ) + state: State = proto.Field( + proto.ENUM, + number=9, + enum=State, + ) + health_description: str = proto.Field( + proto.STRING, + number=10, + ) + runtime_version: str = proto.Field( + proto.STRING, + number=11, + ) + network_config: 'NetworkConfig' = proto.Field( + proto.MESSAGE, + number=36, + message='NetworkConfig', + ) + cidr_block: str = proto.Field( + proto.STRING, + number=13, + ) + service_account: 'ServiceAccount' = proto.Field( + proto.MESSAGE, + number=37, + message='ServiceAccount', + ) + create_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=16, + message=timestamp_pb2.Timestamp, + ) + scheduling_config: 'SchedulingConfig' = proto.Field( + proto.MESSAGE, + number=17, + message='SchedulingConfig', + ) + network_endpoints: MutableSequence['NetworkEndpoint'] = proto.RepeatedField( + proto.MESSAGE, + number=21, + message='NetworkEndpoint', + ) + health: Health = proto.Field( + proto.ENUM, + number=22, + enum=Health, + ) + labels: MutableMapping[str, str] = proto.MapField( + proto.STRING, + proto.STRING, + number=24, + ) + metadata: MutableMapping[str, str] = proto.MapField( + proto.STRING, + proto.STRING, + number=34, + ) + tags: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=40, + ) + id: int = proto.Field( + proto.INT64, + number=33, + ) + data_disks: MutableSequence['AttachedDisk'] = proto.RepeatedField( + proto.MESSAGE, + number=41, + message='AttachedDisk', + ) + api_version: ApiVersion = proto.Field( + proto.ENUM, + number=38, + enum=ApiVersion, + ) + symptoms: MutableSequence['Symptom'] = proto.RepeatedField( + proto.MESSAGE, + number=39, + message='Symptom', + ) + shielded_instance_config: 'ShieldedInstanceConfig' = proto.Field( + proto.MESSAGE, + number=45, + message='ShieldedInstanceConfig', + ) + accelerator_config: 'AcceleratorConfig' = proto.Field( + proto.MESSAGE, + number=46, + message='AcceleratorConfig', + ) + + +class ListNodesRequest(proto.Message): + r"""Request for [ListNodes][google.cloud.tpu.v2.Tpu.ListNodes]. + + Attributes: + parent (str): + Required. The parent resource name. + page_size (int): + The maximum number of items to return. + page_token (str): + The next_page_token value returned from a previous List + request, if any. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + page_size: int = proto.Field( + proto.INT32, + number=2, + ) + page_token: str = proto.Field( + proto.STRING, + number=3, + ) + + +class ListNodesResponse(proto.Message): + r"""Response for [ListNodes][google.cloud.tpu.v2.Tpu.ListNodes]. + + Attributes: + nodes (MutableSequence[google.cloud.tpu_v2.types.Node]): + The listed nodes. + next_page_token (str): + The next page token or empty if none. + unreachable (MutableSequence[str]): + Locations that could not be reached. + """ + + @property + def raw_page(self): + return self + + nodes: MutableSequence['Node'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='Node', + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + unreachable: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=3, + ) + + +class GetNodeRequest(proto.Message): + r"""Request for [GetNode][google.cloud.tpu.v2.Tpu.GetNode]. + + Attributes: + name (str): + Required. The resource name. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class CreateNodeRequest(proto.Message): + r"""Request for [CreateNode][google.cloud.tpu.v2.Tpu.CreateNode]. + + Attributes: + parent (str): + Required. The parent resource name. + node_id (str): + The unqualified resource name. + node (google.cloud.tpu_v2.types.Node): + Required. The node. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + node_id: str = proto.Field( + proto.STRING, + number=2, + ) + node: 'Node' = proto.Field( + proto.MESSAGE, + number=3, + message='Node', + ) + + +class DeleteNodeRequest(proto.Message): + r"""Request for [DeleteNode][google.cloud.tpu.v2.Tpu.DeleteNode]. + + Attributes: + name (str): + Required. The resource name. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class StopNodeRequest(proto.Message): + r"""Request for [StopNode][google.cloud.tpu.v2.Tpu.StopNode]. + + Attributes: + name (str): + Required. The resource name. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class StartNodeRequest(proto.Message): + r"""Request for [StartNode][google.cloud.tpu.v2.Tpu.StartNode]. + + Attributes: + name (str): + Required. The resource name. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class UpdateNodeRequest(proto.Message): + r"""Request for [UpdateNode][google.cloud.tpu.v2.Tpu.UpdateNode]. + + Attributes: + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Required. Mask of fields from [Node][Tpu.Node] to update. + Supported fields: [description, tags, labels, metadata, + network_config.enable_external_ips]. + node (google.cloud.tpu_v2.types.Node): + Required. The node. Only fields specified in update_mask are + updated. + """ + + update_mask: field_mask_pb2.FieldMask = proto.Field( + proto.MESSAGE, + number=1, + message=field_mask_pb2.FieldMask, + ) + node: 'Node' = proto.Field( + proto.MESSAGE, + number=2, + message='Node', + ) + + +class ServiceIdentity(proto.Message): + r"""The per-product per-project service identity for Cloud TPU + service. + + Attributes: + email (str): + The email address of the service identity. + """ + + email: str = proto.Field( + proto.STRING, + number=1, + ) + + +class GenerateServiceIdentityRequest(proto.Message): + r"""Request for + [GenerateServiceIdentity][google.cloud.tpu.v2.Tpu.GenerateServiceIdentity]. + + Attributes: + parent (str): + Required. The parent resource name. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + + +class GenerateServiceIdentityResponse(proto.Message): + r"""Response for + [GenerateServiceIdentity][google.cloud.tpu.v2.Tpu.GenerateServiceIdentity]. + + Attributes: + identity (google.cloud.tpu_v2.types.ServiceIdentity): + ServiceIdentity that was created or + retrieved. + """ + + identity: 'ServiceIdentity' = proto.Field( + proto.MESSAGE, + number=1, + message='ServiceIdentity', + ) + + +class AcceleratorType(proto.Message): + r"""A accelerator type that a Node can be configured with. + + Attributes: + name (str): + The resource name. + type_ (str): + the accelerator type. + accelerator_configs (MutableSequence[google.cloud.tpu_v2.types.AcceleratorConfig]): + The accelerator config. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + type_: str = proto.Field( + proto.STRING, + number=2, + ) + accelerator_configs: MutableSequence['AcceleratorConfig'] = proto.RepeatedField( + proto.MESSAGE, + number=3, + message='AcceleratorConfig', + ) + + +class GetAcceleratorTypeRequest(proto.Message): + r"""Request for + [GetAcceleratorType][google.cloud.tpu.v2.Tpu.GetAcceleratorType]. + + Attributes: + name (str): + Required. The resource name. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class ListAcceleratorTypesRequest(proto.Message): + r"""Request for + [ListAcceleratorTypes][google.cloud.tpu.v2.Tpu.ListAcceleratorTypes]. + + Attributes: + parent (str): + Required. The parent resource name. + page_size (int): + The maximum number of items to return. + page_token (str): + The next_page_token value returned from a previous List + request, if any. + filter (str): + List filter. + order_by (str): + Sort results. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + page_size: int = proto.Field( + proto.INT32, + number=2, + ) + page_token: str = proto.Field( + proto.STRING, + number=3, + ) + filter: str = proto.Field( + proto.STRING, + number=5, + ) + order_by: str = proto.Field( + proto.STRING, + number=6, + ) + + +class ListAcceleratorTypesResponse(proto.Message): + r"""Response for + [ListAcceleratorTypes][google.cloud.tpu.v2.Tpu.ListAcceleratorTypes]. + + Attributes: + accelerator_types (MutableSequence[google.cloud.tpu_v2.types.AcceleratorType]): + The listed nodes. + next_page_token (str): + The next page token or empty if none. + unreachable (MutableSequence[str]): + Locations that could not be reached. + """ + + @property + def raw_page(self): + return self + + accelerator_types: MutableSequence['AcceleratorType'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='AcceleratorType', + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + unreachable: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=3, + ) + + +class RuntimeVersion(proto.Message): + r"""A runtime version that a Node can be configured with. + + Attributes: + name (str): + The resource name. + version (str): + The runtime version. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + version: str = proto.Field( + proto.STRING, + number=2, + ) + + +class GetRuntimeVersionRequest(proto.Message): + r"""Request for + [GetRuntimeVersion][google.cloud.tpu.v2.Tpu.GetRuntimeVersion]. + + Attributes: + name (str): + Required. The resource name. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class ListRuntimeVersionsRequest(proto.Message): + r"""Request for + [ListRuntimeVersions][google.cloud.tpu.v2.Tpu.ListRuntimeVersions]. + + Attributes: + parent (str): + Required. The parent resource name. + page_size (int): + The maximum number of items to return. + page_token (str): + The next_page_token value returned from a previous List + request, if any. + filter (str): + List filter. + order_by (str): + Sort results. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + page_size: int = proto.Field( + proto.INT32, + number=2, + ) + page_token: str = proto.Field( + proto.STRING, + number=3, + ) + filter: str = proto.Field( + proto.STRING, + number=5, + ) + order_by: str = proto.Field( + proto.STRING, + number=6, + ) + + +class ListRuntimeVersionsResponse(proto.Message): + r"""Response for + [ListRuntimeVersions][google.cloud.tpu.v2.Tpu.ListRuntimeVersions]. + + Attributes: + runtime_versions (MutableSequence[google.cloud.tpu_v2.types.RuntimeVersion]): + The listed nodes. + next_page_token (str): + The next page token or empty if none. + unreachable (MutableSequence[str]): + Locations that could not be reached. + """ + + @property + def raw_page(self): + return self + + runtime_versions: MutableSequence['RuntimeVersion'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='RuntimeVersion', + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + unreachable: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=3, + ) + + +class OperationMetadata(proto.Message): + r"""Metadata describing an [Operation][google.longrunning.Operation] + + Attributes: + create_time (google.protobuf.timestamp_pb2.Timestamp): + The time the operation was created. + end_time (google.protobuf.timestamp_pb2.Timestamp): + The time the operation finished running. + target (str): + Target of the operation - for example + projects/project-1/connectivityTests/test-1 + verb (str): + Name of the verb executed by the operation. + status_detail (str): + Human-readable status of the operation, if + any. + cancel_requested (bool): + Specifies if cancellation was requested for + the operation. + api_version (str): + API version. + """ + + create_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=1, + message=timestamp_pb2.Timestamp, + ) + end_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=2, + message=timestamp_pb2.Timestamp, + ) + target: str = proto.Field( + proto.STRING, + number=3, + ) + verb: str = proto.Field( + proto.STRING, + number=4, + ) + status_detail: str = proto.Field( + proto.STRING, + number=5, + ) + cancel_requested: bool = proto.Field( + proto.BOOL, + number=6, + ) + api_version: str = proto.Field( + proto.STRING, + number=7, + ) + + +class Symptom(proto.Message): + r"""A Symptom instance. + + Attributes: + create_time (google.protobuf.timestamp_pb2.Timestamp): + Timestamp when the Symptom is created. + symptom_type (google.cloud.tpu_v2.types.Symptom.SymptomType): + Type of the Symptom. + details (str): + Detailed information of the current Symptom. + worker_id (str): + A string used to uniquely distinguish a + worker within a TPU node. + """ + class SymptomType(proto.Enum): + r"""SymptomType represents the different types of Symptoms that a + TPU can be at. + + Values: + SYMPTOM_TYPE_UNSPECIFIED (0): + Unspecified symptom. + LOW_MEMORY (1): + TPU VM memory is low. + OUT_OF_MEMORY (2): + TPU runtime is out of memory. + EXECUTE_TIMED_OUT (3): + TPU runtime execution has timed out. + MESH_BUILD_FAIL (4): + TPU runtime fails to construct a mesh that + recognizes each TPU device's neighbors. + HBM_OUT_OF_MEMORY (5): + TPU HBM is out of memory. + PROJECT_ABUSE (6): + Abusive behaviors have been identified on the + current project. + """ + SYMPTOM_TYPE_UNSPECIFIED = 0 + LOW_MEMORY = 1 + OUT_OF_MEMORY = 2 + EXECUTE_TIMED_OUT = 3 + MESH_BUILD_FAIL = 4 + HBM_OUT_OF_MEMORY = 5 + PROJECT_ABUSE = 6 + + create_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=1, + message=timestamp_pb2.Timestamp, + ) + symptom_type: SymptomType = proto.Field( + proto.ENUM, + number=2, + enum=SymptomType, + ) + details: str = proto.Field( + proto.STRING, + number=3, + ) + worker_id: str = proto.Field( + proto.STRING, + number=4, + ) + + +class GetGuestAttributesRequest(proto.Message): + r"""Request for + [GetGuestAttributes][google.cloud.tpu.v2.Tpu.GetGuestAttributes]. + + Attributes: + name (str): + Required. The resource name. + query_path (str): + The guest attributes path to be queried. + worker_ids (MutableSequence[str]): + The 0-based worker ID. If it is empty, all + workers' GuestAttributes will be returned. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + query_path: str = proto.Field( + proto.STRING, + number=2, + ) + worker_ids: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=3, + ) + + +class GetGuestAttributesResponse(proto.Message): + r"""Response for + [GetGuestAttributes][google.cloud.tpu.v2.Tpu.GetGuestAttributes]. + + Attributes: + guest_attributes (MutableSequence[google.cloud.tpu_v2.types.GuestAttributes]): + The guest attributes for the TPU workers. + """ + + guest_attributes: MutableSequence['GuestAttributes'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='GuestAttributes', + ) + + +class AcceleratorConfig(proto.Message): + r"""A TPU accelerator configuration. + + Attributes: + type_ (google.cloud.tpu_v2.types.AcceleratorConfig.Type): + Required. Type of TPU. + topology (str): + Required. Topology of TPU in chips. + """ + class Type(proto.Enum): + r"""TPU type. + + Values: + TYPE_UNSPECIFIED (0): + Unspecified version. + V2 (2): + TPU v2. + V3 (4): + TPU v3. + V4 (7): + TPU v4. + """ + TYPE_UNSPECIFIED = 0 + V2 = 2 + V3 = 4 + V4 = 7 + + type_: Type = proto.Field( + proto.ENUM, + number=1, + enum=Type, + ) + topology: str = proto.Field( + proto.STRING, + number=2, + ) + + +class ShieldedInstanceConfig(proto.Message): + r"""A set of Shielded Instance options. + + Attributes: + enable_secure_boot (bool): + Defines whether the instance has Secure Boot + enabled. + """ + + enable_secure_boot: bool = proto.Field( + proto.BOOL, + number=1, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v2/mypy.ini b/owl-bot-staging/v2/mypy.ini new file mode 100644 index 0000000..574c5ae --- /dev/null +++ b/owl-bot-staging/v2/mypy.ini @@ -0,0 +1,3 @@ +[mypy] +python_version = 3.7 +namespace_packages = True diff --git a/owl-bot-staging/v2/noxfile.py b/owl-bot-staging/v2/noxfile.py new file mode 100644 index 0000000..920c888 --- /dev/null +++ b/owl-bot-staging/v2/noxfile.py @@ -0,0 +1,184 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +import pathlib +import shutil +import subprocess +import sys + + +import nox # type: ignore + +ALL_PYTHON = [ + "3.7", + "3.8", + "3.9", + "3.10", + "3.11", +] + +CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() + +LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" +PACKAGE_NAME = subprocess.check_output([sys.executable, "setup.py", "--name"], encoding="utf-8") + +BLACK_VERSION = "black==22.3.0" +BLACK_PATHS = ["docs", "google", "tests", "samples", "noxfile.py", "setup.py"] +DEFAULT_PYTHON_VERSION = "3.11" + +nox.sessions = [ + "unit", + "cover", + "mypy", + "check_lower_bounds" + # exclude update_lower_bounds from default + "docs", + "blacken", + "lint", + "lint_setup_py", +] + +@nox.session(python=ALL_PYTHON) +def unit(session): + """Run the unit test suite.""" + + session.install('coverage', 'pytest', 'pytest-cov', 'pytest-asyncio', 'asyncmock; python_version < "3.8"') + session.install('-e', '.') + + session.run( + 'py.test', + '--quiet', + '--cov=google/cloud/tpu_v2/', + '--cov=tests/', + '--cov-config=.coveragerc', + '--cov-report=term', + '--cov-report=html', + os.path.join('tests', 'unit', ''.join(session.posargs)) + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def cover(session): + """Run the final coverage report. + This outputs the coverage report aggregating coverage from the unit + test runs (not system test runs), and then erases coverage data. + """ + session.install("coverage", "pytest-cov") + session.run("coverage", "report", "--show-missing", "--fail-under=100") + + session.run("coverage", "erase") + + +@nox.session(python=ALL_PYTHON) +def mypy(session): + """Run the type checker.""" + session.install( + 'mypy', + 'types-requests', + 'types-protobuf' + ) + session.install('.') + session.run( + 'mypy', + '--explicit-package-bases', + 'google', + ) + + +@nox.session +def update_lower_bounds(session): + """Update lower bounds in constraints.txt to match setup.py""" + session.install('google-cloud-testutils') + session.install('.') + + session.run( + 'lower-bound-checker', + 'update', + '--package-name', + PACKAGE_NAME, + '--constraints-file', + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + + +@nox.session +def check_lower_bounds(session): + """Check lower bounds in setup.py are reflected in constraints file""" + session.install('google-cloud-testutils') + session.install('.') + + session.run( + 'lower-bound-checker', + 'check', + '--package-name', + PACKAGE_NAME, + '--constraints-file', + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def docs(session): + """Build the docs for this library.""" + + session.install("-e", ".") + session.install("sphinx==4.0.1", "alabaster", "recommonmark") + + shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) + session.run( + "sphinx-build", + "-W", # warnings as errors + "-T", # show full traceback on exception + "-N", # no colors + "-b", + "html", + "-d", + os.path.join("docs", "_build", "doctrees", ""), + os.path.join("docs", ""), + os.path.join("docs", "_build", "html", ""), + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint(session): + """Run linters. + + Returns a failure if the linters find linting errors or sufficiently + serious code quality issues. + """ + session.install("flake8", BLACK_VERSION) + session.run( + "black", + "--check", + *BLACK_PATHS, + ) + session.run("flake8", "google", "tests", "samples") + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def blacken(session): + """Run black. Format code to uniform standard.""" + session.install(BLACK_VERSION) + session.run( + "black", + *BLACK_PATHS, + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint_setup_py(session): + """Verify that setup.py is valid (including RST check).""" + session.install("docutils", "pygments") + session.run("python", "setup.py", "check", "--restructuredtext", "--strict") diff --git a/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.cloud.tpu.v2.json b/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.cloud.tpu.v2.json new file mode 100644 index 0000000..9f7e7c8 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.cloud.tpu.v2.json @@ -0,0 +1,2100 @@ +{ + "clientLibrary": { + "apis": [ + { + "id": "google.cloud.tpu.v2", + "version": "v2" + } + ], + "language": "PYTHON", + "name": "google-cloud-tpu", + "version": "0.1.0" + }, + "snippets": [ + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v2.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v2.TpuAsyncClient.create_node", + "method": { + "fullName": "google.cloud.tpu.v2.Tpu.CreateNode", + "service": { + "fullName": "google.cloud.tpu.v2.Tpu", + "shortName": "Tpu" + }, + "shortName": "CreateNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2.types.CreateNodeRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "node", + "type": "google.cloud.tpu_v2.types.Node" + }, + { + "name": "node_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "create_node" + }, + "description": "Sample for CreateNode", + "file": "tpu_v2_generated_tpu_create_node_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2_generated_Tpu_CreateNode_async", + "segments": [ + { + "end": 60, + "start": 27, + "type": "FULL" + }, + { + "end": 60, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 50, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 57, + "start": 51, + "type": "REQUEST_EXECUTION" + }, + { + "end": 61, + "start": 58, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2_generated_tpu_create_node_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v2.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v2.TpuClient.create_node", + "method": { + "fullName": "google.cloud.tpu.v2.Tpu.CreateNode", + "service": { + "fullName": "google.cloud.tpu.v2.Tpu", + "shortName": "Tpu" + }, + "shortName": "CreateNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2.types.CreateNodeRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "node", + "type": "google.cloud.tpu_v2.types.Node" + }, + { + "name": "node_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "create_node" + }, + "description": "Sample for CreateNode", + "file": "tpu_v2_generated_tpu_create_node_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2_generated_Tpu_CreateNode_sync", + "segments": [ + { + "end": 60, + "start": 27, + "type": "FULL" + }, + { + "end": 60, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 50, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 57, + "start": 51, + "type": "REQUEST_EXECUTION" + }, + { + "end": 61, + "start": 58, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2_generated_tpu_create_node_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v2.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v2.TpuAsyncClient.delete_node", + "method": { + "fullName": "google.cloud.tpu.v2.Tpu.DeleteNode", + "service": { + "fullName": "google.cloud.tpu.v2.Tpu", + "shortName": "Tpu" + }, + "shortName": "DeleteNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2.types.DeleteNodeRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "delete_node" + }, + "description": "Sample for DeleteNode", + "file": "tpu_v2_generated_tpu_delete_node_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2_generated_Tpu_DeleteNode_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2_generated_tpu_delete_node_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v2.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v2.TpuClient.delete_node", + "method": { + "fullName": "google.cloud.tpu.v2.Tpu.DeleteNode", + "service": { + "fullName": "google.cloud.tpu.v2.Tpu", + "shortName": "Tpu" + }, + "shortName": "DeleteNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2.types.DeleteNodeRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "delete_node" + }, + "description": "Sample for DeleteNode", + "file": "tpu_v2_generated_tpu_delete_node_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2_generated_Tpu_DeleteNode_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2_generated_tpu_delete_node_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v2.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v2.TpuAsyncClient.generate_service_identity", + "method": { + "fullName": "google.cloud.tpu.v2.Tpu.GenerateServiceIdentity", + "service": { + "fullName": "google.cloud.tpu.v2.Tpu", + "shortName": "Tpu" + }, + "shortName": "GenerateServiceIdentity" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2.types.GenerateServiceIdentityRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2.types.GenerateServiceIdentityResponse", + "shortName": "generate_service_identity" + }, + "description": "Sample for GenerateServiceIdentity", + "file": "tpu_v2_generated_tpu_generate_service_identity_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2_generated_Tpu_GenerateServiceIdentity_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2_generated_tpu_generate_service_identity_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v2.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v2.TpuClient.generate_service_identity", + "method": { + "fullName": "google.cloud.tpu.v2.Tpu.GenerateServiceIdentity", + "service": { + "fullName": "google.cloud.tpu.v2.Tpu", + "shortName": "Tpu" + }, + "shortName": "GenerateServiceIdentity" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2.types.GenerateServiceIdentityRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2.types.GenerateServiceIdentityResponse", + "shortName": "generate_service_identity" + }, + "description": "Sample for GenerateServiceIdentity", + "file": "tpu_v2_generated_tpu_generate_service_identity_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2_generated_Tpu_GenerateServiceIdentity_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2_generated_tpu_generate_service_identity_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v2.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v2.TpuAsyncClient.get_accelerator_type", + "method": { + "fullName": "google.cloud.tpu.v2.Tpu.GetAcceleratorType", + "service": { + "fullName": "google.cloud.tpu.v2.Tpu", + "shortName": "Tpu" + }, + "shortName": "GetAcceleratorType" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2.types.GetAcceleratorTypeRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2.types.AcceleratorType", + "shortName": "get_accelerator_type" + }, + "description": "Sample for GetAcceleratorType", + "file": "tpu_v2_generated_tpu_get_accelerator_type_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2_generated_Tpu_GetAcceleratorType_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2_generated_tpu_get_accelerator_type_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v2.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v2.TpuClient.get_accelerator_type", + "method": { + "fullName": "google.cloud.tpu.v2.Tpu.GetAcceleratorType", + "service": { + "fullName": "google.cloud.tpu.v2.Tpu", + "shortName": "Tpu" + }, + "shortName": "GetAcceleratorType" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2.types.GetAcceleratorTypeRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2.types.AcceleratorType", + "shortName": "get_accelerator_type" + }, + "description": "Sample for GetAcceleratorType", + "file": "tpu_v2_generated_tpu_get_accelerator_type_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2_generated_Tpu_GetAcceleratorType_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2_generated_tpu_get_accelerator_type_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v2.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v2.TpuAsyncClient.get_guest_attributes", + "method": { + "fullName": "google.cloud.tpu.v2.Tpu.GetGuestAttributes", + "service": { + "fullName": "google.cloud.tpu.v2.Tpu", + "shortName": "Tpu" + }, + "shortName": "GetGuestAttributes" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2.types.GetGuestAttributesRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2.types.GetGuestAttributesResponse", + "shortName": "get_guest_attributes" + }, + "description": "Sample for GetGuestAttributes", + "file": "tpu_v2_generated_tpu_get_guest_attributes_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2_generated_Tpu_GetGuestAttributes_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2_generated_tpu_get_guest_attributes_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v2.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v2.TpuClient.get_guest_attributes", + "method": { + "fullName": "google.cloud.tpu.v2.Tpu.GetGuestAttributes", + "service": { + "fullName": "google.cloud.tpu.v2.Tpu", + "shortName": "Tpu" + }, + "shortName": "GetGuestAttributes" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2.types.GetGuestAttributesRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2.types.GetGuestAttributesResponse", + "shortName": "get_guest_attributes" + }, + "description": "Sample for GetGuestAttributes", + "file": "tpu_v2_generated_tpu_get_guest_attributes_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2_generated_Tpu_GetGuestAttributes_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2_generated_tpu_get_guest_attributes_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v2.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v2.TpuAsyncClient.get_node", + "method": { + "fullName": "google.cloud.tpu.v2.Tpu.GetNode", + "service": { + "fullName": "google.cloud.tpu.v2.Tpu", + "shortName": "Tpu" + }, + "shortName": "GetNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2.types.GetNodeRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2.types.Node", + "shortName": "get_node" + }, + "description": "Sample for GetNode", + "file": "tpu_v2_generated_tpu_get_node_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2_generated_Tpu_GetNode_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2_generated_tpu_get_node_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v2.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v2.TpuClient.get_node", + "method": { + "fullName": "google.cloud.tpu.v2.Tpu.GetNode", + "service": { + "fullName": "google.cloud.tpu.v2.Tpu", + "shortName": "Tpu" + }, + "shortName": "GetNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2.types.GetNodeRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2.types.Node", + "shortName": "get_node" + }, + "description": "Sample for GetNode", + "file": "tpu_v2_generated_tpu_get_node_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2_generated_Tpu_GetNode_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2_generated_tpu_get_node_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v2.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v2.TpuAsyncClient.get_runtime_version", + "method": { + "fullName": "google.cloud.tpu.v2.Tpu.GetRuntimeVersion", + "service": { + "fullName": "google.cloud.tpu.v2.Tpu", + "shortName": "Tpu" + }, + "shortName": "GetRuntimeVersion" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2.types.GetRuntimeVersionRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2.types.RuntimeVersion", + "shortName": "get_runtime_version" + }, + "description": "Sample for GetRuntimeVersion", + "file": "tpu_v2_generated_tpu_get_runtime_version_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2_generated_Tpu_GetRuntimeVersion_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2_generated_tpu_get_runtime_version_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v2.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v2.TpuClient.get_runtime_version", + "method": { + "fullName": "google.cloud.tpu.v2.Tpu.GetRuntimeVersion", + "service": { + "fullName": "google.cloud.tpu.v2.Tpu", + "shortName": "Tpu" + }, + "shortName": "GetRuntimeVersion" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2.types.GetRuntimeVersionRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2.types.RuntimeVersion", + "shortName": "get_runtime_version" + }, + "description": "Sample for GetRuntimeVersion", + "file": "tpu_v2_generated_tpu_get_runtime_version_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2_generated_Tpu_GetRuntimeVersion_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2_generated_tpu_get_runtime_version_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v2.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v2.TpuAsyncClient.list_accelerator_types", + "method": { + "fullName": "google.cloud.tpu.v2.Tpu.ListAcceleratorTypes", + "service": { + "fullName": "google.cloud.tpu.v2.Tpu", + "shortName": "Tpu" + }, + "shortName": "ListAcceleratorTypes" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2.types.ListAcceleratorTypesRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2.services.tpu.pagers.ListAcceleratorTypesAsyncPager", + "shortName": "list_accelerator_types" + }, + "description": "Sample for ListAcceleratorTypes", + "file": "tpu_v2_generated_tpu_list_accelerator_types_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2_generated_Tpu_ListAcceleratorTypes_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2_generated_tpu_list_accelerator_types_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v2.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v2.TpuClient.list_accelerator_types", + "method": { + "fullName": "google.cloud.tpu.v2.Tpu.ListAcceleratorTypes", + "service": { + "fullName": "google.cloud.tpu.v2.Tpu", + "shortName": "Tpu" + }, + "shortName": "ListAcceleratorTypes" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2.types.ListAcceleratorTypesRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2.services.tpu.pagers.ListAcceleratorTypesPager", + "shortName": "list_accelerator_types" + }, + "description": "Sample for ListAcceleratorTypes", + "file": "tpu_v2_generated_tpu_list_accelerator_types_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2_generated_Tpu_ListAcceleratorTypes_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2_generated_tpu_list_accelerator_types_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v2.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v2.TpuAsyncClient.list_nodes", + "method": { + "fullName": "google.cloud.tpu.v2.Tpu.ListNodes", + "service": { + "fullName": "google.cloud.tpu.v2.Tpu", + "shortName": "Tpu" + }, + "shortName": "ListNodes" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2.types.ListNodesRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2.services.tpu.pagers.ListNodesAsyncPager", + "shortName": "list_nodes" + }, + "description": "Sample for ListNodes", + "file": "tpu_v2_generated_tpu_list_nodes_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2_generated_Tpu_ListNodes_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2_generated_tpu_list_nodes_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v2.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v2.TpuClient.list_nodes", + "method": { + "fullName": "google.cloud.tpu.v2.Tpu.ListNodes", + "service": { + "fullName": "google.cloud.tpu.v2.Tpu", + "shortName": "Tpu" + }, + "shortName": "ListNodes" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2.types.ListNodesRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2.services.tpu.pagers.ListNodesPager", + "shortName": "list_nodes" + }, + "description": "Sample for ListNodes", + "file": "tpu_v2_generated_tpu_list_nodes_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2_generated_Tpu_ListNodes_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2_generated_tpu_list_nodes_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v2.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v2.TpuAsyncClient.list_runtime_versions", + "method": { + "fullName": "google.cloud.tpu.v2.Tpu.ListRuntimeVersions", + "service": { + "fullName": "google.cloud.tpu.v2.Tpu", + "shortName": "Tpu" + }, + "shortName": "ListRuntimeVersions" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2.types.ListRuntimeVersionsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2.services.tpu.pagers.ListRuntimeVersionsAsyncPager", + "shortName": "list_runtime_versions" + }, + "description": "Sample for ListRuntimeVersions", + "file": "tpu_v2_generated_tpu_list_runtime_versions_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2_generated_Tpu_ListRuntimeVersions_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2_generated_tpu_list_runtime_versions_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v2.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v2.TpuClient.list_runtime_versions", + "method": { + "fullName": "google.cloud.tpu.v2.Tpu.ListRuntimeVersions", + "service": { + "fullName": "google.cloud.tpu.v2.Tpu", + "shortName": "Tpu" + }, + "shortName": "ListRuntimeVersions" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2.types.ListRuntimeVersionsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2.services.tpu.pagers.ListRuntimeVersionsPager", + "shortName": "list_runtime_versions" + }, + "description": "Sample for ListRuntimeVersions", + "file": "tpu_v2_generated_tpu_list_runtime_versions_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2_generated_Tpu_ListRuntimeVersions_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2_generated_tpu_list_runtime_versions_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v2.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v2.TpuAsyncClient.start_node", + "method": { + "fullName": "google.cloud.tpu.v2.Tpu.StartNode", + "service": { + "fullName": "google.cloud.tpu.v2.Tpu", + "shortName": "Tpu" + }, + "shortName": "StartNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2.types.StartNodeRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "start_node" + }, + "description": "Sample for StartNode", + "file": "tpu_v2_generated_tpu_start_node_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2_generated_Tpu_StartNode_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2_generated_tpu_start_node_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v2.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v2.TpuClient.start_node", + "method": { + "fullName": "google.cloud.tpu.v2.Tpu.StartNode", + "service": { + "fullName": "google.cloud.tpu.v2.Tpu", + "shortName": "Tpu" + }, + "shortName": "StartNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2.types.StartNodeRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "start_node" + }, + "description": "Sample for StartNode", + "file": "tpu_v2_generated_tpu_start_node_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2_generated_Tpu_StartNode_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2_generated_tpu_start_node_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v2.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v2.TpuAsyncClient.stop_node", + "method": { + "fullName": "google.cloud.tpu.v2.Tpu.StopNode", + "service": { + "fullName": "google.cloud.tpu.v2.Tpu", + "shortName": "Tpu" + }, + "shortName": "StopNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2.types.StopNodeRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "stop_node" + }, + "description": "Sample for StopNode", + "file": "tpu_v2_generated_tpu_stop_node_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2_generated_Tpu_StopNode_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2_generated_tpu_stop_node_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v2.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v2.TpuClient.stop_node", + "method": { + "fullName": "google.cloud.tpu.v2.Tpu.StopNode", + "service": { + "fullName": "google.cloud.tpu.v2.Tpu", + "shortName": "Tpu" + }, + "shortName": "StopNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2.types.StopNodeRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "stop_node" + }, + "description": "Sample for StopNode", + "file": "tpu_v2_generated_tpu_stop_node_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2_generated_Tpu_StopNode_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2_generated_tpu_stop_node_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v2.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v2.TpuAsyncClient.update_node", + "method": { + "fullName": "google.cloud.tpu.v2.Tpu.UpdateNode", + "service": { + "fullName": "google.cloud.tpu.v2.Tpu", + "shortName": "Tpu" + }, + "shortName": "UpdateNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2.types.UpdateNodeRequest" + }, + { + "name": "node", + "type": "google.cloud.tpu_v2.types.Node" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "update_node" + }, + "description": "Sample for UpdateNode", + "file": "tpu_v2_generated_tpu_update_node_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2_generated_Tpu_UpdateNode_async", + "segments": [ + { + "end": 59, + "start": 27, + "type": "FULL" + }, + { + "end": 59, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 49, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 56, + "start": 50, + "type": "REQUEST_EXECUTION" + }, + { + "end": 60, + "start": 57, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2_generated_tpu_update_node_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v2.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v2.TpuClient.update_node", + "method": { + "fullName": "google.cloud.tpu.v2.Tpu.UpdateNode", + "service": { + "fullName": "google.cloud.tpu.v2.Tpu", + "shortName": "Tpu" + }, + "shortName": "UpdateNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2.types.UpdateNodeRequest" + }, + { + "name": "node", + "type": "google.cloud.tpu_v2.types.Node" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "update_node" + }, + "description": "Sample for UpdateNode", + "file": "tpu_v2_generated_tpu_update_node_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2_generated_Tpu_UpdateNode_sync", + "segments": [ + { + "end": 59, + "start": 27, + "type": "FULL" + }, + { + "end": 59, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 49, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 56, + "start": 50, + "type": "REQUEST_EXECUTION" + }, + { + "end": 60, + "start": 57, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2_generated_tpu_update_node_sync.py" + } + ] +} diff --git a/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_create_node_async.py b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_create_node_async.py new file mode 100644 index 0000000..0d82401 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_create_node_async.py @@ -0,0 +1,61 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreateNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2_generated_Tpu_CreateNode_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2 + + +async def sample_create_node(): + # Create a client + client = tpu_v2.TpuAsyncClient() + + # Initialize request argument(s) + node = tpu_v2.Node() + node.accelerator_type = "accelerator_type_value" + node.runtime_version = "runtime_version_value" + + request = tpu_v2.CreateNodeRequest( + parent="parent_value", + node=node, + ) + + # Make the request + operation = client.create_node(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END tpu_v2_generated_Tpu_CreateNode_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_create_node_sync.py b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_create_node_sync.py new file mode 100644 index 0000000..87d373d --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_create_node_sync.py @@ -0,0 +1,61 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreateNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2_generated_Tpu_CreateNode_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2 + + +def sample_create_node(): + # Create a client + client = tpu_v2.TpuClient() + + # Initialize request argument(s) + node = tpu_v2.Node() + node.accelerator_type = "accelerator_type_value" + node.runtime_version = "runtime_version_value" + + request = tpu_v2.CreateNodeRequest( + parent="parent_value", + node=node, + ) + + # Make the request + operation = client.create_node(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END tpu_v2_generated_Tpu_CreateNode_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_delete_node_async.py b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_delete_node_async.py new file mode 100644 index 0000000..2ad90b2 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_delete_node_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2_generated_Tpu_DeleteNode_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2 + + +async def sample_delete_node(): + # Create a client + client = tpu_v2.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2.DeleteNodeRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_node(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END tpu_v2_generated_Tpu_DeleteNode_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_delete_node_sync.py b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_delete_node_sync.py new file mode 100644 index 0000000..85b6f71 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_delete_node_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2_generated_Tpu_DeleteNode_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2 + + +def sample_delete_node(): + # Create a client + client = tpu_v2.TpuClient() + + # Initialize request argument(s) + request = tpu_v2.DeleteNodeRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_node(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END tpu_v2_generated_Tpu_DeleteNode_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_generate_service_identity_async.py b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_generate_service_identity_async.py new file mode 100644 index 0000000..47f56aa --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_generate_service_identity_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GenerateServiceIdentity +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2_generated_Tpu_GenerateServiceIdentity_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2 + + +async def sample_generate_service_identity(): + # Create a client + client = tpu_v2.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2.GenerateServiceIdentityRequest( + parent="parent_value", + ) + + # Make the request + response = await client.generate_service_identity(request=request) + + # Handle the response + print(response) + +# [END tpu_v2_generated_Tpu_GenerateServiceIdentity_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_generate_service_identity_sync.py b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_generate_service_identity_sync.py new file mode 100644 index 0000000..ff62b65 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_generate_service_identity_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GenerateServiceIdentity +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2_generated_Tpu_GenerateServiceIdentity_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2 + + +def sample_generate_service_identity(): + # Create a client + client = tpu_v2.TpuClient() + + # Initialize request argument(s) + request = tpu_v2.GenerateServiceIdentityRequest( + parent="parent_value", + ) + + # Make the request + response = client.generate_service_identity(request=request) + + # Handle the response + print(response) + +# [END tpu_v2_generated_Tpu_GenerateServiceIdentity_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_get_accelerator_type_async.py b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_get_accelerator_type_async.py new file mode 100644 index 0000000..347789f --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_get_accelerator_type_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetAcceleratorType +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2_generated_Tpu_GetAcceleratorType_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2 + + +async def sample_get_accelerator_type(): + # Create a client + client = tpu_v2.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2.GetAcceleratorTypeRequest( + name="name_value", + ) + + # Make the request + response = await client.get_accelerator_type(request=request) + + # Handle the response + print(response) + +# [END tpu_v2_generated_Tpu_GetAcceleratorType_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_get_accelerator_type_sync.py b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_get_accelerator_type_sync.py new file mode 100644 index 0000000..b0adddc --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_get_accelerator_type_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetAcceleratorType +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2_generated_Tpu_GetAcceleratorType_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2 + + +def sample_get_accelerator_type(): + # Create a client + client = tpu_v2.TpuClient() + + # Initialize request argument(s) + request = tpu_v2.GetAcceleratorTypeRequest( + name="name_value", + ) + + # Make the request + response = client.get_accelerator_type(request=request) + + # Handle the response + print(response) + +# [END tpu_v2_generated_Tpu_GetAcceleratorType_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_get_guest_attributes_async.py b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_get_guest_attributes_async.py new file mode 100644 index 0000000..e2d96c9 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_get_guest_attributes_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetGuestAttributes +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2_generated_Tpu_GetGuestAttributes_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2 + + +async def sample_get_guest_attributes(): + # Create a client + client = tpu_v2.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2.GetGuestAttributesRequest( + name="name_value", + ) + + # Make the request + response = await client.get_guest_attributes(request=request) + + # Handle the response + print(response) + +# [END tpu_v2_generated_Tpu_GetGuestAttributes_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_get_guest_attributes_sync.py b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_get_guest_attributes_sync.py new file mode 100644 index 0000000..b8bb540 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_get_guest_attributes_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetGuestAttributes +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2_generated_Tpu_GetGuestAttributes_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2 + + +def sample_get_guest_attributes(): + # Create a client + client = tpu_v2.TpuClient() + + # Initialize request argument(s) + request = tpu_v2.GetGuestAttributesRequest( + name="name_value", + ) + + # Make the request + response = client.get_guest_attributes(request=request) + + # Handle the response + print(response) + +# [END tpu_v2_generated_Tpu_GetGuestAttributes_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_get_node_async.py b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_get_node_async.py new file mode 100644 index 0000000..4bb4c01 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_get_node_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2_generated_Tpu_GetNode_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2 + + +async def sample_get_node(): + # Create a client + client = tpu_v2.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2.GetNodeRequest( + name="name_value", + ) + + # Make the request + response = await client.get_node(request=request) + + # Handle the response + print(response) + +# [END tpu_v2_generated_Tpu_GetNode_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_get_node_sync.py b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_get_node_sync.py new file mode 100644 index 0000000..53f2db5 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_get_node_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2_generated_Tpu_GetNode_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2 + + +def sample_get_node(): + # Create a client + client = tpu_v2.TpuClient() + + # Initialize request argument(s) + request = tpu_v2.GetNodeRequest( + name="name_value", + ) + + # Make the request + response = client.get_node(request=request) + + # Handle the response + print(response) + +# [END tpu_v2_generated_Tpu_GetNode_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_get_runtime_version_async.py b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_get_runtime_version_async.py new file mode 100644 index 0000000..438e37d --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_get_runtime_version_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetRuntimeVersion +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2_generated_Tpu_GetRuntimeVersion_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2 + + +async def sample_get_runtime_version(): + # Create a client + client = tpu_v2.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2.GetRuntimeVersionRequest( + name="name_value", + ) + + # Make the request + response = await client.get_runtime_version(request=request) + + # Handle the response + print(response) + +# [END tpu_v2_generated_Tpu_GetRuntimeVersion_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_get_runtime_version_sync.py b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_get_runtime_version_sync.py new file mode 100644 index 0000000..d660e64 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_get_runtime_version_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetRuntimeVersion +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2_generated_Tpu_GetRuntimeVersion_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2 + + +def sample_get_runtime_version(): + # Create a client + client = tpu_v2.TpuClient() + + # Initialize request argument(s) + request = tpu_v2.GetRuntimeVersionRequest( + name="name_value", + ) + + # Make the request + response = client.get_runtime_version(request=request) + + # Handle the response + print(response) + +# [END tpu_v2_generated_Tpu_GetRuntimeVersion_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_list_accelerator_types_async.py b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_list_accelerator_types_async.py new file mode 100644 index 0000000..e465e5b --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_list_accelerator_types_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListAcceleratorTypes +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2_generated_Tpu_ListAcceleratorTypes_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2 + + +async def sample_list_accelerator_types(): + # Create a client + client = tpu_v2.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2.ListAcceleratorTypesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_accelerator_types(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END tpu_v2_generated_Tpu_ListAcceleratorTypes_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_list_accelerator_types_sync.py b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_list_accelerator_types_sync.py new file mode 100644 index 0000000..0e4e5f2 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_list_accelerator_types_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListAcceleratorTypes +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2_generated_Tpu_ListAcceleratorTypes_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2 + + +def sample_list_accelerator_types(): + # Create a client + client = tpu_v2.TpuClient() + + # Initialize request argument(s) + request = tpu_v2.ListAcceleratorTypesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_accelerator_types(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END tpu_v2_generated_Tpu_ListAcceleratorTypes_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_list_nodes_async.py b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_list_nodes_async.py new file mode 100644 index 0000000..a7e60a2 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_list_nodes_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListNodes +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2_generated_Tpu_ListNodes_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2 + + +async def sample_list_nodes(): + # Create a client + client = tpu_v2.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2.ListNodesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_nodes(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END tpu_v2_generated_Tpu_ListNodes_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_list_nodes_sync.py b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_list_nodes_sync.py new file mode 100644 index 0000000..6fb2442 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_list_nodes_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListNodes +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2_generated_Tpu_ListNodes_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2 + + +def sample_list_nodes(): + # Create a client + client = tpu_v2.TpuClient() + + # Initialize request argument(s) + request = tpu_v2.ListNodesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_nodes(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END tpu_v2_generated_Tpu_ListNodes_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_list_runtime_versions_async.py b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_list_runtime_versions_async.py new file mode 100644 index 0000000..13a67c5 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_list_runtime_versions_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListRuntimeVersions +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2_generated_Tpu_ListRuntimeVersions_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2 + + +async def sample_list_runtime_versions(): + # Create a client + client = tpu_v2.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2.ListRuntimeVersionsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_runtime_versions(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END tpu_v2_generated_Tpu_ListRuntimeVersions_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_list_runtime_versions_sync.py b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_list_runtime_versions_sync.py new file mode 100644 index 0000000..f46392f --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_list_runtime_versions_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListRuntimeVersions +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2_generated_Tpu_ListRuntimeVersions_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2 + + +def sample_list_runtime_versions(): + # Create a client + client = tpu_v2.TpuClient() + + # Initialize request argument(s) + request = tpu_v2.ListRuntimeVersionsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_runtime_versions(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END tpu_v2_generated_Tpu_ListRuntimeVersions_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_start_node_async.py b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_start_node_async.py new file mode 100644 index 0000000..04584e0 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_start_node_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for StartNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2_generated_Tpu_StartNode_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2 + + +async def sample_start_node(): + # Create a client + client = tpu_v2.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2.StartNodeRequest( + name="name_value", + ) + + # Make the request + operation = client.start_node(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END tpu_v2_generated_Tpu_StartNode_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_start_node_sync.py b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_start_node_sync.py new file mode 100644 index 0000000..9099169 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_start_node_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for StartNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2_generated_Tpu_StartNode_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2 + + +def sample_start_node(): + # Create a client + client = tpu_v2.TpuClient() + + # Initialize request argument(s) + request = tpu_v2.StartNodeRequest( + name="name_value", + ) + + # Make the request + operation = client.start_node(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END tpu_v2_generated_Tpu_StartNode_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_stop_node_async.py b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_stop_node_async.py new file mode 100644 index 0000000..6d93181 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_stop_node_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for StopNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2_generated_Tpu_StopNode_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2 + + +async def sample_stop_node(): + # Create a client + client = tpu_v2.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2.StopNodeRequest( + name="name_value", + ) + + # Make the request + operation = client.stop_node(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END tpu_v2_generated_Tpu_StopNode_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_stop_node_sync.py b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_stop_node_sync.py new file mode 100644 index 0000000..8fd4911 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_stop_node_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for StopNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2_generated_Tpu_StopNode_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2 + + +def sample_stop_node(): + # Create a client + client = tpu_v2.TpuClient() + + # Initialize request argument(s) + request = tpu_v2.StopNodeRequest( + name="name_value", + ) + + # Make the request + operation = client.stop_node(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END tpu_v2_generated_Tpu_StopNode_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_update_node_async.py b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_update_node_async.py new file mode 100644 index 0000000..7f841de --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_update_node_async.py @@ -0,0 +1,60 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2_generated_Tpu_UpdateNode_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2 + + +async def sample_update_node(): + # Create a client + client = tpu_v2.TpuAsyncClient() + + # Initialize request argument(s) + node = tpu_v2.Node() + node.accelerator_type = "accelerator_type_value" + node.runtime_version = "runtime_version_value" + + request = tpu_v2.UpdateNodeRequest( + node=node, + ) + + # Make the request + operation = client.update_node(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END tpu_v2_generated_Tpu_UpdateNode_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_update_node_sync.py b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_update_node_sync.py new file mode 100644 index 0000000..d0e1950 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/tpu_v2_generated_tpu_update_node_sync.py @@ -0,0 +1,60 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2_generated_Tpu_UpdateNode_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2 + + +def sample_update_node(): + # Create a client + client = tpu_v2.TpuClient() + + # Initialize request argument(s) + node = tpu_v2.Node() + node.accelerator_type = "accelerator_type_value" + node.runtime_version = "runtime_version_value" + + request = tpu_v2.UpdateNodeRequest( + node=node, + ) + + # Make the request + operation = client.update_node(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END tpu_v2_generated_Tpu_UpdateNode_sync] diff --git a/owl-bot-staging/v2/scripts/fixup_tpu_v2_keywords.py b/owl-bot-staging/v2/scripts/fixup_tpu_v2_keywords.py new file mode 100644 index 0000000..a0b0231 --- /dev/null +++ b/owl-bot-staging/v2/scripts/fixup_tpu_v2_keywords.py @@ -0,0 +1,188 @@ +#! /usr/bin/env python3 +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import argparse +import os +import libcst as cst +import pathlib +import sys +from typing import (Any, Callable, Dict, List, Sequence, Tuple) + + +def partition( + predicate: Callable[[Any], bool], + iterator: Sequence[Any] +) -> Tuple[List[Any], List[Any]]: + """A stable, out-of-place partition.""" + results = ([], []) + + for i in iterator: + results[int(predicate(i))].append(i) + + # Returns trueList, falseList + return results[1], results[0] + + +class tpuCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'create_node': ('parent', 'node', 'node_id', ), + 'delete_node': ('name', ), + 'generate_service_identity': ('parent', ), + 'get_accelerator_type': ('name', ), + 'get_guest_attributes': ('name', 'query_path', 'worker_ids', ), + 'get_node': ('name', ), + 'get_runtime_version': ('name', ), + 'list_accelerator_types': ('parent', 'page_size', 'page_token', 'filter', 'order_by', ), + 'list_nodes': ('parent', 'page_size', 'page_token', ), + 'list_runtime_versions': ('parent', 'page_size', 'page_token', 'filter', 'order_by', ), + 'start_node': ('name', ), + 'stop_node': ('name', ), + 'update_node': ('update_mask', 'node', ), + } + + def leave_Call(self, original: cst.Call, updated: cst.Call) -> cst.CSTNode: + try: + key = original.func.attr.value + kword_params = self.METHOD_TO_PARAMS[key] + except (AttributeError, KeyError): + # Either not a method from the API or too convoluted to be sure. + return updated + + # If the existing code is valid, keyword args come after positional args. + # Therefore, all positional args must map to the first parameters. + args, kwargs = partition(lambda a: not bool(a.keyword), updated.args) + if any(k.keyword.value == "request" for k in kwargs): + # We've already fixed this file, don't fix it again. + return updated + + kwargs, ctrl_kwargs = partition( + lambda a: a.keyword.value not in self.CTRL_PARAMS, + kwargs + ) + + args, ctrl_args = args[:len(kword_params)], args[len(kword_params):] + ctrl_kwargs.extend(cst.Arg(value=a.value, keyword=cst.Name(value=ctrl)) + for a, ctrl in zip(ctrl_args, self.CTRL_PARAMS)) + + request_arg = cst.Arg( + value=cst.Dict([ + cst.DictElement( + cst.SimpleString("'{}'".format(name)), +cst.Element(value=arg.value) + ) + # Note: the args + kwargs looks silly, but keep in mind that + # the control parameters had to be stripped out, and that + # those could have been passed positionally or by keyword. + for name, arg in zip(kword_params, args + kwargs)]), + keyword=cst.Name("request") + ) + + return updated.with_changes( + args=[request_arg] + ctrl_kwargs + ) + + +def fix_files( + in_dir: pathlib.Path, + out_dir: pathlib.Path, + *, + transformer=tpuCallTransformer(), +): + """Duplicate the input dir to the output dir, fixing file method calls. + + Preconditions: + * in_dir is a real directory + * out_dir is a real, empty directory + """ + pyfile_gen = ( + pathlib.Path(os.path.join(root, f)) + for root, _, files in os.walk(in_dir) + for f in files if os.path.splitext(f)[1] == ".py" + ) + + for fpath in pyfile_gen: + with open(fpath, 'r') as f: + src = f.read() + + # Parse the code and insert method call fixes. + tree = cst.parse_module(src) + updated = tree.visit(transformer) + + # Create the path and directory structure for the new file. + updated_path = out_dir.joinpath(fpath.relative_to(in_dir)) + updated_path.parent.mkdir(parents=True, exist_ok=True) + + # Generate the updated source file at the corresponding path. + with open(updated_path, 'w') as f: + f.write(updated.code) + + +if __name__ == '__main__': + parser = argparse.ArgumentParser( + description="""Fix up source that uses the tpu client library. + +The existing sources are NOT overwritten but are copied to output_dir with changes made. + +Note: This tool operates at a best-effort level at converting positional + parameters in client method calls to keyword based parameters. + Cases where it WILL FAIL include + A) * or ** expansion in a method call. + B) Calls via function or method alias (includes free function calls) + C) Indirect or dispatched calls (e.g. the method is looked up dynamically) + + These all constitute false negatives. The tool will also detect false + positives when an API method shares a name with another method. +""") + parser.add_argument( + '-d', + '--input-directory', + required=True, + dest='input_dir', + help='the input directory to walk for python files to fix up', + ) + parser.add_argument( + '-o', + '--output-directory', + required=True, + dest='output_dir', + help='the directory to output files fixed via un-flattening', + ) + args = parser.parse_args() + input_dir = pathlib.Path(args.input_dir) + output_dir = pathlib.Path(args.output_dir) + if not input_dir.is_dir(): + print( + f"input directory '{input_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if not output_dir.is_dir(): + print( + f"output directory '{output_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if os.listdir(output_dir): + print( + f"output directory '{output_dir}' is not empty", + file=sys.stderr, + ) + sys.exit(-1) + + fix_files(input_dir, output_dir) diff --git a/owl-bot-staging/v2/setup.py b/owl-bot-staging/v2/setup.py new file mode 100644 index 0000000..47305e6 --- /dev/null +++ b/owl-bot-staging/v2/setup.py @@ -0,0 +1,90 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import io +import os + +import setuptools # type: ignore + +package_root = os.path.abspath(os.path.dirname(__file__)) + +name = 'google-cloud-tpu' + + +description = "Google Cloud Tpu API client library" + +version = {} +with open(os.path.join(package_root, 'google/cloud/tpu/gapic_version.py')) as fp: + exec(fp.read(), version) +version = version["__version__"] + +if version[0] == "0": + release_status = "Development Status :: 4 - Beta" +else: + release_status = "Development Status :: 5 - Production/Stable" + +dependencies = [ + "google-api-core[grpc] >= 1.34.0, <3.0.0dev,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*", + "proto-plus >= 1.22.0, <2.0.0dev", + "proto-plus >= 1.22.2, <2.0.0dev; python_version>='3.11'", + "protobuf>=3.19.5,<5.0.0dev,!=3.20.0,!=3.20.1,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", +] +url = "https://github.com/googleapis/python-tpu" + +package_root = os.path.abspath(os.path.dirname(__file__)) + +readme_filename = os.path.join(package_root, "README.rst") +with io.open(readme_filename, encoding="utf-8") as readme_file: + readme = readme_file.read() + +packages = [ + package + for package in setuptools.PEP420PackageFinder.find() + if package.startswith("google") +] + +namespaces = ["google", "google.cloud"] + +setuptools.setup( + name=name, + version=version, + description=description, + long_description=readme, + author="Google LLC", + author_email="googleapis-packages@google.com", + license="Apache 2.0", + url=url, + classifiers=[ + release_status, + "Intended Audience :: Developers", + "License :: OSI Approved :: Apache Software License", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Operating System :: OS Independent", + "Topic :: Internet", + ], + platforms="Posix; MacOS X; Windows", + packages=packages, + python_requires=">=3.7", + namespace_packages=namespaces, + install_requires=dependencies, + include_package_data=True, + zip_safe=False, +) diff --git a/owl-bot-staging/v2/testing/constraints-3.10.txt b/owl-bot-staging/v2/testing/constraints-3.10.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.10.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.11.txt b/owl-bot-staging/v2/testing/constraints-3.11.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.11.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.12.txt b/owl-bot-staging/v2/testing/constraints-3.12.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.12.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.7.txt b/owl-bot-staging/v2/testing/constraints-3.7.txt new file mode 100644 index 0000000..6c44adf --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.7.txt @@ -0,0 +1,9 @@ +# This constraints file is used to check that lower bounds +# are correct in setup.py +# List all library dependencies and extras in this file. +# Pin the version to the lower bound. +# e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0dev", +# Then this file should have google-cloud-foo==1.14.0 +google-api-core==1.34.0 +proto-plus==1.22.0 +protobuf==3.19.5 diff --git a/owl-bot-staging/v2/testing/constraints-3.8.txt b/owl-bot-staging/v2/testing/constraints-3.8.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.8.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.9.txt b/owl-bot-staging/v2/testing/constraints-3.9.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.9.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/tests/__init__.py b/owl-bot-staging/v2/tests/__init__.py new file mode 100644 index 0000000..231bc12 --- /dev/null +++ b/owl-bot-staging/v2/tests/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v2/tests/unit/__init__.py b/owl-bot-staging/v2/tests/unit/__init__.py new file mode 100644 index 0000000..231bc12 --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v2/tests/unit/gapic/__init__.py b/owl-bot-staging/v2/tests/unit/gapic/__init__.py new file mode 100644 index 0000000..231bc12 --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/gapic/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v2/tests/unit/gapic/tpu_v2/__init__.py b/owl-bot-staging/v2/tests/unit/gapic/tpu_v2/__init__.py new file mode 100644 index 0000000..231bc12 --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/gapic/tpu_v2/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v2/tests/unit/gapic/tpu_v2/test_tpu.py b/owl-bot-staging/v2/tests/unit/gapic/tpu_v2/test_tpu.py new file mode 100644 index 0000000..7056b8d --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/gapic/tpu_v2/test_tpu.py @@ -0,0 +1,8760 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +# try/except added for compatibility with python < 3.8 +try: + from unittest import mock + from unittest.mock import AsyncMock # pragma: NO COVER +except ImportError: # pragma: NO COVER + import mock + +import grpc +from grpc.experimental import aio +from collections.abc import Iterable +from google.protobuf import json_format +import json +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule +from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format + +from google.api_core import client_options +from google.api_core import exceptions as core_exceptions +from google.api_core import future +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers +from google.api_core import grpc_helpers_async +from google.api_core import operation +from google.api_core import operation_async # type: ignore +from google.api_core import operations_v1 +from google.api_core import path_template +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.cloud.location import locations_pb2 +from google.cloud.tpu_v2.services.tpu import TpuAsyncClient +from google.cloud.tpu_v2.services.tpu import TpuClient +from google.cloud.tpu_v2.services.tpu import pagers +from google.cloud.tpu_v2.services.tpu import transports +from google.cloud.tpu_v2.types import cloud_tpu +from google.longrunning import operations_pb2 +from google.oauth2 import service_account +from google.protobuf import empty_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +import google.auth + + +def client_cert_source_callback(): + return b"cert bytes", b"key bytes" + + +# If default endpoint is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint(client): + return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT + + +def test__get_default_mtls_endpoint(): + api_endpoint = "example.googleapis.com" + api_mtls_endpoint = "example.mtls.googleapis.com" + sandbox_endpoint = "example.sandbox.googleapis.com" + sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" + non_googleapi = "api.example.com" + + assert TpuClient._get_default_mtls_endpoint(None) is None + assert TpuClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + assert TpuClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint + assert TpuClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint + assert TpuClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint + assert TpuClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + + +@pytest.mark.parametrize("client_class,transport_name", [ + (TpuClient, "grpc"), + (TpuAsyncClient, "grpc_asyncio"), + (TpuClient, "rest"), +]) +def test_tpu_client_from_service_account_info(client_class, transport_name): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: + factory.return_value = creds + info = {"valid": True} + client = client_class.from_service_account_info(info, transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'tpu.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://tpu.googleapis.com' + ) + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.TpuGrpcTransport, "grpc"), + (transports.TpuGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.TpuRestTransport, "rest"), +]) +def test_tpu_client_service_account_always_use_jwt(transport_class, transport_name): + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=True) + use_jwt.assert_called_once_with(True) + + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=False) + use_jwt.assert_not_called() + + +@pytest.mark.parametrize("client_class,transport_name", [ + (TpuClient, "grpc"), + (TpuAsyncClient, "grpc_asyncio"), + (TpuClient, "rest"), +]) +def test_tpu_client_from_service_account_file(client_class, transport_name): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: + factory.return_value = creds + client = client_class.from_service_account_file("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'tpu.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://tpu.googleapis.com' + ) + + +def test_tpu_client_get_transport_class(): + transport = TpuClient.get_transport_class() + available_transports = [ + transports.TpuGrpcTransport, + transports.TpuRestTransport, + ] + assert transport in available_transports + + transport = TpuClient.get_transport_class("grpc") + assert transport == transports.TpuGrpcTransport + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (TpuClient, transports.TpuGrpcTransport, "grpc"), + (TpuAsyncClient, transports.TpuGrpcAsyncIOTransport, "grpc_asyncio"), + (TpuClient, transports.TpuRestTransport, "rest"), +]) +@mock.patch.object(TpuClient, "DEFAULT_ENDPOINT", modify_default_endpoint(TpuClient)) +@mock.patch.object(TpuAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(TpuAsyncClient)) +def test_tpu_client_client_options(client_class, transport_class, transport_name): + # Check that if channel is provided we won't create a new one. + with mock.patch.object(TpuClient, 'get_transport_class') as gtc: + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ) + client = client_class(transport=transport) + gtc.assert_not_called() + + # Check that if channel is provided via str we will create a new one. + with mock.patch.object(TpuClient, 'get_transport_class') as gtc: + client = client_class(transport=transport_name) + gtc.assert_called() + + # Check the case api_endpoint is provided. + options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name, client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_MTLS_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError): + client = client_class(transport=transport_name) + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): + with pytest.raises(ValueError): + client = client_class(transport=transport_name) + + # Check the case quota_project_id is provided + options = client_options.ClientOptions(quota_project_id="octopus") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id="octopus", + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + # Check the case api_endpoint is provided + options = client_options.ClientOptions(api_audience="https://language.googleapis.com") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience="https://language.googleapis.com" + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ + (TpuClient, transports.TpuGrpcTransport, "grpc", "true"), + (TpuAsyncClient, transports.TpuGrpcAsyncIOTransport, "grpc_asyncio", "true"), + (TpuClient, transports.TpuGrpcTransport, "grpc", "false"), + (TpuAsyncClient, transports.TpuGrpcAsyncIOTransport, "grpc_asyncio", "false"), + (TpuClient, transports.TpuRestTransport, "rest", "true"), + (TpuClient, transports.TpuRestTransport, "rest", "false"), +]) +@mock.patch.object(TpuClient, "DEFAULT_ENDPOINT", modify_default_endpoint(TpuClient)) +@mock.patch.object(TpuAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(TpuAsyncClient)) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_tpu_client_mtls_env_auto(client_class, transport_class, transport_name, use_client_cert_env): + # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default + # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. + + # Check the case client_cert_source is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + options = client_options.ClientOptions(client_cert_source=client_cert_source_callback) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + + if use_client_cert_env == "false": + expected_client_cert_source = None + expected_host = client.DEFAULT_ENDPOINT + else: + expected_client_cert_source = client_cert_source_callback + expected_host = client.DEFAULT_MTLS_ENDPOINT + + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case ADC client cert is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): + if use_client_cert_env == "false": + expected_host = client.DEFAULT_ENDPOINT + expected_client_cert_source = None + else: + expected_host = client.DEFAULT_MTLS_ENDPOINT + expected_client_cert_source = client_cert_source_callback + + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case client_cert_source and ADC client cert are not provided. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize("client_class", [ + TpuClient, TpuAsyncClient +]) +@mock.patch.object(TpuClient, "DEFAULT_ENDPOINT", modify_default_endpoint(TpuClient)) +@mock.patch.object(TpuAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(TpuAsyncClient)) +def test_tpu_client_get_mtls_endpoint_and_cert_source(client_class): + mock_client_cert_source = mock.Mock() + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "true". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + mock_api_endpoint = "foo" + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + assert api_endpoint == mock_api_endpoint + assert cert_source == mock_client_cert_source + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "false". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + mock_client_cert_source = mock.Mock() + mock_api_endpoint = "foo" + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + assert api_endpoint == mock_api_endpoint + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert doesn't exist. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=False): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert exists. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=mock_client_cert_source): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source == mock_client_cert_source + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (TpuClient, transports.TpuGrpcTransport, "grpc"), + (TpuAsyncClient, transports.TpuGrpcAsyncIOTransport, "grpc_asyncio"), + (TpuClient, transports.TpuRestTransport, "rest"), +]) +def test_tpu_client_client_options_scopes(client_class, transport_class, transport_name): + # Check the case scopes are provided. + options = client_options.ClientOptions( + scopes=["1", "2"], + ) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=["1", "2"], + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ + (TpuClient, transports.TpuGrpcTransport, "grpc", grpc_helpers), + (TpuAsyncClient, transports.TpuGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), + (TpuClient, transports.TpuRestTransport, "rest", None), +]) +def test_tpu_client_client_options_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + +def test_tpu_client_client_options_from_dict(): + with mock.patch('google.cloud.tpu_v2.services.tpu.transports.TpuGrpcTransport.__init__') as grpc_transport: + grpc_transport.return_value = None + client = TpuClient( + client_options={'api_endpoint': 'squid.clam.whelk'} + ) + grpc_transport.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ + (TpuClient, transports.TpuGrpcTransport, "grpc", grpc_helpers), + (TpuAsyncClient, transports.TpuGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), +]) +def test_tpu_client_create_channel_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # test that the credentials from file are saved and used as the credentials. + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel" + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + file_creds = ga_credentials.AnonymousCredentials() + load_creds.return_value = (file_creds, None) + adc.return_value = (creds, None) + client = client_class(client_options=options, transport=transport_name) + create_channel.assert_called_with( + "tpu.googleapis.com:443", + credentials=file_creds, + credentials_file=None, + quota_project_id=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + scopes=None, + default_host="tpu.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.ListNodesRequest, + dict, +]) +def test_list_nodes(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_nodes), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.ListNodesResponse( + next_page_token='next_page_token_value', + unreachable=['unreachable_value'], + ) + response = client.list_nodes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.ListNodesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListNodesPager) + assert response.next_page_token == 'next_page_token_value' + assert response.unreachable == ['unreachable_value'] + + +def test_list_nodes_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_nodes), + '__call__') as call: + client.list_nodes() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.ListNodesRequest() + +@pytest.mark.asyncio +async def test_list_nodes_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.ListNodesRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_nodes), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.ListNodesResponse( + next_page_token='next_page_token_value', + unreachable=['unreachable_value'], + )) + response = await client.list_nodes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.ListNodesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListNodesAsyncPager) + assert response.next_page_token == 'next_page_token_value' + assert response.unreachable == ['unreachable_value'] + + +@pytest.mark.asyncio +async def test_list_nodes_async_from_dict(): + await test_list_nodes_async(request_type=dict) + + +def test_list_nodes_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.ListNodesRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_nodes), + '__call__') as call: + call.return_value = cloud_tpu.ListNodesResponse() + client.list_nodes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_list_nodes_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.ListNodesRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_nodes), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.ListNodesResponse()) + await client.list_nodes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +def test_list_nodes_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_nodes), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.ListNodesResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_nodes( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + + +def test_list_nodes_flattened_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_nodes( + cloud_tpu.ListNodesRequest(), + parent='parent_value', + ) + +@pytest.mark.asyncio +async def test_list_nodes_flattened_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_nodes), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.ListNodesResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.ListNodesResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_nodes( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_list_nodes_flattened_error_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_nodes( + cloud_tpu.ListNodesRequest(), + parent='parent_value', + ) + + +def test_list_nodes_pager(transport_name: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_nodes), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + cloud_tpu.Node(), + cloud_tpu.Node(), + ], + next_page_token='abc', + ), + cloud_tpu.ListNodesResponse( + nodes=[], + next_page_token='def', + ), + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + cloud_tpu.Node(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_nodes(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, cloud_tpu.Node) + for i in results) +def test_list_nodes_pages(transport_name: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_nodes), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + cloud_tpu.Node(), + cloud_tpu.Node(), + ], + next_page_token='abc', + ), + cloud_tpu.ListNodesResponse( + nodes=[], + next_page_token='def', + ), + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + cloud_tpu.Node(), + ], + ), + RuntimeError, + ) + pages = list(client.list_nodes(request={}).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.asyncio +async def test_list_nodes_async_pager(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_nodes), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + cloud_tpu.Node(), + cloud_tpu.Node(), + ], + next_page_token='abc', + ), + cloud_tpu.ListNodesResponse( + nodes=[], + next_page_token='def', + ), + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + cloud_tpu.Node(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_nodes(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, cloud_tpu.Node) + for i in responses) + + +@pytest.mark.asyncio +async def test_list_nodes_async_pages(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_nodes), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + cloud_tpu.Node(), + cloud_tpu.Node(), + ], + next_page_token='abc', + ), + cloud_tpu.ListNodesResponse( + nodes=[], + next_page_token='def', + ), + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + cloud_tpu.Node(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_nodes(request={})).pages: # pragma: no branch + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.GetNodeRequest, + dict, +]) +def test_get_node(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.Node( + name='name_value', + description='description_value', + accelerator_type='accelerator_type_value', + state=cloud_tpu.Node.State.CREATING, + health_description='health_description_value', + runtime_version='runtime_version_value', + cidr_block='cidr_block_value', + health=cloud_tpu.Node.Health.HEALTHY, + tags=['tags_value'], + id=205, + api_version=cloud_tpu.Node.ApiVersion.V1_ALPHA1, + ) + response = client.get_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_tpu.Node) + assert response.name == 'name_value' + assert response.description == 'description_value' + assert response.accelerator_type == 'accelerator_type_value' + assert response.state == cloud_tpu.Node.State.CREATING + assert response.health_description == 'health_description_value' + assert response.runtime_version == 'runtime_version_value' + assert response.cidr_block == 'cidr_block_value' + assert response.health == cloud_tpu.Node.Health.HEALTHY + assert response.tags == ['tags_value'] + assert response.id == 205 + assert response.api_version == cloud_tpu.Node.ApiVersion.V1_ALPHA1 + + +def test_get_node_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_node), + '__call__') as call: + client.get_node() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetNodeRequest() + +@pytest.mark.asyncio +async def test_get_node_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.GetNodeRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.Node( + name='name_value', + description='description_value', + accelerator_type='accelerator_type_value', + state=cloud_tpu.Node.State.CREATING, + health_description='health_description_value', + runtime_version='runtime_version_value', + cidr_block='cidr_block_value', + health=cloud_tpu.Node.Health.HEALTHY, + tags=['tags_value'], + id=205, + api_version=cloud_tpu.Node.ApiVersion.V1_ALPHA1, + )) + response = await client.get_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_tpu.Node) + assert response.name == 'name_value' + assert response.description == 'description_value' + assert response.accelerator_type == 'accelerator_type_value' + assert response.state == cloud_tpu.Node.State.CREATING + assert response.health_description == 'health_description_value' + assert response.runtime_version == 'runtime_version_value' + assert response.cidr_block == 'cidr_block_value' + assert response.health == cloud_tpu.Node.Health.HEALTHY + assert response.tags == ['tags_value'] + assert response.id == 205 + assert response.api_version == cloud_tpu.Node.ApiVersion.V1_ALPHA1 + + +@pytest.mark.asyncio +async def test_get_node_async_from_dict(): + await test_get_node_async(request_type=dict) + + +def test_get_node_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.GetNodeRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_node), + '__call__') as call: + call.return_value = cloud_tpu.Node() + client.get_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_get_node_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.GetNodeRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_node), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.Node()) + await client.get_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +def test_get_node_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.Node() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_node( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_get_node_flattened_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_node( + cloud_tpu.GetNodeRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_get_node_flattened_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.Node() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.Node()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_node( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_get_node_flattened_error_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_node( + cloud_tpu.GetNodeRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.CreateNodeRequest, + dict, +]) +def test_create_node(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.create_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.CreateNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_create_node_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_node), + '__call__') as call: + client.create_node() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.CreateNodeRequest() + +@pytest.mark.asyncio +async def test_create_node_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.CreateNodeRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.create_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.CreateNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_create_node_async_from_dict(): + await test_create_node_async(request_type=dict) + + +def test_create_node_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.CreateNodeRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_node), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.create_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_create_node_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.CreateNodeRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_node), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.create_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +def test_create_node_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_node( + parent='parent_value', + node=cloud_tpu.Node(name='name_value'), + node_id='node_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].node + mock_val = cloud_tpu.Node(name='name_value') + assert arg == mock_val + arg = args[0].node_id + mock_val = 'node_id_value' + assert arg == mock_val + + +def test_create_node_flattened_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_node( + cloud_tpu.CreateNodeRequest(), + parent='parent_value', + node=cloud_tpu.Node(name='name_value'), + node_id='node_id_value', + ) + +@pytest.mark.asyncio +async def test_create_node_flattened_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_node( + parent='parent_value', + node=cloud_tpu.Node(name='name_value'), + node_id='node_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].node + mock_val = cloud_tpu.Node(name='name_value') + assert arg == mock_val + arg = args[0].node_id + mock_val = 'node_id_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_create_node_flattened_error_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.create_node( + cloud_tpu.CreateNodeRequest(), + parent='parent_value', + node=cloud_tpu.Node(name='name_value'), + node_id='node_id_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.DeleteNodeRequest, + dict, +]) +def test_delete_node(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.delete_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.DeleteNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_delete_node_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_node), + '__call__') as call: + client.delete_node() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.DeleteNodeRequest() + +@pytest.mark.asyncio +async def test_delete_node_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.DeleteNodeRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.delete_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.DeleteNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_delete_node_async_from_dict(): + await test_delete_node_async(request_type=dict) + + +def test_delete_node_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.DeleteNodeRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_node), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.delete_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_delete_node_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.DeleteNodeRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_node), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.delete_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +def test_delete_node_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.delete_node( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_delete_node_flattened_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_node( + cloud_tpu.DeleteNodeRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_delete_node_flattened_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.delete_node( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_delete_node_flattened_error_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.delete_node( + cloud_tpu.DeleteNodeRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.StopNodeRequest, + dict, +]) +def test_stop_node(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.stop_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.stop_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.StopNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_stop_node_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.stop_node), + '__call__') as call: + client.stop_node() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.StopNodeRequest() + +@pytest.mark.asyncio +async def test_stop_node_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.StopNodeRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.stop_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.stop_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.StopNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_stop_node_async_from_dict(): + await test_stop_node_async(request_type=dict) + + +def test_stop_node_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.StopNodeRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.stop_node), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.stop_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_stop_node_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.StopNodeRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.stop_node), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.stop_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.StartNodeRequest, + dict, +]) +def test_start_node(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.start_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.start_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.StartNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_start_node_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.start_node), + '__call__') as call: + client.start_node() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.StartNodeRequest() + +@pytest.mark.asyncio +async def test_start_node_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.StartNodeRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.start_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.start_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.StartNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_start_node_async_from_dict(): + await test_start_node_async(request_type=dict) + + +def test_start_node_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.StartNodeRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.start_node), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.start_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_start_node_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.StartNodeRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.start_node), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.start_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.UpdateNodeRequest, + dict, +]) +def test_update_node(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.update_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.UpdateNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_update_node_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_node), + '__call__') as call: + client.update_node() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.UpdateNodeRequest() + +@pytest.mark.asyncio +async def test_update_node_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.UpdateNodeRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.update_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.UpdateNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_update_node_async_from_dict(): + await test_update_node_async(request_type=dict) + + +def test_update_node_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.UpdateNodeRequest() + + request.node.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_node), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.update_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'node.name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_node_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.UpdateNodeRequest() + + request.node.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_node), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.update_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'node.name=name_value', + ) in kw['metadata'] + + +def test_update_node_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_node( + node=cloud_tpu.Node(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].node + mock_val = cloud_tpu.Node(name='name_value') + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val + + +def test_update_node_flattened_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_node( + cloud_tpu.UpdateNodeRequest(), + node=cloud_tpu.Node(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + +@pytest.mark.asyncio +async def test_update_node_flattened_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_node( + node=cloud_tpu.Node(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].node + mock_val = cloud_tpu.Node(name='name_value') + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val + +@pytest.mark.asyncio +async def test_update_node_flattened_error_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.update_node( + cloud_tpu.UpdateNodeRequest(), + node=cloud_tpu.Node(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.GenerateServiceIdentityRequest, + dict, +]) +def test_generate_service_identity(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.generate_service_identity), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.GenerateServiceIdentityResponse( + ) + response = client.generate_service_identity(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GenerateServiceIdentityRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_tpu.GenerateServiceIdentityResponse) + + +def test_generate_service_identity_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.generate_service_identity), + '__call__') as call: + client.generate_service_identity() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GenerateServiceIdentityRequest() + +@pytest.mark.asyncio +async def test_generate_service_identity_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.GenerateServiceIdentityRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.generate_service_identity), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.GenerateServiceIdentityResponse( + )) + response = await client.generate_service_identity(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GenerateServiceIdentityRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_tpu.GenerateServiceIdentityResponse) + + +@pytest.mark.asyncio +async def test_generate_service_identity_async_from_dict(): + await test_generate_service_identity_async(request_type=dict) + + +def test_generate_service_identity_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.GenerateServiceIdentityRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.generate_service_identity), + '__call__') as call: + call.return_value = cloud_tpu.GenerateServiceIdentityResponse() + client.generate_service_identity(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_generate_service_identity_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.GenerateServiceIdentityRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.generate_service_identity), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.GenerateServiceIdentityResponse()) + await client.generate_service_identity(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.ListAcceleratorTypesRequest, + dict, +]) +def test_list_accelerator_types(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_accelerator_types), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.ListAcceleratorTypesResponse( + next_page_token='next_page_token_value', + unreachable=['unreachable_value'], + ) + response = client.list_accelerator_types(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.ListAcceleratorTypesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListAcceleratorTypesPager) + assert response.next_page_token == 'next_page_token_value' + assert response.unreachable == ['unreachable_value'] + + +def test_list_accelerator_types_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_accelerator_types), + '__call__') as call: + client.list_accelerator_types() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.ListAcceleratorTypesRequest() + +@pytest.mark.asyncio +async def test_list_accelerator_types_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.ListAcceleratorTypesRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_accelerator_types), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.ListAcceleratorTypesResponse( + next_page_token='next_page_token_value', + unreachable=['unreachable_value'], + )) + response = await client.list_accelerator_types(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.ListAcceleratorTypesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListAcceleratorTypesAsyncPager) + assert response.next_page_token == 'next_page_token_value' + assert response.unreachable == ['unreachable_value'] + + +@pytest.mark.asyncio +async def test_list_accelerator_types_async_from_dict(): + await test_list_accelerator_types_async(request_type=dict) + + +def test_list_accelerator_types_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.ListAcceleratorTypesRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_accelerator_types), + '__call__') as call: + call.return_value = cloud_tpu.ListAcceleratorTypesResponse() + client.list_accelerator_types(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_list_accelerator_types_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.ListAcceleratorTypesRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_accelerator_types), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.ListAcceleratorTypesResponse()) + await client.list_accelerator_types(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +def test_list_accelerator_types_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_accelerator_types), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.ListAcceleratorTypesResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_accelerator_types( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + + +def test_list_accelerator_types_flattened_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_accelerator_types( + cloud_tpu.ListAcceleratorTypesRequest(), + parent='parent_value', + ) + +@pytest.mark.asyncio +async def test_list_accelerator_types_flattened_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_accelerator_types), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.ListAcceleratorTypesResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.ListAcceleratorTypesResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_accelerator_types( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_list_accelerator_types_flattened_error_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_accelerator_types( + cloud_tpu.ListAcceleratorTypesRequest(), + parent='parent_value', + ) + + +def test_list_accelerator_types_pager(transport_name: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_accelerator_types), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + ], + next_page_token='abc', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[], + next_page_token='def', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_accelerator_types(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, cloud_tpu.AcceleratorType) + for i in results) +def test_list_accelerator_types_pages(transport_name: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_accelerator_types), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + ], + next_page_token='abc', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[], + next_page_token='def', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + ], + ), + RuntimeError, + ) + pages = list(client.list_accelerator_types(request={}).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.asyncio +async def test_list_accelerator_types_async_pager(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_accelerator_types), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + ], + next_page_token='abc', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[], + next_page_token='def', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_accelerator_types(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, cloud_tpu.AcceleratorType) + for i in responses) + + +@pytest.mark.asyncio +async def test_list_accelerator_types_async_pages(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_accelerator_types), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + ], + next_page_token='abc', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[], + next_page_token='def', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_accelerator_types(request={})).pages: # pragma: no branch + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.GetAcceleratorTypeRequest, + dict, +]) +def test_get_accelerator_type(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_accelerator_type), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.AcceleratorType( + name='name_value', + type_='type__value', + ) + response = client.get_accelerator_type(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetAcceleratorTypeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_tpu.AcceleratorType) + assert response.name == 'name_value' + assert response.type_ == 'type__value' + + +def test_get_accelerator_type_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_accelerator_type), + '__call__') as call: + client.get_accelerator_type() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetAcceleratorTypeRequest() + +@pytest.mark.asyncio +async def test_get_accelerator_type_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.GetAcceleratorTypeRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_accelerator_type), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.AcceleratorType( + name='name_value', + type_='type__value', + )) + response = await client.get_accelerator_type(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetAcceleratorTypeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_tpu.AcceleratorType) + assert response.name == 'name_value' + assert response.type_ == 'type__value' + + +@pytest.mark.asyncio +async def test_get_accelerator_type_async_from_dict(): + await test_get_accelerator_type_async(request_type=dict) + + +def test_get_accelerator_type_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.GetAcceleratorTypeRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_accelerator_type), + '__call__') as call: + call.return_value = cloud_tpu.AcceleratorType() + client.get_accelerator_type(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_get_accelerator_type_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.GetAcceleratorTypeRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_accelerator_type), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.AcceleratorType()) + await client.get_accelerator_type(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +def test_get_accelerator_type_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_accelerator_type), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.AcceleratorType() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_accelerator_type( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_get_accelerator_type_flattened_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_accelerator_type( + cloud_tpu.GetAcceleratorTypeRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_get_accelerator_type_flattened_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_accelerator_type), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.AcceleratorType() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.AcceleratorType()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_accelerator_type( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_get_accelerator_type_flattened_error_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_accelerator_type( + cloud_tpu.GetAcceleratorTypeRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.ListRuntimeVersionsRequest, + dict, +]) +def test_list_runtime_versions(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_runtime_versions), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.ListRuntimeVersionsResponse( + next_page_token='next_page_token_value', + unreachable=['unreachable_value'], + ) + response = client.list_runtime_versions(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.ListRuntimeVersionsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListRuntimeVersionsPager) + assert response.next_page_token == 'next_page_token_value' + assert response.unreachable == ['unreachable_value'] + + +def test_list_runtime_versions_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_runtime_versions), + '__call__') as call: + client.list_runtime_versions() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.ListRuntimeVersionsRequest() + +@pytest.mark.asyncio +async def test_list_runtime_versions_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.ListRuntimeVersionsRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_runtime_versions), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.ListRuntimeVersionsResponse( + next_page_token='next_page_token_value', + unreachable=['unreachable_value'], + )) + response = await client.list_runtime_versions(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.ListRuntimeVersionsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListRuntimeVersionsAsyncPager) + assert response.next_page_token == 'next_page_token_value' + assert response.unreachable == ['unreachable_value'] + + +@pytest.mark.asyncio +async def test_list_runtime_versions_async_from_dict(): + await test_list_runtime_versions_async(request_type=dict) + + +def test_list_runtime_versions_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.ListRuntimeVersionsRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_runtime_versions), + '__call__') as call: + call.return_value = cloud_tpu.ListRuntimeVersionsResponse() + client.list_runtime_versions(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_list_runtime_versions_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.ListRuntimeVersionsRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_runtime_versions), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.ListRuntimeVersionsResponse()) + await client.list_runtime_versions(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +def test_list_runtime_versions_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_runtime_versions), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.ListRuntimeVersionsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_runtime_versions( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + + +def test_list_runtime_versions_flattened_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_runtime_versions( + cloud_tpu.ListRuntimeVersionsRequest(), + parent='parent_value', + ) + +@pytest.mark.asyncio +async def test_list_runtime_versions_flattened_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_runtime_versions), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.ListRuntimeVersionsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.ListRuntimeVersionsResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_runtime_versions( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_list_runtime_versions_flattened_error_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_runtime_versions( + cloud_tpu.ListRuntimeVersionsRequest(), + parent='parent_value', + ) + + +def test_list_runtime_versions_pager(transport_name: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_runtime_versions), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[ + cloud_tpu.RuntimeVersion(), + cloud_tpu.RuntimeVersion(), + cloud_tpu.RuntimeVersion(), + ], + next_page_token='abc', + ), + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[], + next_page_token='def', + ), + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[ + cloud_tpu.RuntimeVersion(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[ + cloud_tpu.RuntimeVersion(), + cloud_tpu.RuntimeVersion(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_runtime_versions(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, cloud_tpu.RuntimeVersion) + for i in results) +def test_list_runtime_versions_pages(transport_name: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_runtime_versions), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[ + cloud_tpu.RuntimeVersion(), + cloud_tpu.RuntimeVersion(), + cloud_tpu.RuntimeVersion(), + ], + next_page_token='abc', + ), + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[], + next_page_token='def', + ), + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[ + cloud_tpu.RuntimeVersion(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[ + cloud_tpu.RuntimeVersion(), + cloud_tpu.RuntimeVersion(), + ], + ), + RuntimeError, + ) + pages = list(client.list_runtime_versions(request={}).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.asyncio +async def test_list_runtime_versions_async_pager(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_runtime_versions), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[ + cloud_tpu.RuntimeVersion(), + cloud_tpu.RuntimeVersion(), + cloud_tpu.RuntimeVersion(), + ], + next_page_token='abc', + ), + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[], + next_page_token='def', + ), + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[ + cloud_tpu.RuntimeVersion(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[ + cloud_tpu.RuntimeVersion(), + cloud_tpu.RuntimeVersion(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_runtime_versions(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, cloud_tpu.RuntimeVersion) + for i in responses) + + +@pytest.mark.asyncio +async def test_list_runtime_versions_async_pages(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_runtime_versions), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[ + cloud_tpu.RuntimeVersion(), + cloud_tpu.RuntimeVersion(), + cloud_tpu.RuntimeVersion(), + ], + next_page_token='abc', + ), + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[], + next_page_token='def', + ), + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[ + cloud_tpu.RuntimeVersion(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[ + cloud_tpu.RuntimeVersion(), + cloud_tpu.RuntimeVersion(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_runtime_versions(request={})).pages: # pragma: no branch + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.GetRuntimeVersionRequest, + dict, +]) +def test_get_runtime_version(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_runtime_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.RuntimeVersion( + name='name_value', + version='version_value', + ) + response = client.get_runtime_version(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetRuntimeVersionRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_tpu.RuntimeVersion) + assert response.name == 'name_value' + assert response.version == 'version_value' + + +def test_get_runtime_version_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_runtime_version), + '__call__') as call: + client.get_runtime_version() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetRuntimeVersionRequest() + +@pytest.mark.asyncio +async def test_get_runtime_version_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.GetRuntimeVersionRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_runtime_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.RuntimeVersion( + name='name_value', + version='version_value', + )) + response = await client.get_runtime_version(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetRuntimeVersionRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_tpu.RuntimeVersion) + assert response.name == 'name_value' + assert response.version == 'version_value' + + +@pytest.mark.asyncio +async def test_get_runtime_version_async_from_dict(): + await test_get_runtime_version_async(request_type=dict) + + +def test_get_runtime_version_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.GetRuntimeVersionRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_runtime_version), + '__call__') as call: + call.return_value = cloud_tpu.RuntimeVersion() + client.get_runtime_version(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_get_runtime_version_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.GetRuntimeVersionRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_runtime_version), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.RuntimeVersion()) + await client.get_runtime_version(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +def test_get_runtime_version_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_runtime_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.RuntimeVersion() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_runtime_version( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_get_runtime_version_flattened_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_runtime_version( + cloud_tpu.GetRuntimeVersionRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_get_runtime_version_flattened_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_runtime_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.RuntimeVersion() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.RuntimeVersion()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_runtime_version( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_get_runtime_version_flattened_error_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_runtime_version( + cloud_tpu.GetRuntimeVersionRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.GetGuestAttributesRequest, + dict, +]) +def test_get_guest_attributes(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_guest_attributes), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.GetGuestAttributesResponse( + ) + response = client.get_guest_attributes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetGuestAttributesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_tpu.GetGuestAttributesResponse) + + +def test_get_guest_attributes_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_guest_attributes), + '__call__') as call: + client.get_guest_attributes() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetGuestAttributesRequest() + +@pytest.mark.asyncio +async def test_get_guest_attributes_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.GetGuestAttributesRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_guest_attributes), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.GetGuestAttributesResponse( + )) + response = await client.get_guest_attributes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetGuestAttributesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_tpu.GetGuestAttributesResponse) + + +@pytest.mark.asyncio +async def test_get_guest_attributes_async_from_dict(): + await test_get_guest_attributes_async(request_type=dict) + + +def test_get_guest_attributes_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.GetGuestAttributesRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_guest_attributes), + '__call__') as call: + call.return_value = cloud_tpu.GetGuestAttributesResponse() + client.get_guest_attributes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_get_guest_attributes_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.GetGuestAttributesRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_guest_attributes), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.GetGuestAttributesResponse()) + await client.get_guest_attributes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.ListNodesRequest, + dict, +]) +def test_list_nodes_rest(request_type): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_tpu.ListNodesResponse( + next_page_token='next_page_token_value', + unreachable=['unreachable_value'], + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = cloud_tpu.ListNodesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.list_nodes(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListNodesPager) + assert response.next_page_token == 'next_page_token_value' + assert response.unreachable == ['unreachable_value'] + + +def test_list_nodes_rest_required_fields(request_type=cloud_tpu.ListNodesRequest): + transport_class = transports.TpuRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_nodes._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = 'parent_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_nodes._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("page_size", "page_token", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == 'parent_value' + + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = cloud_tpu.ListNodesResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = cloud_tpu.ListNodesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_nodes(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_list_nodes_rest_unset_required_fields(): + transport = transports.TpuRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.list_nodes._get_unset_required_fields({}) + assert set(unset_fields) == (set(("pageSize", "pageToken", )) & set(("parent", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_nodes_rest_interceptors(null_interceptor): + transport = transports.TpuRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.TpuRestInterceptor(), + ) + client = TpuClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.TpuRestInterceptor, "post_list_nodes") as post, \ + mock.patch.object(transports.TpuRestInterceptor, "pre_list_nodes") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_tpu.ListNodesRequest.pb(cloud_tpu.ListNodesRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = cloud_tpu.ListNodesResponse.to_json(cloud_tpu.ListNodesResponse()) + + request = cloud_tpu.ListNodesRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = cloud_tpu.ListNodesResponse() + + client.list_nodes(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_nodes_rest_bad_request(transport: str = 'rest', request_type=cloud_tpu.ListNodesRequest): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_nodes(request) + + +def test_list_nodes_rest_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_tpu.ListNodesResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'parent': 'projects/sample1/locations/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + parent='parent_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = cloud_tpu.ListNodesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.list_nodes(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/{parent=projects/*/locations/*}/nodes" % client.transport._host, args[1]) + + +def test_list_nodes_rest_flattened_error(transport: str = 'rest'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_nodes( + cloud_tpu.ListNodesRequest(), + parent='parent_value', + ) + + +def test_list_nodes_rest_pager(transport: str = 'rest'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + #with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + cloud_tpu.Node(), + cloud_tpu.Node(), + ], + next_page_token='abc', + ), + cloud_tpu.ListNodesResponse( + nodes=[], + next_page_token='def', + ), + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + cloud_tpu.Node(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple(cloud_tpu.ListNodesResponse.to_json(x) for x in response) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode('UTF-8') + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = {'parent': 'projects/sample1/locations/sample2'} + + pager = client.list_nodes(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, cloud_tpu.Node) + for i in results) + + pages = list(client.list_nodes(request=sample_request).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.GetNodeRequest, + dict, +]) +def test_get_node_rest(request_type): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/nodes/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_tpu.Node( + name='name_value', + description='description_value', + accelerator_type='accelerator_type_value', + state=cloud_tpu.Node.State.CREATING, + health_description='health_description_value', + runtime_version='runtime_version_value', + cidr_block='cidr_block_value', + health=cloud_tpu.Node.Health.HEALTHY, + tags=['tags_value'], + id=205, + api_version=cloud_tpu.Node.ApiVersion.V1_ALPHA1, + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = cloud_tpu.Node.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.get_node(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_tpu.Node) + assert response.name == 'name_value' + assert response.description == 'description_value' + assert response.accelerator_type == 'accelerator_type_value' + assert response.state == cloud_tpu.Node.State.CREATING + assert response.health_description == 'health_description_value' + assert response.runtime_version == 'runtime_version_value' + assert response.cidr_block == 'cidr_block_value' + assert response.health == cloud_tpu.Node.Health.HEALTHY + assert response.tags == ['tags_value'] + assert response.id == 205 + assert response.api_version == cloud_tpu.Node.ApiVersion.V1_ALPHA1 + + +def test_get_node_rest_required_fields(request_type=cloud_tpu.GetNodeRequest): + transport_class = transports.TpuRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_node._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = 'name_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_node._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == 'name_value' + + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = cloud_tpu.Node() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = cloud_tpu.Node.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.get_node(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_get_node_rest_unset_required_fields(): + transport = transports.TpuRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.get_node._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_node_rest_interceptors(null_interceptor): + transport = transports.TpuRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.TpuRestInterceptor(), + ) + client = TpuClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.TpuRestInterceptor, "post_get_node") as post, \ + mock.patch.object(transports.TpuRestInterceptor, "pre_get_node") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_tpu.GetNodeRequest.pb(cloud_tpu.GetNodeRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = cloud_tpu.Node.to_json(cloud_tpu.Node()) + + request = cloud_tpu.GetNodeRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = cloud_tpu.Node() + + client.get_node(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_node_rest_bad_request(transport: str = 'rest', request_type=cloud_tpu.GetNodeRequest): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/nodes/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_node(request) + + +def test_get_node_rest_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_tpu.Node() + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/nodes/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = cloud_tpu.Node.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.get_node(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/{name=projects/*/locations/*/nodes/*}" % client.transport._host, args[1]) + + +def test_get_node_rest_flattened_error(transport: str = 'rest'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_node( + cloud_tpu.GetNodeRequest(), + name='name_value', + ) + + +def test_get_node_rest_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.CreateNodeRequest, + dict, +]) +def test_create_node_rest(request_type): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request_init["node"] = {'name': 'name_value', 'description': 'description_value', 'accelerator_type': 'accelerator_type_value', 'state': 1, 'health_description': 'health_description_value', 'runtime_version': 'runtime_version_value', 'network_config': {'network': 'network_value', 'subnetwork': 'subnetwork_value', 'enable_external_ips': True, 'can_ip_forward': True}, 'cidr_block': 'cidr_block_value', 'service_account': {'email': 'email_value', 'scope': ['scope_value1', 'scope_value2']}, 'create_time': {'seconds': 751, 'nanos': 543}, 'scheduling_config': {'preemptible': True, 'reserved': True}, 'network_endpoints': [{'ip_address': 'ip_address_value', 'port': 453, 'access_config': {'external_ip': 'external_ip_value'}}], 'health': 1, 'labels': {}, 'metadata': {}, 'tags': ['tags_value1', 'tags_value2'], 'id': 205, 'data_disks': [{'source_disk': 'source_disk_value', 'mode': 1}], 'api_version': 1, 'symptoms': [{'create_time': {}, 'symptom_type': 1, 'details': 'details_value', 'worker_id': 'worker_id_value'}], 'shielded_instance_config': {'enable_secure_boot': True}, 'accelerator_config': {'type_': 2, 'topology': 'topology_value'}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.create_node(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_create_node_rest_required_fields(request_type=cloud_tpu.CreateNodeRequest): + transport_class = transports.TpuRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_node._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = 'parent_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_node._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("node_id", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == 'parent_value' + + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.create_node(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_create_node_rest_unset_required_fields(): + transport = transports.TpuRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.create_node._get_unset_required_fields({}) + assert set(unset_fields) == (set(("nodeId", )) & set(("parent", "node", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_node_rest_interceptors(null_interceptor): + transport = transports.TpuRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.TpuRestInterceptor(), + ) + client = TpuClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.TpuRestInterceptor, "post_create_node") as post, \ + mock.patch.object(transports.TpuRestInterceptor, "pre_create_node") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_tpu.CreateNodeRequest.pb(cloud_tpu.CreateNodeRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = cloud_tpu.CreateNodeRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.create_node(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_create_node_rest_bad_request(transport: str = 'rest', request_type=cloud_tpu.CreateNodeRequest): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request_init["node"] = {'name': 'name_value', 'description': 'description_value', 'accelerator_type': 'accelerator_type_value', 'state': 1, 'health_description': 'health_description_value', 'runtime_version': 'runtime_version_value', 'network_config': {'network': 'network_value', 'subnetwork': 'subnetwork_value', 'enable_external_ips': True, 'can_ip_forward': True}, 'cidr_block': 'cidr_block_value', 'service_account': {'email': 'email_value', 'scope': ['scope_value1', 'scope_value2']}, 'create_time': {'seconds': 751, 'nanos': 543}, 'scheduling_config': {'preemptible': True, 'reserved': True}, 'network_endpoints': [{'ip_address': 'ip_address_value', 'port': 453, 'access_config': {'external_ip': 'external_ip_value'}}], 'health': 1, 'labels': {}, 'metadata': {}, 'tags': ['tags_value1', 'tags_value2'], 'id': 205, 'data_disks': [{'source_disk': 'source_disk_value', 'mode': 1}], 'api_version': 1, 'symptoms': [{'create_time': {}, 'symptom_type': 1, 'details': 'details_value', 'worker_id': 'worker_id_value'}], 'shielded_instance_config': {'enable_secure_boot': True}, 'accelerator_config': {'type_': 2, 'topology': 'topology_value'}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.create_node(request) + + +def test_create_node_rest_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # get arguments that satisfy an http rule for this method + sample_request = {'parent': 'projects/sample1/locations/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + parent='parent_value', + node=cloud_tpu.Node(name='name_value'), + node_id='node_id_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.create_node(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/{parent=projects/*/locations/*}/nodes" % client.transport._host, args[1]) + + +def test_create_node_rest_flattened_error(transport: str = 'rest'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_node( + cloud_tpu.CreateNodeRequest(), + parent='parent_value', + node=cloud_tpu.Node(name='name_value'), + node_id='node_id_value', + ) + + +def test_create_node_rest_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.DeleteNodeRequest, + dict, +]) +def test_delete_node_rest(request_type): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/nodes/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.delete_node(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_delete_node_rest_required_fields(request_type=cloud_tpu.DeleteNodeRequest): + transport_class = transports.TpuRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_node._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = 'name_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_node._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == 'name_value' + + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "delete", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.delete_node(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_delete_node_rest_unset_required_fields(): + transport = transports.TpuRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.delete_node._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_node_rest_interceptors(null_interceptor): + transport = transports.TpuRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.TpuRestInterceptor(), + ) + client = TpuClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.TpuRestInterceptor, "post_delete_node") as post, \ + mock.patch.object(transports.TpuRestInterceptor, "pre_delete_node") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_tpu.DeleteNodeRequest.pb(cloud_tpu.DeleteNodeRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = cloud_tpu.DeleteNodeRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.delete_node(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_delete_node_rest_bad_request(transport: str = 'rest', request_type=cloud_tpu.DeleteNodeRequest): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/nodes/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.delete_node(request) + + +def test_delete_node_rest_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/nodes/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.delete_node(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/{name=projects/*/locations/*/nodes/*}" % client.transport._host, args[1]) + + +def test_delete_node_rest_flattened_error(transport: str = 'rest'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_node( + cloud_tpu.DeleteNodeRequest(), + name='name_value', + ) + + +def test_delete_node_rest_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.StopNodeRequest, + dict, +]) +def test_stop_node_rest(request_type): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/nodes/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.stop_node(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_stop_node_rest_required_fields(request_type=cloud_tpu.StopNodeRequest): + transport_class = transports.TpuRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).stop_node._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = 'name_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).stop_node._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == 'name_value' + + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.stop_node(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_stop_node_rest_unset_required_fields(): + transport = transports.TpuRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.stop_node._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_stop_node_rest_interceptors(null_interceptor): + transport = transports.TpuRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.TpuRestInterceptor(), + ) + client = TpuClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.TpuRestInterceptor, "post_stop_node") as post, \ + mock.patch.object(transports.TpuRestInterceptor, "pre_stop_node") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_tpu.StopNodeRequest.pb(cloud_tpu.StopNodeRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = cloud_tpu.StopNodeRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.stop_node(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_stop_node_rest_bad_request(transport: str = 'rest', request_type=cloud_tpu.StopNodeRequest): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/nodes/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.stop_node(request) + + +def test_stop_node_rest_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.StartNodeRequest, + dict, +]) +def test_start_node_rest(request_type): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/nodes/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.start_node(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_start_node_rest_required_fields(request_type=cloud_tpu.StartNodeRequest): + transport_class = transports.TpuRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).start_node._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = 'name_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).start_node._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == 'name_value' + + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.start_node(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_start_node_rest_unset_required_fields(): + transport = transports.TpuRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.start_node._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_start_node_rest_interceptors(null_interceptor): + transport = transports.TpuRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.TpuRestInterceptor(), + ) + client = TpuClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.TpuRestInterceptor, "post_start_node") as post, \ + mock.patch.object(transports.TpuRestInterceptor, "pre_start_node") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_tpu.StartNodeRequest.pb(cloud_tpu.StartNodeRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = cloud_tpu.StartNodeRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.start_node(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_start_node_rest_bad_request(transport: str = 'rest', request_type=cloud_tpu.StartNodeRequest): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/nodes/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.start_node(request) + + +def test_start_node_rest_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.UpdateNodeRequest, + dict, +]) +def test_update_node_rest(request_type): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'node': {'name': 'projects/sample1/locations/sample2/nodes/sample3'}} + request_init["node"] = {'name': 'projects/sample1/locations/sample2/nodes/sample3', 'description': 'description_value', 'accelerator_type': 'accelerator_type_value', 'state': 1, 'health_description': 'health_description_value', 'runtime_version': 'runtime_version_value', 'network_config': {'network': 'network_value', 'subnetwork': 'subnetwork_value', 'enable_external_ips': True, 'can_ip_forward': True}, 'cidr_block': 'cidr_block_value', 'service_account': {'email': 'email_value', 'scope': ['scope_value1', 'scope_value2']}, 'create_time': {'seconds': 751, 'nanos': 543}, 'scheduling_config': {'preemptible': True, 'reserved': True}, 'network_endpoints': [{'ip_address': 'ip_address_value', 'port': 453, 'access_config': {'external_ip': 'external_ip_value'}}], 'health': 1, 'labels': {}, 'metadata': {}, 'tags': ['tags_value1', 'tags_value2'], 'id': 205, 'data_disks': [{'source_disk': 'source_disk_value', 'mode': 1}], 'api_version': 1, 'symptoms': [{'create_time': {}, 'symptom_type': 1, 'details': 'details_value', 'worker_id': 'worker_id_value'}], 'shielded_instance_config': {'enable_secure_boot': True}, 'accelerator_config': {'type_': 2, 'topology': 'topology_value'}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.update_node(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_update_node_rest_required_fields(request_type=cloud_tpu.UpdateNodeRequest): + transport_class = transports.TpuRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_node._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_node._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("update_mask", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "patch", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.update_node(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_update_node_rest_unset_required_fields(): + transport = transports.TpuRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.update_node._get_unset_required_fields({}) + assert set(unset_fields) == (set(("updateMask", )) & set(("updateMask", "node", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_node_rest_interceptors(null_interceptor): + transport = transports.TpuRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.TpuRestInterceptor(), + ) + client = TpuClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(operation.Operation, "_set_result_from_operation"), \ + mock.patch.object(transports.TpuRestInterceptor, "post_update_node") as post, \ + mock.patch.object(transports.TpuRestInterceptor, "pre_update_node") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_tpu.UpdateNodeRequest.pb(cloud_tpu.UpdateNodeRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) + + request = cloud_tpu.UpdateNodeRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.update_node(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_node_rest_bad_request(transport: str = 'rest', request_type=cloud_tpu.UpdateNodeRequest): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'node': {'name': 'projects/sample1/locations/sample2/nodes/sample3'}} + request_init["node"] = {'name': 'projects/sample1/locations/sample2/nodes/sample3', 'description': 'description_value', 'accelerator_type': 'accelerator_type_value', 'state': 1, 'health_description': 'health_description_value', 'runtime_version': 'runtime_version_value', 'network_config': {'network': 'network_value', 'subnetwork': 'subnetwork_value', 'enable_external_ips': True, 'can_ip_forward': True}, 'cidr_block': 'cidr_block_value', 'service_account': {'email': 'email_value', 'scope': ['scope_value1', 'scope_value2']}, 'create_time': {'seconds': 751, 'nanos': 543}, 'scheduling_config': {'preemptible': True, 'reserved': True}, 'network_endpoints': [{'ip_address': 'ip_address_value', 'port': 453, 'access_config': {'external_ip': 'external_ip_value'}}], 'health': 1, 'labels': {}, 'metadata': {}, 'tags': ['tags_value1', 'tags_value2'], 'id': 205, 'data_disks': [{'source_disk': 'source_disk_value', 'mode': 1}], 'api_version': 1, 'symptoms': [{'create_time': {}, 'symptom_type': 1, 'details': 'details_value', 'worker_id': 'worker_id_value'}], 'shielded_instance_config': {'enable_secure_boot': True}, 'accelerator_config': {'type_': 2, 'topology': 'topology_value'}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.update_node(request) + + +def test_update_node_rest_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name='operations/spam') + + # get arguments that satisfy an http rule for this method + sample_request = {'node': {'name': 'projects/sample1/locations/sample2/nodes/sample3'}} + + # get truthy value for each flattened field + mock_args = dict( + node=cloud_tpu.Node(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.update_node(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/{node.name=projects/*/locations/*/nodes/*}" % client.transport._host, args[1]) + + +def test_update_node_rest_flattened_error(transport: str = 'rest'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_node( + cloud_tpu.UpdateNodeRequest(), + node=cloud_tpu.Node(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +def test_update_node_rest_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.GenerateServiceIdentityRequest, + dict, +]) +def test_generate_service_identity_rest(request_type): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_tpu.GenerateServiceIdentityResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = cloud_tpu.GenerateServiceIdentityResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.generate_service_identity(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_tpu.GenerateServiceIdentityResponse) + + +def test_generate_service_identity_rest_required_fields(request_type=cloud_tpu.GenerateServiceIdentityRequest): + transport_class = transports.TpuRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).generate_service_identity._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = 'parent_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).generate_service_identity._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == 'parent_value' + + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = cloud_tpu.GenerateServiceIdentityResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = cloud_tpu.GenerateServiceIdentityResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.generate_service_identity(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_generate_service_identity_rest_unset_required_fields(): + transport = transports.TpuRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.generate_service_identity._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("parent", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_generate_service_identity_rest_interceptors(null_interceptor): + transport = transports.TpuRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.TpuRestInterceptor(), + ) + client = TpuClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.TpuRestInterceptor, "post_generate_service_identity") as post, \ + mock.patch.object(transports.TpuRestInterceptor, "pre_generate_service_identity") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_tpu.GenerateServiceIdentityRequest.pb(cloud_tpu.GenerateServiceIdentityRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = cloud_tpu.GenerateServiceIdentityResponse.to_json(cloud_tpu.GenerateServiceIdentityResponse()) + + request = cloud_tpu.GenerateServiceIdentityRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = cloud_tpu.GenerateServiceIdentityResponse() + + client.generate_service_identity(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_generate_service_identity_rest_bad_request(transport: str = 'rest', request_type=cloud_tpu.GenerateServiceIdentityRequest): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.generate_service_identity(request) + + +def test_generate_service_identity_rest_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.ListAcceleratorTypesRequest, + dict, +]) +def test_list_accelerator_types_rest(request_type): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_tpu.ListAcceleratorTypesResponse( + next_page_token='next_page_token_value', + unreachable=['unreachable_value'], + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = cloud_tpu.ListAcceleratorTypesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.list_accelerator_types(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListAcceleratorTypesPager) + assert response.next_page_token == 'next_page_token_value' + assert response.unreachable == ['unreachable_value'] + + +def test_list_accelerator_types_rest_required_fields(request_type=cloud_tpu.ListAcceleratorTypesRequest): + transport_class = transports.TpuRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_accelerator_types._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = 'parent_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_accelerator_types._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("filter", "order_by", "page_size", "page_token", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == 'parent_value' + + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = cloud_tpu.ListAcceleratorTypesResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = cloud_tpu.ListAcceleratorTypesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_accelerator_types(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_list_accelerator_types_rest_unset_required_fields(): + transport = transports.TpuRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.list_accelerator_types._get_unset_required_fields({}) + assert set(unset_fields) == (set(("filter", "orderBy", "pageSize", "pageToken", )) & set(("parent", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_accelerator_types_rest_interceptors(null_interceptor): + transport = transports.TpuRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.TpuRestInterceptor(), + ) + client = TpuClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.TpuRestInterceptor, "post_list_accelerator_types") as post, \ + mock.patch.object(transports.TpuRestInterceptor, "pre_list_accelerator_types") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_tpu.ListAcceleratorTypesRequest.pb(cloud_tpu.ListAcceleratorTypesRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = cloud_tpu.ListAcceleratorTypesResponse.to_json(cloud_tpu.ListAcceleratorTypesResponse()) + + request = cloud_tpu.ListAcceleratorTypesRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = cloud_tpu.ListAcceleratorTypesResponse() + + client.list_accelerator_types(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_accelerator_types_rest_bad_request(transport: str = 'rest', request_type=cloud_tpu.ListAcceleratorTypesRequest): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_accelerator_types(request) + + +def test_list_accelerator_types_rest_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_tpu.ListAcceleratorTypesResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'parent': 'projects/sample1/locations/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + parent='parent_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = cloud_tpu.ListAcceleratorTypesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.list_accelerator_types(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/{parent=projects/*/locations/*}/acceleratorTypes" % client.transport._host, args[1]) + + +def test_list_accelerator_types_rest_flattened_error(transport: str = 'rest'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_accelerator_types( + cloud_tpu.ListAcceleratorTypesRequest(), + parent='parent_value', + ) + + +def test_list_accelerator_types_rest_pager(transport: str = 'rest'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + #with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + ], + next_page_token='abc', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[], + next_page_token='def', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple(cloud_tpu.ListAcceleratorTypesResponse.to_json(x) for x in response) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode('UTF-8') + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = {'parent': 'projects/sample1/locations/sample2'} + + pager = client.list_accelerator_types(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, cloud_tpu.AcceleratorType) + for i in results) + + pages = list(client.list_accelerator_types(request=sample_request).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.GetAcceleratorTypeRequest, + dict, +]) +def test_get_accelerator_type_rest(request_type): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/acceleratorTypes/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_tpu.AcceleratorType( + name='name_value', + type_='type__value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = cloud_tpu.AcceleratorType.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.get_accelerator_type(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_tpu.AcceleratorType) + assert response.name == 'name_value' + assert response.type_ == 'type__value' + + +def test_get_accelerator_type_rest_required_fields(request_type=cloud_tpu.GetAcceleratorTypeRequest): + transport_class = transports.TpuRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_accelerator_type._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = 'name_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_accelerator_type._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == 'name_value' + + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = cloud_tpu.AcceleratorType() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = cloud_tpu.AcceleratorType.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.get_accelerator_type(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_get_accelerator_type_rest_unset_required_fields(): + transport = transports.TpuRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.get_accelerator_type._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_accelerator_type_rest_interceptors(null_interceptor): + transport = transports.TpuRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.TpuRestInterceptor(), + ) + client = TpuClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.TpuRestInterceptor, "post_get_accelerator_type") as post, \ + mock.patch.object(transports.TpuRestInterceptor, "pre_get_accelerator_type") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_tpu.GetAcceleratorTypeRequest.pb(cloud_tpu.GetAcceleratorTypeRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = cloud_tpu.AcceleratorType.to_json(cloud_tpu.AcceleratorType()) + + request = cloud_tpu.GetAcceleratorTypeRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = cloud_tpu.AcceleratorType() + + client.get_accelerator_type(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_accelerator_type_rest_bad_request(transport: str = 'rest', request_type=cloud_tpu.GetAcceleratorTypeRequest): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/acceleratorTypes/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_accelerator_type(request) + + +def test_get_accelerator_type_rest_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_tpu.AcceleratorType() + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/acceleratorTypes/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = cloud_tpu.AcceleratorType.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.get_accelerator_type(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/{name=projects/*/locations/*/acceleratorTypes/*}" % client.transport._host, args[1]) + + +def test_get_accelerator_type_rest_flattened_error(transport: str = 'rest'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_accelerator_type( + cloud_tpu.GetAcceleratorTypeRequest(), + name='name_value', + ) + + +def test_get_accelerator_type_rest_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.ListRuntimeVersionsRequest, + dict, +]) +def test_list_runtime_versions_rest(request_type): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_tpu.ListRuntimeVersionsResponse( + next_page_token='next_page_token_value', + unreachable=['unreachable_value'], + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = cloud_tpu.ListRuntimeVersionsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.list_runtime_versions(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListRuntimeVersionsPager) + assert response.next_page_token == 'next_page_token_value' + assert response.unreachable == ['unreachable_value'] + + +def test_list_runtime_versions_rest_required_fields(request_type=cloud_tpu.ListRuntimeVersionsRequest): + transport_class = transports.TpuRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_runtime_versions._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = 'parent_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_runtime_versions._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("filter", "order_by", "page_size", "page_token", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == 'parent_value' + + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = cloud_tpu.ListRuntimeVersionsResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = cloud_tpu.ListRuntimeVersionsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_runtime_versions(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_list_runtime_versions_rest_unset_required_fields(): + transport = transports.TpuRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.list_runtime_versions._get_unset_required_fields({}) + assert set(unset_fields) == (set(("filter", "orderBy", "pageSize", "pageToken", )) & set(("parent", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_runtime_versions_rest_interceptors(null_interceptor): + transport = transports.TpuRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.TpuRestInterceptor(), + ) + client = TpuClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.TpuRestInterceptor, "post_list_runtime_versions") as post, \ + mock.patch.object(transports.TpuRestInterceptor, "pre_list_runtime_versions") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_tpu.ListRuntimeVersionsRequest.pb(cloud_tpu.ListRuntimeVersionsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = cloud_tpu.ListRuntimeVersionsResponse.to_json(cloud_tpu.ListRuntimeVersionsResponse()) + + request = cloud_tpu.ListRuntimeVersionsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = cloud_tpu.ListRuntimeVersionsResponse() + + client.list_runtime_versions(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_runtime_versions_rest_bad_request(transport: str = 'rest', request_type=cloud_tpu.ListRuntimeVersionsRequest): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_runtime_versions(request) + + +def test_list_runtime_versions_rest_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_tpu.ListRuntimeVersionsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'parent': 'projects/sample1/locations/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + parent='parent_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = cloud_tpu.ListRuntimeVersionsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.list_runtime_versions(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/{parent=projects/*/locations/*}/runtimeVersions" % client.transport._host, args[1]) + + +def test_list_runtime_versions_rest_flattened_error(transport: str = 'rest'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_runtime_versions( + cloud_tpu.ListRuntimeVersionsRequest(), + parent='parent_value', + ) + + +def test_list_runtime_versions_rest_pager(transport: str = 'rest'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + #with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[ + cloud_tpu.RuntimeVersion(), + cloud_tpu.RuntimeVersion(), + cloud_tpu.RuntimeVersion(), + ], + next_page_token='abc', + ), + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[], + next_page_token='def', + ), + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[ + cloud_tpu.RuntimeVersion(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[ + cloud_tpu.RuntimeVersion(), + cloud_tpu.RuntimeVersion(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple(cloud_tpu.ListRuntimeVersionsResponse.to_json(x) for x in response) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode('UTF-8') + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = {'parent': 'projects/sample1/locations/sample2'} + + pager = client.list_runtime_versions(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, cloud_tpu.RuntimeVersion) + for i in results) + + pages = list(client.list_runtime_versions(request=sample_request).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.GetRuntimeVersionRequest, + dict, +]) +def test_get_runtime_version_rest(request_type): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/runtimeVersions/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_tpu.RuntimeVersion( + name='name_value', + version='version_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = cloud_tpu.RuntimeVersion.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.get_runtime_version(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_tpu.RuntimeVersion) + assert response.name == 'name_value' + assert response.version == 'version_value' + + +def test_get_runtime_version_rest_required_fields(request_type=cloud_tpu.GetRuntimeVersionRequest): + transport_class = transports.TpuRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_runtime_version._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = 'name_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_runtime_version._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == 'name_value' + + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = cloud_tpu.RuntimeVersion() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = cloud_tpu.RuntimeVersion.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.get_runtime_version(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_get_runtime_version_rest_unset_required_fields(): + transport = transports.TpuRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.get_runtime_version._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_runtime_version_rest_interceptors(null_interceptor): + transport = transports.TpuRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.TpuRestInterceptor(), + ) + client = TpuClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.TpuRestInterceptor, "post_get_runtime_version") as post, \ + mock.patch.object(transports.TpuRestInterceptor, "pre_get_runtime_version") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_tpu.GetRuntimeVersionRequest.pb(cloud_tpu.GetRuntimeVersionRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = cloud_tpu.RuntimeVersion.to_json(cloud_tpu.RuntimeVersion()) + + request = cloud_tpu.GetRuntimeVersionRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = cloud_tpu.RuntimeVersion() + + client.get_runtime_version(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_runtime_version_rest_bad_request(transport: str = 'rest', request_type=cloud_tpu.GetRuntimeVersionRequest): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/runtimeVersions/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_runtime_version(request) + + +def test_get_runtime_version_rest_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_tpu.RuntimeVersion() + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/runtimeVersions/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = cloud_tpu.RuntimeVersion.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.get_runtime_version(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/{name=projects/*/locations/*/runtimeVersions/*}" % client.transport._host, args[1]) + + +def test_get_runtime_version_rest_flattened_error(transport: str = 'rest'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_runtime_version( + cloud_tpu.GetRuntimeVersionRequest(), + name='name_value', + ) + + +def test_get_runtime_version_rest_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.GetGuestAttributesRequest, + dict, +]) +def test_get_guest_attributes_rest(request_type): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/nodes/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = cloud_tpu.GetGuestAttributesResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = cloud_tpu.GetGuestAttributesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.get_guest_attributes(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_tpu.GetGuestAttributesResponse) + + +def test_get_guest_attributes_rest_required_fields(request_type=cloud_tpu.GetGuestAttributesRequest): + transport_class = transports.TpuRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_guest_attributes._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = 'name_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_guest_attributes._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == 'name_value' + + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = cloud_tpu.GetGuestAttributesResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = cloud_tpu.GetGuestAttributesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.get_guest_attributes(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_get_guest_attributes_rest_unset_required_fields(): + transport = transports.TpuRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.get_guest_attributes._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_guest_attributes_rest_interceptors(null_interceptor): + transport = transports.TpuRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.TpuRestInterceptor(), + ) + client = TpuClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.TpuRestInterceptor, "post_get_guest_attributes") as post, \ + mock.patch.object(transports.TpuRestInterceptor, "pre_get_guest_attributes") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloud_tpu.GetGuestAttributesRequest.pb(cloud_tpu.GetGuestAttributesRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = cloud_tpu.GetGuestAttributesResponse.to_json(cloud_tpu.GetGuestAttributesResponse()) + + request = cloud_tpu.GetGuestAttributesRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = cloud_tpu.GetGuestAttributesResponse() + + client.get_guest_attributes(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_guest_attributes_rest_bad_request(transport: str = 'rest', request_type=cloud_tpu.GetGuestAttributesRequest): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/nodes/sample3'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_guest_attributes(request) + + +def test_get_guest_attributes_rest_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.TpuGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.TpuGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = TpuClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.TpuGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = TpuClient( + client_options=options, + transport=transport, + ) + + # It is an error to provide an api_key and a credential. + options = mock.Mock() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = TpuClient( + client_options=options, + credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.TpuGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = TpuClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.TpuGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = TpuClient(transport=transport) + assert client.transport is transport + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.TpuGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.TpuGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.TpuGrpcTransport, + transports.TpuGrpcAsyncIOTransport, + transports.TpuRestTransport, +]) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "rest", +]) +def test_transport_kind(transport_name): + transport = TpuClient.get_transport_class(transport_name)( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert transport.kind == transport_name + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.TpuGrpcTransport, + ) + +def test_tpu_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.TpuTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json" + ) + + +def test_tpu_base_transport(): + # Instantiate the base transport. + with mock.patch('google.cloud.tpu_v2.services.tpu.transports.TpuTransport.__init__') as Transport: + Transport.return_value = None + transport = transports.TpuTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + 'list_nodes', + 'get_node', + 'create_node', + 'delete_node', + 'stop_node', + 'start_node', + 'update_node', + 'generate_service_identity', + 'list_accelerator_types', + 'get_accelerator_type', + 'list_runtime_versions', + 'get_runtime_version', + 'get_guest_attributes', + 'get_location', + 'list_locations', + 'get_operation', + 'cancel_operation', + 'delete_operation', + 'list_operations', + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + with pytest.raises(NotImplementedError): + transport.close() + + # Additionally, the LRO client (a property) should + # also raise NotImplementedError + with pytest.raises(NotImplementedError): + transport.operations_client + + # Catch all for all remaining methods and properties + remainder = [ + 'kind', + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +def test_tpu_base_transport_with_credentials_file(): + # Instantiate the base transport with a credentials file + with mock.patch.object(google.auth, 'load_credentials_from_file', autospec=True) as load_creds, mock.patch('google.cloud.tpu_v2.services.tpu.transports.TpuTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.TpuTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with("credentials.json", + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id="octopus", + ) + + +def test_tpu_base_transport_with_adc(): + # Test the default credentials are used if credentials and credentials_file are None. + with mock.patch.object(google.auth, 'default', autospec=True) as adc, mock.patch('google.cloud.tpu_v2.services.tpu.transports.TpuTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.TpuTransport() + adc.assert_called_once() + + +def test_tpu_auth_adc(): + # If no credentials are provided, we should use ADC credentials. + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + TpuClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.TpuGrpcTransport, + transports.TpuGrpcAsyncIOTransport, + ], +) +def test_tpu_transport_auth_adc(transport_class): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + adc.assert_called_once_with( + scopes=["1", "2"], + default_scopes=( 'https://www.googleapis.com/auth/cloud-platform',), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.TpuGrpcTransport, + transports.TpuGrpcAsyncIOTransport, + transports.TpuRestTransport, + ], +) +def test_tpu_transport_auth_gdch_credentials(transport_class): + host = 'https://language.com' + api_audience_tests = [None, 'https://language2.com'] + api_audience_expect = [host, 'https://language2.com'] + for t, e in zip(api_audience_tests, api_audience_expect): + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + gdch_mock = mock.MagicMock() + type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) + adc.return_value = (gdch_mock, None) + transport_class(host=host, api_audience=t) + gdch_mock.with_gdch_audience.assert_called_once_with( + e + ) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.TpuGrpcTransport, grpc_helpers), + (transports.TpuGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +def test_tpu_transport_create_channel(transport_class, grpc_helpers): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch.object( + grpc_helpers, "create_channel", autospec=True + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + adc.return_value = (creds, None) + transport_class( + quota_project_id="octopus", + scopes=["1", "2"] + ) + + create_channel.assert_called_with( + "tpu.googleapis.com:443", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + scopes=["1", "2"], + default_host="tpu.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("transport_class", [transports.TpuGrpcTransport, transports.TpuGrpcAsyncIOTransport]) +def test_tpu_grpc_transport_client_cert_source_for_mtls( + transport_class +): + cred = ga_credentials.AnonymousCredentials() + + # Check ssl_channel_credentials is used if provided. + with mock.patch.object(transport_class, "create_channel") as mock_create_channel: + mock_ssl_channel_creds = mock.Mock() + transport_class( + host="squid.clam.whelk", + credentials=cred, + ssl_channel_credentials=mock_ssl_channel_creds + ) + mock_create_channel.assert_called_once_with( + "squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_channel_creds, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls + # is used. + with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): + with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: + transport_class( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + expected_cert, expected_key = client_cert_source_callback() + mock_ssl_cred.assert_called_once_with( + certificate_chain=expected_cert, + private_key=expected_key + ) + +def test_tpu_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: + transports.TpuRestTransport ( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +def test_tpu_rest_lro_client(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.AbstractOperationsClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_tpu_host_no_port(transport_name): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='tpu.googleapis.com'), + transport=transport_name, + ) + assert client.transport._host == ( + 'tpu.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://tpu.googleapis.com' + ) + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_tpu_host_with_port(transport_name): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='tpu.googleapis.com:8000'), + transport=transport_name, + ) + assert client.transport._host == ( + 'tpu.googleapis.com:8000' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://tpu.googleapis.com:8000' + ) + +@pytest.mark.parametrize("transport_name", [ + "rest", +]) +def test_tpu_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = TpuClient( + credentials=creds1, + transport=transport_name, + ) + client2 = TpuClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.list_nodes._session + session2 = client2.transport.list_nodes._session + assert session1 != session2 + session1 = client1.transport.get_node._session + session2 = client2.transport.get_node._session + assert session1 != session2 + session1 = client1.transport.create_node._session + session2 = client2.transport.create_node._session + assert session1 != session2 + session1 = client1.transport.delete_node._session + session2 = client2.transport.delete_node._session + assert session1 != session2 + session1 = client1.transport.stop_node._session + session2 = client2.transport.stop_node._session + assert session1 != session2 + session1 = client1.transport.start_node._session + session2 = client2.transport.start_node._session + assert session1 != session2 + session1 = client1.transport.update_node._session + session2 = client2.transport.update_node._session + assert session1 != session2 + session1 = client1.transport.generate_service_identity._session + session2 = client2.transport.generate_service_identity._session + assert session1 != session2 + session1 = client1.transport.list_accelerator_types._session + session2 = client2.transport.list_accelerator_types._session + assert session1 != session2 + session1 = client1.transport.get_accelerator_type._session + session2 = client2.transport.get_accelerator_type._session + assert session1 != session2 + session1 = client1.transport.list_runtime_versions._session + session2 = client2.transport.list_runtime_versions._session + assert session1 != session2 + session1 = client1.transport.get_runtime_version._session + session2 = client2.transport.get_runtime_version._session + assert session1 != session2 + session1 = client1.transport.get_guest_attributes._session + session2 = client2.transport.get_guest_attributes._session + assert session1 != session2 +def test_tpu_grpc_transport_channel(): + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.TpuGrpcTransport( + host="squid.clam.whelk", + channel=channel, + ) + assert transport.grpc_channel == channel + assert transport._host == "squid.clam.whelk:443" + assert transport._ssl_channel_credentials == None + + +def test_tpu_grpc_asyncio_transport_channel(): + channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.TpuGrpcAsyncIOTransport( + host="squid.clam.whelk", + channel=channel, + ) + assert transport.grpc_channel == channel + assert transport._host == "squid.clam.whelk:443" + assert transport._ssl_channel_credentials == None + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize("transport_class", [transports.TpuGrpcTransport, transports.TpuGrpcAsyncIOTransport]) +def test_tpu_transport_channel_mtls_with_client_cert_source( + transport_class +): + with mock.patch("grpc.ssl_channel_credentials", autospec=True) as grpc_ssl_channel_cred: + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_ssl_cred = mock.Mock() + grpc_ssl_channel_cred.return_value = mock_ssl_cred + + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + + cred = ga_credentials.AnonymousCredentials() + with pytest.warns(DeprecationWarning): + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (cred, None) + transport = transport_class( + host="squid.clam.whelk", + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=client_cert_source_callback, + ) + adc.assert_called_once() + + grpc_ssl_channel_cred.assert_called_once_with( + certificate_chain=b"cert bytes", private_key=b"key bytes" + ) + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + assert transport._ssl_channel_credentials == mock_ssl_cred + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize("transport_class", [transports.TpuGrpcTransport, transports.TpuGrpcAsyncIOTransport]) +def test_tpu_transport_channel_mtls_with_adc( + transport_class +): + mock_ssl_cred = mock.Mock() + with mock.patch.multiple( + "google.auth.transport.grpc.SslCredentials", + __init__=mock.Mock(return_value=None), + ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), + ): + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + mock_cred = mock.Mock() + + with pytest.warns(DeprecationWarning): + transport = transport_class( + host="squid.clam.whelk", + credentials=mock_cred, + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=None, + ) + + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=mock_cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + + +def test_tpu_grpc_lro_client(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.OperationsClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + +def test_tpu_grpc_lro_async_client(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc_asyncio', + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.OperationsAsyncClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + +def test_accelerator_type_path(): + project = "squid" + location = "clam" + accelerator_type = "whelk" + expected = "projects/{project}/locations/{location}/acceleratorTypes/{accelerator_type}".format(project=project, location=location, accelerator_type=accelerator_type, ) + actual = TpuClient.accelerator_type_path(project, location, accelerator_type) + assert expected == actual + + +def test_parse_accelerator_type_path(): + expected = { + "project": "octopus", + "location": "oyster", + "accelerator_type": "nudibranch", + } + path = TpuClient.accelerator_type_path(**expected) + + # Check that the path construction is reversible. + actual = TpuClient.parse_accelerator_type_path(path) + assert expected == actual + +def test_node_path(): + project = "cuttlefish" + location = "mussel" + node = "winkle" + expected = "projects/{project}/locations/{location}/nodes/{node}".format(project=project, location=location, node=node, ) + actual = TpuClient.node_path(project, location, node) + assert expected == actual + + +def test_parse_node_path(): + expected = { + "project": "nautilus", + "location": "scallop", + "node": "abalone", + } + path = TpuClient.node_path(**expected) + + # Check that the path construction is reversible. + actual = TpuClient.parse_node_path(path) + assert expected == actual + +def test_runtime_version_path(): + project = "squid" + location = "clam" + runtime_version = "whelk" + expected = "projects/{project}/locations/{location}/runtimeVersions/{runtime_version}".format(project=project, location=location, runtime_version=runtime_version, ) + actual = TpuClient.runtime_version_path(project, location, runtime_version) + assert expected == actual + + +def test_parse_runtime_version_path(): + expected = { + "project": "octopus", + "location": "oyster", + "runtime_version": "nudibranch", + } + path = TpuClient.runtime_version_path(**expected) + + # Check that the path construction is reversible. + actual = TpuClient.parse_runtime_version_path(path) + assert expected == actual + +def test_common_billing_account_path(): + billing_account = "cuttlefish" + expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + actual = TpuClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "mussel", + } + path = TpuClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = TpuClient.parse_common_billing_account_path(path) + assert expected == actual + +def test_common_folder_path(): + folder = "winkle" + expected = "folders/{folder}".format(folder=folder, ) + actual = TpuClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "nautilus", + } + path = TpuClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = TpuClient.parse_common_folder_path(path) + assert expected == actual + +def test_common_organization_path(): + organization = "scallop" + expected = "organizations/{organization}".format(organization=organization, ) + actual = TpuClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "abalone", + } + path = TpuClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = TpuClient.parse_common_organization_path(path) + assert expected == actual + +def test_common_project_path(): + project = "squid" + expected = "projects/{project}".format(project=project, ) + actual = TpuClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "clam", + } + path = TpuClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = TpuClient.parse_common_project_path(path) + assert expected == actual + +def test_common_location_path(): + project = "whelk" + location = "octopus" + expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) + actual = TpuClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "oyster", + "location": "nudibranch", + } + path = TpuClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = TpuClient.parse_common_location_path(path) + assert expected == actual + + +def test_client_with_default_client_info(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object(transports.TpuTransport, '_prep_wrapped_messages') as prep: + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object(transports.TpuTransport, '_prep_wrapped_messages') as prep: + transport_class = TpuClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + +@pytest.mark.asyncio +async def test_transport_close_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc_asyncio", + ) + with mock.patch.object(type(getattr(client.transport, "grpc_channel")), "close") as close: + async with client: + close.assert_not_called() + close.assert_called_once() + + +def test_get_location_rest_bad_request(transport: str = 'rest', request_type=locations_pb2.GetLocationRequest): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + request = request_type() + request = json_format.ParseDict({'name': 'projects/sample1/locations/sample2'}, request) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_location(request) + +@pytest.mark.parametrize("request_type", [ + locations_pb2.GetLocationRequest, + dict, +]) +def test_get_location_rest(request_type): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request_init = {'name': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = locations_pb2.Location() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.get_location(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, locations_pb2.Location) + +def test_list_locations_rest_bad_request(transport: str = 'rest', request_type=locations_pb2.ListLocationsRequest): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + request = request_type() + request = json_format.ParseDict({'name': 'projects/sample1'}, request) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_locations(request) + +@pytest.mark.parametrize("request_type", [ + locations_pb2.ListLocationsRequest, + dict, +]) +def test_list_locations_rest(request_type): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request_init = {'name': 'projects/sample1'} + request = request_type(**request_init) + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = locations_pb2.ListLocationsResponse() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_locations(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, locations_pb2.ListLocationsResponse) + +def test_cancel_operation_rest_bad_request(transport: str = 'rest', request_type=operations_pb2.CancelOperationRequest): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + request = request_type() + request = json_format.ParseDict({'name': 'projects/sample1/locations/sample2/operations/sample3'}, request) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.cancel_operation(request) + +@pytest.mark.parametrize("request_type", [ + operations_pb2.CancelOperationRequest, + dict, +]) +def test_cancel_operation_rest(request_type): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request_init = {'name': 'projects/sample1/locations/sample2/operations/sample3'} + request = request_type(**request_init) + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = '{}' + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.cancel_operation(request) + + # Establish that the response is the type that we expect. + assert response is None + +def test_delete_operation_rest_bad_request(transport: str = 'rest', request_type=operations_pb2.DeleteOperationRequest): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + request = request_type() + request = json_format.ParseDict({'name': 'projects/sample1/locations/sample2/operations/sample3'}, request) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.delete_operation(request) + +@pytest.mark.parametrize("request_type", [ + operations_pb2.DeleteOperationRequest, + dict, +]) +def test_delete_operation_rest(request_type): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request_init = {'name': 'projects/sample1/locations/sample2/operations/sample3'} + request = request_type(**request_init) + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = '{}' + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.delete_operation(request) + + # Establish that the response is the type that we expect. + assert response is None + +def test_get_operation_rest_bad_request(transport: str = 'rest', request_type=operations_pb2.GetOperationRequest): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + request = request_type() + request = json_format.ParseDict({'name': 'projects/sample1/locations/sample2/operations/sample3'}, request) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_operation(request) + +@pytest.mark.parametrize("request_type", [ + operations_pb2.GetOperationRequest, + dict, +]) +def test_get_operation_rest(request_type): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request_init = {'name': 'projects/sample1/locations/sample2/operations/sample3'} + request = request_type(**request_init) + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.get_operation(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, operations_pb2.Operation) + +def test_list_operations_rest_bad_request(transport: str = 'rest', request_type=operations_pb2.ListOperationsRequest): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + request = request_type() + request = json_format.ParseDict({'name': 'projects/sample1/locations/sample2'}, request) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_operations(request) + +@pytest.mark.parametrize("request_type", [ + operations_pb2.ListOperationsRequest, + dict, +]) +def test_list_operations_rest(request_type): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request_init = {'name': 'projects/sample1/locations/sample2'} + request = request_type(**request_init) + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.ListOperationsResponse() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_operations(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, operations_pb2.ListOperationsResponse) + + +def test_delete_operation(transport: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = operations_pb2.DeleteOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.delete_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert response is None +@pytest.mark.asyncio +async def test_delete_operation_async(transport: str = "grpc"): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = operations_pb2.DeleteOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + None + ) + response = await client.delete_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert response is None + +def test_delete_operation_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = operations_pb2.DeleteOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + call.return_value = None + + client.delete_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations",) in kw["metadata"] +@pytest.mark.asyncio +async def test_delete_operation_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = operations_pb2.DeleteOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + None + ) + await client.delete_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations",) in kw["metadata"] + +def test_delete_operation_from_dict(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = None + + response = client.delete_operation( + request={ + "name": "locations", + } + ) + call.assert_called() +@pytest.mark.asyncio +async def test_delete_operation_from_dict_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + None + ) + response = await client.delete_operation( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_cancel_operation(transport: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = operations_pb2.CancelOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.cancel_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert response is None +@pytest.mark.asyncio +async def test_cancel_operation_async(transport: str = "grpc"): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = operations_pb2.CancelOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + None + ) + response = await client.cancel_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert response is None + +def test_cancel_operation_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = operations_pb2.CancelOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + call.return_value = None + + client.cancel_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations",) in kw["metadata"] +@pytest.mark.asyncio +async def test_cancel_operation_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = operations_pb2.CancelOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + None + ) + await client.cancel_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations",) in kw["metadata"] + +def test_cancel_operation_from_dict(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = None + + response = client.cancel_operation( + request={ + "name": "locations", + } + ) + call.assert_called() +@pytest.mark.asyncio +async def test_cancel_operation_from_dict_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + None + ) + response = await client.cancel_operation( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_get_operation(transport: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = operations_pb2.GetOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation() + response = client.get_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, operations_pb2.Operation) +@pytest.mark.asyncio +async def test_get_operation_async(transport: str = "grpc"): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = operations_pb2.GetOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation() + ) + response = await client.get_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, operations_pb2.Operation) + +def test_get_operation_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = operations_pb2.GetOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + call.return_value = operations_pb2.Operation() + + client.get_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations",) in kw["metadata"] +@pytest.mark.asyncio +async def test_get_operation_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = operations_pb2.GetOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation() + ) + await client.get_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations",) in kw["metadata"] + +def test_get_operation_from_dict(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation() + + response = client.get_operation( + request={ + "name": "locations", + } + ) + call.assert_called() +@pytest.mark.asyncio +async def test_get_operation_from_dict_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation() + ) + response = await client.get_operation( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_list_operations(transport: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = operations_pb2.ListOperationsRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.ListOperationsResponse() + response = client.list_operations(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, operations_pb2.ListOperationsResponse) +@pytest.mark.asyncio +async def test_list_operations_async(transport: str = "grpc"): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = operations_pb2.ListOperationsRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.ListOperationsResponse() + ) + response = await client.list_operations(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, operations_pb2.ListOperationsResponse) + +def test_list_operations_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = operations_pb2.ListOperationsRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + call.return_value = operations_pb2.ListOperationsResponse() + + client.list_operations(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations",) in kw["metadata"] +@pytest.mark.asyncio +async def test_list_operations_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = operations_pb2.ListOperationsRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.ListOperationsResponse() + ) + await client.list_operations(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations",) in kw["metadata"] + +def test_list_operations_from_dict(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.ListOperationsResponse() + + response = client.list_operations( + request={ + "name": "locations", + } + ) + call.assert_called() +@pytest.mark.asyncio +async def test_list_operations_from_dict_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.ListOperationsResponse() + ) + response = await client.list_operations( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_list_locations(transport: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = locations_pb2.ListLocationsRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = locations_pb2.ListLocationsResponse() + response = client.list_locations(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, locations_pb2.ListLocationsResponse) +@pytest.mark.asyncio +async def test_list_locations_async(transport: str = "grpc"): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = locations_pb2.ListLocationsRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + locations_pb2.ListLocationsResponse() + ) + response = await client.list_locations(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, locations_pb2.ListLocationsResponse) + +def test_list_locations_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = locations_pb2.ListLocationsRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + call.return_value = locations_pb2.ListLocationsResponse() + + client.list_locations(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations",) in kw["metadata"] +@pytest.mark.asyncio +async def test_list_locations_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = locations_pb2.ListLocationsRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + locations_pb2.ListLocationsResponse() + ) + await client.list_locations(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations",) in kw["metadata"] + +def test_list_locations_from_dict(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = locations_pb2.ListLocationsResponse() + + response = client.list_locations( + request={ + "name": "locations", + } + ) + call.assert_called() +@pytest.mark.asyncio +async def test_list_locations_from_dict_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + locations_pb2.ListLocationsResponse() + ) + response = await client.list_locations( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_get_location(transport: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = locations_pb2.GetLocationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_location), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = locations_pb2.Location() + response = client.get_location(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, locations_pb2.Location) +@pytest.mark.asyncio +async def test_get_location_async(transport: str = "grpc_asyncio"): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = locations_pb2.GetLocationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_location), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + locations_pb2.Location() + ) + response = await client.get_location(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, locations_pb2.Location) + +def test_get_location_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials()) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = locations_pb2.GetLocationRequest() + request.name = "locations/abc" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_location), "__call__") as call: + call.return_value = locations_pb2.Location() + + client.get_location(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations/abc",) in kw["metadata"] +@pytest.mark.asyncio +async def test_get_location_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials() + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = locations_pb2.GetLocationRequest() + request.name = "locations/abc" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_location), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + locations_pb2.Location() + ) + await client.get_location(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations/abc",) in kw["metadata"] + +def test_get_location_from_dict(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = locations_pb2.Location() + + response = client.get_location( + request={ + "name": "locations/abc", + } + ) + call.assert_called() +@pytest.mark.asyncio +async def test_get_location_from_dict_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + locations_pb2.Location() + ) + response = await client.get_location( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_transport_close(): + transports = { + "rest": "_session", + "grpc": "_grpc_channel", + } + + for transport, close_name in transports.items(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport + ) + with mock.patch.object(type(getattr(client.transport, close_name)), "close") as close: + with client: + close.assert_not_called() + close.assert_called_once() + +def test_client_ctx(): + transports = [ + 'rest', + 'grpc', + ] + for transport in transports: + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport + ) + # Test client calls underlying transport. + with mock.patch.object(type(client.transport), "close") as close: + close.assert_not_called() + with client: + pass + close.assert_called() + +@pytest.mark.parametrize("client_class,transport_class", [ + (TpuClient, transports.TpuGrpcTransport), + (TpuAsyncClient, transports.TpuGrpcAsyncIOTransport), +]) +def test_api_key_credentials(client_class, transport_class): + with mock.patch.object( + google.auth._default, "get_api_key_credentials", create=True + ) as get_api_key_credentials: + mock_cred = mock.Mock() + get_api_key_credentials.return_value = mock_cred + options = client_options.ClientOptions() + options.api_key = "api_key" + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=mock_cred, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) diff --git a/owl-bot-staging/v2alpha1/.coveragerc b/owl-bot-staging/v2alpha1/.coveragerc new file mode 100644 index 0000000..2800d3d --- /dev/null +++ b/owl-bot-staging/v2alpha1/.coveragerc @@ -0,0 +1,13 @@ +[run] +branch = True + +[report] +show_missing = True +omit = + google/cloud/tpu/__init__.py + google/cloud/tpu/gapic_version.py +exclude_lines = + # Re-enable the standard pragma + pragma: NO COVER + # Ignore debug-only repr + def __repr__ diff --git a/owl-bot-staging/v2alpha1/.flake8 b/owl-bot-staging/v2alpha1/.flake8 new file mode 100644 index 0000000..29227d4 --- /dev/null +++ b/owl-bot-staging/v2alpha1/.flake8 @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- +# +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Generated by synthtool. DO NOT EDIT! +[flake8] +ignore = E203, E266, E501, W503 +exclude = + # Exclude generated code. + **/proto/** + **/gapic/** + **/services/** + **/types/** + *_pb2.py + + # Standard linting exemptions. + **/.nox/** + __pycache__, + .git, + *.pyc, + conf.py diff --git a/owl-bot-staging/v2alpha1/MANIFEST.in b/owl-bot-staging/v2alpha1/MANIFEST.in new file mode 100644 index 0000000..ae9f488 --- /dev/null +++ b/owl-bot-staging/v2alpha1/MANIFEST.in @@ -0,0 +1,2 @@ +recursive-include google/cloud/tpu *.py +recursive-include google/cloud/tpu_v2alpha1 *.py diff --git a/owl-bot-staging/v2alpha1/README.rst b/owl-bot-staging/v2alpha1/README.rst new file mode 100644 index 0000000..a9af6a5 --- /dev/null +++ b/owl-bot-staging/v2alpha1/README.rst @@ -0,0 +1,49 @@ +Python Client for Google Cloud Tpu API +================================================= + +Quick Start +----------- + +In order to use this library, you first need to go through the following steps: + +1. `Select or create a Cloud Platform project.`_ +2. `Enable billing for your project.`_ +3. Enable the Google Cloud Tpu API. +4. `Setup Authentication.`_ + +.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project +.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project +.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html + +Installation +~~~~~~~~~~~~ + +Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to +create isolated Python environments. The basic problem it addresses is one of +dependencies and versions, and indirectly permissions. + +With `virtualenv`_, it's possible to install this library without needing system +install permissions, and without clashing with the installed system +dependencies. + +.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/ + + +Mac/Linux +^^^^^^^^^ + +.. code-block:: console + + python3 -m venv + source /bin/activate + /bin/pip install /path/to/library + + +Windows +^^^^^^^ + +.. code-block:: console + + python3 -m venv + \Scripts\activate + \Scripts\pip.exe install \path\to\library diff --git a/owl-bot-staging/v2alpha1/docs/conf.py b/owl-bot-staging/v2alpha1/docs/conf.py new file mode 100644 index 0000000..096ffc7 --- /dev/null +++ b/owl-bot-staging/v2alpha1/docs/conf.py @@ -0,0 +1,376 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# +# google-cloud-tpu documentation build configuration file +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os +import shlex + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath("..")) + +__version__ = "0.1.0" + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +needs_sphinx = "4.0.1" + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.autosummary", + "sphinx.ext.intersphinx", + "sphinx.ext.coverage", + "sphinx.ext.napoleon", + "sphinx.ext.todo", + "sphinx.ext.viewcode", +] + +# autodoc/autosummary flags +autoclass_content = "both" +autodoc_default_flags = ["members"] +autosummary_generate = True + + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +# Allow markdown includes (so releases.md can include CHANGLEOG.md) +# http://www.sphinx-doc.org/en/master/markdown.html +source_parsers = {".md": "recommonmark.parser.CommonMarkParser"} + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +source_suffix = [".rst", ".md"] + +# The encoding of source files. +# source_encoding = 'utf-8-sig' + +# The root toctree document. +root_doc = "index" + +# General information about the project. +project = u"google-cloud-tpu" +copyright = u"2022, Google, LLC" +author = u"Google APIs" # TODO: autogenerate this bit + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The full version, including alpha/beta/rc tags. +release = __version__ +# The short X.Y version. +version = ".".join(release.split(".")[0:2]) + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# today = '' +# Else, today_fmt is used as the format for a strftime call. +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ["_build"] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = "sphinx" + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = "alabaster" + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +html_theme_options = { + "description": "Google Cloud Client Libraries for Python", + "github_user": "googleapis", + "github_repo": "google-cloud-python", + "github_banner": True, + "font_family": "'Roboto', Georgia, sans", + "head_font_family": "'Roboto', Georgia, serif", + "code_font_family": "'Roboto Mono', 'Consolas', monospace", +} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +# html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ["_static"] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +# html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# html_additional_pages = {} + +# If false, no module index is generated. +# html_domain_indices = True + +# If false, no index is generated. +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' +# html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +# html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +# html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = "google-cloud-tpu-doc" + +# -- Options for warnings ------------------------------------------------------ + + +suppress_warnings = [ + # Temporarily suppress this to avoid "more than one target found for + # cross-reference" warning, which are intractable for us to avoid while in + # a mono-repo. + # See https://github.com/sphinx-doc/sphinx/blob + # /2a65ffeef5c107c19084fabdd706cdff3f52d93c/sphinx/domains/python.py#L843 + "ref.python" +] + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + # 'preamble': '', + # Latex figure (float) alignment + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ( + root_doc, + "google-cloud-tpu.tex", + u"google-cloud-tpu Documentation", + author, + "manual", + ) +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# latex_use_parts = False + +# If true, show page references after internal links. +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# latex_appendices = [] + +# If false, no module index is generated. +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ( + root_doc, + "google-cloud-tpu", + u"Google Cloud Tpu Documentation", + [author], + 1, + ) +] + +# If true, show URL addresses after external links. +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ( + root_doc, + "google-cloud-tpu", + u"google-cloud-tpu Documentation", + author, + "google-cloud-tpu", + "GAPIC library for Google Cloud Tpu API", + "APIs", + ) +] + +# Documents to append as an appendix to all manuals. +# texinfo_appendices = [] + +# If false, no module index is generated. +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# texinfo_no_detailmenu = False + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = { + "python": ("http://python.readthedocs.org/en/latest/", None), + "gax": ("https://gax-python.readthedocs.org/en/latest/", None), + "google-auth": ("https://google-auth.readthedocs.io/en/stable", None), + "google-gax": ("https://gax-python.readthedocs.io/en/latest/", None), + "google.api_core": ("https://googleapis.dev/python/google-api-core/latest/", None), + "grpc": ("https://grpc.io/grpc/python/", None), + "requests": ("http://requests.kennethreitz.org/en/stable/", None), + "proto": ("https://proto-plus-python.readthedocs.io/en/stable", None), + "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), +} + + +# Napoleon settings +napoleon_google_docstring = True +napoleon_numpy_docstring = True +napoleon_include_private_with_doc = False +napoleon_include_special_with_doc = True +napoleon_use_admonition_for_examples = False +napoleon_use_admonition_for_notes = False +napoleon_use_admonition_for_references = False +napoleon_use_ivar = False +napoleon_use_param = True +napoleon_use_rtype = True diff --git a/owl-bot-staging/v2alpha1/docs/index.rst b/owl-bot-staging/v2alpha1/docs/index.rst new file mode 100644 index 0000000..02eec29 --- /dev/null +++ b/owl-bot-staging/v2alpha1/docs/index.rst @@ -0,0 +1,7 @@ +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + tpu_v2alpha1/services + tpu_v2alpha1/types diff --git a/owl-bot-staging/v2alpha1/docs/tpu_v2alpha1/services.rst b/owl-bot-staging/v2alpha1/docs/tpu_v2alpha1/services.rst new file mode 100644 index 0000000..74c3c78 --- /dev/null +++ b/owl-bot-staging/v2alpha1/docs/tpu_v2alpha1/services.rst @@ -0,0 +1,6 @@ +Services for Google Cloud Tpu v2alpha1 API +========================================== +.. toctree:: + :maxdepth: 2 + + tpu diff --git a/owl-bot-staging/v2alpha1/docs/tpu_v2alpha1/tpu.rst b/owl-bot-staging/v2alpha1/docs/tpu_v2alpha1/tpu.rst new file mode 100644 index 0000000..9b3906b --- /dev/null +++ b/owl-bot-staging/v2alpha1/docs/tpu_v2alpha1/tpu.rst @@ -0,0 +1,10 @@ +Tpu +--------------------- + +.. automodule:: google.cloud.tpu_v2alpha1.services.tpu + :members: + :inherited-members: + +.. automodule:: google.cloud.tpu_v2alpha1.services.tpu.pagers + :members: + :inherited-members: diff --git a/owl-bot-staging/v2alpha1/docs/tpu_v2alpha1/types.rst b/owl-bot-staging/v2alpha1/docs/tpu_v2alpha1/types.rst new file mode 100644 index 0000000..afd9d0b --- /dev/null +++ b/owl-bot-staging/v2alpha1/docs/tpu_v2alpha1/types.rst @@ -0,0 +1,6 @@ +Types for Google Cloud Tpu v2alpha1 API +======================================= + +.. automodule:: google.cloud.tpu_v2alpha1.types + :members: + :show-inheritance: diff --git a/owl-bot-staging/v2alpha1/google/cloud/tpu/__init__.py b/owl-bot-staging/v2alpha1/google/cloud/tpu/__init__.py new file mode 100644 index 0000000..9f4d27a --- /dev/null +++ b/owl-bot-staging/v2alpha1/google/cloud/tpu/__init__.py @@ -0,0 +1,113 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from google.cloud.tpu import gapic_version as package_version + +__version__ = package_version.__version__ + + +from google.cloud.tpu_v2alpha1.services.tpu.client import TpuClient +from google.cloud.tpu_v2alpha1.services.tpu.async_client import TpuAsyncClient + +from google.cloud.tpu_v2alpha1.types.cloud_tpu import AcceleratorConfig +from google.cloud.tpu_v2alpha1.types.cloud_tpu import AcceleratorType +from google.cloud.tpu_v2alpha1.types.cloud_tpu import AccessConfig +from google.cloud.tpu_v2alpha1.types.cloud_tpu import AttachedDisk +from google.cloud.tpu_v2alpha1.types.cloud_tpu import CreateNodeRequest +from google.cloud.tpu_v2alpha1.types.cloud_tpu import CreateQueuedResourceRequest +from google.cloud.tpu_v2alpha1.types.cloud_tpu import DeleteNodeRequest +from google.cloud.tpu_v2alpha1.types.cloud_tpu import DeleteQueuedResourceRequest +from google.cloud.tpu_v2alpha1.types.cloud_tpu import GenerateServiceIdentityRequest +from google.cloud.tpu_v2alpha1.types.cloud_tpu import GenerateServiceIdentityResponse +from google.cloud.tpu_v2alpha1.types.cloud_tpu import GetAcceleratorTypeRequest +from google.cloud.tpu_v2alpha1.types.cloud_tpu import GetGuestAttributesRequest +from google.cloud.tpu_v2alpha1.types.cloud_tpu import GetGuestAttributesResponse +from google.cloud.tpu_v2alpha1.types.cloud_tpu import GetNodeRequest +from google.cloud.tpu_v2alpha1.types.cloud_tpu import GetQueuedResourceRequest +from google.cloud.tpu_v2alpha1.types.cloud_tpu import GetRuntimeVersionRequest +from google.cloud.tpu_v2alpha1.types.cloud_tpu import GuestAttributes +from google.cloud.tpu_v2alpha1.types.cloud_tpu import GuestAttributesEntry +from google.cloud.tpu_v2alpha1.types.cloud_tpu import GuestAttributesValue +from google.cloud.tpu_v2alpha1.types.cloud_tpu import ListAcceleratorTypesRequest +from google.cloud.tpu_v2alpha1.types.cloud_tpu import ListAcceleratorTypesResponse +from google.cloud.tpu_v2alpha1.types.cloud_tpu import ListNodesRequest +from google.cloud.tpu_v2alpha1.types.cloud_tpu import ListNodesResponse +from google.cloud.tpu_v2alpha1.types.cloud_tpu import ListQueuedResourcesRequest +from google.cloud.tpu_v2alpha1.types.cloud_tpu import ListQueuedResourcesResponse +from google.cloud.tpu_v2alpha1.types.cloud_tpu import ListRuntimeVersionsRequest +from google.cloud.tpu_v2alpha1.types.cloud_tpu import ListRuntimeVersionsResponse +from google.cloud.tpu_v2alpha1.types.cloud_tpu import NetworkConfig +from google.cloud.tpu_v2alpha1.types.cloud_tpu import NetworkEndpoint +from google.cloud.tpu_v2alpha1.types.cloud_tpu import Node +from google.cloud.tpu_v2alpha1.types.cloud_tpu import OperationMetadata +from google.cloud.tpu_v2alpha1.types.cloud_tpu import QueuedResource +from google.cloud.tpu_v2alpha1.types.cloud_tpu import QueuedResourceState +from google.cloud.tpu_v2alpha1.types.cloud_tpu import RuntimeVersion +from google.cloud.tpu_v2alpha1.types.cloud_tpu import SchedulingConfig +from google.cloud.tpu_v2alpha1.types.cloud_tpu import ServiceAccount +from google.cloud.tpu_v2alpha1.types.cloud_tpu import ServiceIdentity +from google.cloud.tpu_v2alpha1.types.cloud_tpu import ShieldedInstanceConfig +from google.cloud.tpu_v2alpha1.types.cloud_tpu import SimulateMaintenanceEventRequest +from google.cloud.tpu_v2alpha1.types.cloud_tpu import StartNodeRequest +from google.cloud.tpu_v2alpha1.types.cloud_tpu import StopNodeRequest +from google.cloud.tpu_v2alpha1.types.cloud_tpu import Symptom +from google.cloud.tpu_v2alpha1.types.cloud_tpu import UpdateNodeRequest + +__all__ = ('TpuClient', + 'TpuAsyncClient', + 'AcceleratorConfig', + 'AcceleratorType', + 'AccessConfig', + 'AttachedDisk', + 'CreateNodeRequest', + 'CreateQueuedResourceRequest', + 'DeleteNodeRequest', + 'DeleteQueuedResourceRequest', + 'GenerateServiceIdentityRequest', + 'GenerateServiceIdentityResponse', + 'GetAcceleratorTypeRequest', + 'GetGuestAttributesRequest', + 'GetGuestAttributesResponse', + 'GetNodeRequest', + 'GetQueuedResourceRequest', + 'GetRuntimeVersionRequest', + 'GuestAttributes', + 'GuestAttributesEntry', + 'GuestAttributesValue', + 'ListAcceleratorTypesRequest', + 'ListAcceleratorTypesResponse', + 'ListNodesRequest', + 'ListNodesResponse', + 'ListQueuedResourcesRequest', + 'ListQueuedResourcesResponse', + 'ListRuntimeVersionsRequest', + 'ListRuntimeVersionsResponse', + 'NetworkConfig', + 'NetworkEndpoint', + 'Node', + 'OperationMetadata', + 'QueuedResource', + 'QueuedResourceState', + 'RuntimeVersion', + 'SchedulingConfig', + 'ServiceAccount', + 'ServiceIdentity', + 'ShieldedInstanceConfig', + 'SimulateMaintenanceEventRequest', + 'StartNodeRequest', + 'StopNodeRequest', + 'Symptom', + 'UpdateNodeRequest', +) diff --git a/owl-bot-staging/v2alpha1/google/cloud/tpu/gapic_version.py b/owl-bot-staging/v2alpha1/google/cloud/tpu/gapic_version.py new file mode 100644 index 0000000..405b1ce --- /dev/null +++ b/owl-bot-staging/v2alpha1/google/cloud/tpu/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +__version__ = "0.1.0" # {x-release-please-version} diff --git a/owl-bot-staging/v2alpha1/google/cloud/tpu/py.typed b/owl-bot-staging/v2alpha1/google/cloud/tpu/py.typed new file mode 100644 index 0000000..e122051 --- /dev/null +++ b/owl-bot-staging/v2alpha1/google/cloud/tpu/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-tpu package uses inline types. diff --git a/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/__init__.py b/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/__init__.py new file mode 100644 index 0000000..a8481b4 --- /dev/null +++ b/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/__init__.py @@ -0,0 +1,114 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from google.cloud.tpu_v2alpha1 import gapic_version as package_version + +__version__ = package_version.__version__ + + +from .services.tpu import TpuClient +from .services.tpu import TpuAsyncClient + +from .types.cloud_tpu import AcceleratorConfig +from .types.cloud_tpu import AcceleratorType +from .types.cloud_tpu import AccessConfig +from .types.cloud_tpu import AttachedDisk +from .types.cloud_tpu import CreateNodeRequest +from .types.cloud_tpu import CreateQueuedResourceRequest +from .types.cloud_tpu import DeleteNodeRequest +from .types.cloud_tpu import DeleteQueuedResourceRequest +from .types.cloud_tpu import GenerateServiceIdentityRequest +from .types.cloud_tpu import GenerateServiceIdentityResponse +from .types.cloud_tpu import GetAcceleratorTypeRequest +from .types.cloud_tpu import GetGuestAttributesRequest +from .types.cloud_tpu import GetGuestAttributesResponse +from .types.cloud_tpu import GetNodeRequest +from .types.cloud_tpu import GetQueuedResourceRequest +from .types.cloud_tpu import GetRuntimeVersionRequest +from .types.cloud_tpu import GuestAttributes +from .types.cloud_tpu import GuestAttributesEntry +from .types.cloud_tpu import GuestAttributesValue +from .types.cloud_tpu import ListAcceleratorTypesRequest +from .types.cloud_tpu import ListAcceleratorTypesResponse +from .types.cloud_tpu import ListNodesRequest +from .types.cloud_tpu import ListNodesResponse +from .types.cloud_tpu import ListQueuedResourcesRequest +from .types.cloud_tpu import ListQueuedResourcesResponse +from .types.cloud_tpu import ListRuntimeVersionsRequest +from .types.cloud_tpu import ListRuntimeVersionsResponse +from .types.cloud_tpu import NetworkConfig +from .types.cloud_tpu import NetworkEndpoint +from .types.cloud_tpu import Node +from .types.cloud_tpu import OperationMetadata +from .types.cloud_tpu import QueuedResource +from .types.cloud_tpu import QueuedResourceState +from .types.cloud_tpu import RuntimeVersion +from .types.cloud_tpu import SchedulingConfig +from .types.cloud_tpu import ServiceAccount +from .types.cloud_tpu import ServiceIdentity +from .types.cloud_tpu import ShieldedInstanceConfig +from .types.cloud_tpu import SimulateMaintenanceEventRequest +from .types.cloud_tpu import StartNodeRequest +from .types.cloud_tpu import StopNodeRequest +from .types.cloud_tpu import Symptom +from .types.cloud_tpu import UpdateNodeRequest + +__all__ = ( + 'TpuAsyncClient', +'AcceleratorConfig', +'AcceleratorType', +'AccessConfig', +'AttachedDisk', +'CreateNodeRequest', +'CreateQueuedResourceRequest', +'DeleteNodeRequest', +'DeleteQueuedResourceRequest', +'GenerateServiceIdentityRequest', +'GenerateServiceIdentityResponse', +'GetAcceleratorTypeRequest', +'GetGuestAttributesRequest', +'GetGuestAttributesResponse', +'GetNodeRequest', +'GetQueuedResourceRequest', +'GetRuntimeVersionRequest', +'GuestAttributes', +'GuestAttributesEntry', +'GuestAttributesValue', +'ListAcceleratorTypesRequest', +'ListAcceleratorTypesResponse', +'ListNodesRequest', +'ListNodesResponse', +'ListQueuedResourcesRequest', +'ListQueuedResourcesResponse', +'ListRuntimeVersionsRequest', +'ListRuntimeVersionsResponse', +'NetworkConfig', +'NetworkEndpoint', +'Node', +'OperationMetadata', +'QueuedResource', +'QueuedResourceState', +'RuntimeVersion', +'SchedulingConfig', +'ServiceAccount', +'ServiceIdentity', +'ShieldedInstanceConfig', +'SimulateMaintenanceEventRequest', +'StartNodeRequest', +'StopNodeRequest', +'Symptom', +'TpuClient', +'UpdateNodeRequest', +) diff --git a/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/gapic_metadata.json b/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/gapic_metadata.json new file mode 100644 index 0000000..4c5e3e7 --- /dev/null +++ b/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/gapic_metadata.json @@ -0,0 +1,203 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.cloud.tpu_v2alpha1", + "protoPackage": "google.cloud.tpu.v2alpha1", + "schema": "1.0", + "services": { + "Tpu": { + "clients": { + "grpc": { + "libraryClient": "TpuClient", + "rpcs": { + "CreateNode": { + "methods": [ + "create_node" + ] + }, + "CreateQueuedResource": { + "methods": [ + "create_queued_resource" + ] + }, + "DeleteNode": { + "methods": [ + "delete_node" + ] + }, + "DeleteQueuedResource": { + "methods": [ + "delete_queued_resource" + ] + }, + "GenerateServiceIdentity": { + "methods": [ + "generate_service_identity" + ] + }, + "GetAcceleratorType": { + "methods": [ + "get_accelerator_type" + ] + }, + "GetGuestAttributes": { + "methods": [ + "get_guest_attributes" + ] + }, + "GetNode": { + "methods": [ + "get_node" + ] + }, + "GetQueuedResource": { + "methods": [ + "get_queued_resource" + ] + }, + "GetRuntimeVersion": { + "methods": [ + "get_runtime_version" + ] + }, + "ListAcceleratorTypes": { + "methods": [ + "list_accelerator_types" + ] + }, + "ListNodes": { + "methods": [ + "list_nodes" + ] + }, + "ListQueuedResources": { + "methods": [ + "list_queued_resources" + ] + }, + "ListRuntimeVersions": { + "methods": [ + "list_runtime_versions" + ] + }, + "SimulateMaintenanceEvent": { + "methods": [ + "simulate_maintenance_event" + ] + }, + "StartNode": { + "methods": [ + "start_node" + ] + }, + "StopNode": { + "methods": [ + "stop_node" + ] + }, + "UpdateNode": { + "methods": [ + "update_node" + ] + } + } + }, + "grpc-async": { + "libraryClient": "TpuAsyncClient", + "rpcs": { + "CreateNode": { + "methods": [ + "create_node" + ] + }, + "CreateQueuedResource": { + "methods": [ + "create_queued_resource" + ] + }, + "DeleteNode": { + "methods": [ + "delete_node" + ] + }, + "DeleteQueuedResource": { + "methods": [ + "delete_queued_resource" + ] + }, + "GenerateServiceIdentity": { + "methods": [ + "generate_service_identity" + ] + }, + "GetAcceleratorType": { + "methods": [ + "get_accelerator_type" + ] + }, + "GetGuestAttributes": { + "methods": [ + "get_guest_attributes" + ] + }, + "GetNode": { + "methods": [ + "get_node" + ] + }, + "GetQueuedResource": { + "methods": [ + "get_queued_resource" + ] + }, + "GetRuntimeVersion": { + "methods": [ + "get_runtime_version" + ] + }, + "ListAcceleratorTypes": { + "methods": [ + "list_accelerator_types" + ] + }, + "ListNodes": { + "methods": [ + "list_nodes" + ] + }, + "ListQueuedResources": { + "methods": [ + "list_queued_resources" + ] + }, + "ListRuntimeVersions": { + "methods": [ + "list_runtime_versions" + ] + }, + "SimulateMaintenanceEvent": { + "methods": [ + "simulate_maintenance_event" + ] + }, + "StartNode": { + "methods": [ + "start_node" + ] + }, + "StopNode": { + "methods": [ + "stop_node" + ] + }, + "UpdateNode": { + "methods": [ + "update_node" + ] + } + } + } + } + } + } +} diff --git a/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/gapic_version.py b/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/gapic_version.py new file mode 100644 index 0000000..405b1ce --- /dev/null +++ b/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +__version__ = "0.1.0" # {x-release-please-version} diff --git a/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/py.typed b/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/py.typed new file mode 100644 index 0000000..e122051 --- /dev/null +++ b/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-tpu package uses inline types. diff --git a/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/__init__.py b/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/__init__.py new file mode 100644 index 0000000..e8e1c38 --- /dev/null +++ b/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/tpu/__init__.py b/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/tpu/__init__.py new file mode 100644 index 0000000..23e6818 --- /dev/null +++ b/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/tpu/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .client import TpuClient +from .async_client import TpuAsyncClient + +__all__ = ( + 'TpuClient', + 'TpuAsyncClient', +) diff --git a/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/tpu/async_client.py b/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/tpu/async_client.py new file mode 100644 index 0000000..86eb884 --- /dev/null +++ b/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/tpu/async_client.py @@ -0,0 +1,2445 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import functools +import re +from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union + +from google.cloud.tpu_v2alpha1 import gapic_version as package_version + +from google.api_core.client_options import ClientOptions +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + +from google.api_core import operation # type: ignore +from google.api_core import operation_async # type: ignore +from google.cloud.location import locations_pb2 # type: ignore +from google.cloud.tpu_v2alpha1.services.tpu import pagers +from google.cloud.tpu_v2alpha1.types import cloud_tpu +from google.longrunning import operations_pb2 +from google.protobuf import empty_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from .transports.base import TpuTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import TpuGrpcAsyncIOTransport +from .client import TpuClient + + +class TpuAsyncClient: + """Manages TPU nodes and other resources + TPU API v2alpha1 + """ + + _client: TpuClient + + DEFAULT_ENDPOINT = TpuClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = TpuClient.DEFAULT_MTLS_ENDPOINT + + accelerator_type_path = staticmethod(TpuClient.accelerator_type_path) + parse_accelerator_type_path = staticmethod(TpuClient.parse_accelerator_type_path) + node_path = staticmethod(TpuClient.node_path) + parse_node_path = staticmethod(TpuClient.parse_node_path) + queued_resource_path = staticmethod(TpuClient.queued_resource_path) + parse_queued_resource_path = staticmethod(TpuClient.parse_queued_resource_path) + runtime_version_path = staticmethod(TpuClient.runtime_version_path) + parse_runtime_version_path = staticmethod(TpuClient.parse_runtime_version_path) + common_billing_account_path = staticmethod(TpuClient.common_billing_account_path) + parse_common_billing_account_path = staticmethod(TpuClient.parse_common_billing_account_path) + common_folder_path = staticmethod(TpuClient.common_folder_path) + parse_common_folder_path = staticmethod(TpuClient.parse_common_folder_path) + common_organization_path = staticmethod(TpuClient.common_organization_path) + parse_common_organization_path = staticmethod(TpuClient.parse_common_organization_path) + common_project_path = staticmethod(TpuClient.common_project_path) + parse_common_project_path = staticmethod(TpuClient.parse_common_project_path) + common_location_path = staticmethod(TpuClient.common_location_path) + parse_common_location_path = staticmethod(TpuClient.parse_common_location_path) + + @classmethod + def from_service_account_info(cls, info: dict, *args, **kwargs): + """Creates an instance of this client using the provided credentials + info. + + Args: + info (dict): The service account private key info. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + TpuAsyncClient: The constructed client. + """ + return TpuClient.from_service_account_info.__func__(TpuAsyncClient, info, *args, **kwargs) # type: ignore + + @classmethod + def from_service_account_file(cls, filename: str, *args, **kwargs): + """Creates an instance of this client using the provided credentials + file. + + Args: + filename (str): The path to the service account private key json + file. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + TpuAsyncClient: The constructed client. + """ + return TpuClient.from_service_account_file.__func__(TpuAsyncClient, filename, *args, **kwargs) # type: ignore + + from_service_account_json = from_service_account_file + + @classmethod + def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[ClientOptions] = None): + """Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variable is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + return TpuClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore + + @property + def transport(self) -> TpuTransport: + """Returns the transport used by the client instance. + + Returns: + TpuTransport: The transport used by the client instance. + """ + return self._client.transport + + get_transport_class = functools.partial(type(TpuClient).get_transport_class, type(TpuClient)) + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Union[str, TpuTransport] = "grpc_asyncio", + client_options: Optional[ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the tpu client. + + Args: + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + transport (Union[str, ~.TpuTransport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (ClientOptions): Custom options for the client. It + won't take effect if a ``transport`` instance is provided. + (1) The ``api_endpoint`` property can be used to override the + default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT + environment variable can also be used to override the endpoint: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto switch to the + default mTLS endpoint if client certificate is present, this is + the default value). However, the ``api_endpoint`` property takes + precedence if provided. + (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide client certificate for mutual TLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + """ + self._client = TpuClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + + ) + + async def list_nodes(self, + request: Optional[Union[cloud_tpu.ListNodesRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListNodesAsyncPager: + r"""Lists nodes. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + async def sample_list_nodes(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.ListNodesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_nodes(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v2alpha1.types.ListNodesRequest, dict]]): + The request object. Request for + [ListNodes][google.cloud.tpu.v2alpha1.Tpu.ListNodes]. + parent (:class:`str`): + Required. The parent resource name. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2alpha1.services.tpu.pagers.ListNodesAsyncPager: + Response for + [ListNodes][google.cloud.tpu.v2alpha1.Tpu.ListNodes]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_tpu.ListNodesRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_nodes, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListNodesAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_node(self, + request: Optional[Union[cloud_tpu.GetNodeRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_tpu.Node: + r"""Gets the details of a node. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + async def sample_get_node(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.GetNodeRequest( + name="name_value", + ) + + # Make the request + response = await client.get_node(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v2alpha1.types.GetNodeRequest, dict]]): + The request object. Request for + [GetNode][google.cloud.tpu.v2alpha1.Tpu.GetNode]. + name (:class:`str`): + Required. The resource name. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2alpha1.types.Node: + A TPU instance. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_tpu.GetNodeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.get_node, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def create_node(self, + request: Optional[Union[cloud_tpu.CreateNodeRequest, dict]] = None, + *, + parent: Optional[str] = None, + node: Optional[cloud_tpu.Node] = None, + node_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Creates a node. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + async def sample_create_node(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + node = tpu_v2alpha1.Node() + node.runtime_version = "runtime_version_value" + + request = tpu_v2alpha1.CreateNodeRequest( + parent="parent_value", + node=node, + ) + + # Make the request + operation = client.create_node(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v2alpha1.types.CreateNodeRequest, dict]]): + The request object. Request for + [CreateNode][google.cloud.tpu.v2alpha1.Tpu.CreateNode]. + parent (:class:`str`): + Required. The parent resource name. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + node (:class:`google.cloud.tpu_v2alpha1.types.Node`): + Required. The node. + This corresponds to the ``node`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + node_id (:class:`str`): + The unqualified resource name. + This corresponds to the ``node_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.tpu_v2alpha1.types.Node` A TPU + instance. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, node, node_id]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_tpu.CreateNodeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if node is not None: + request.node = node + if node_id is not None: + request.node_id = node_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.create_node, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_tpu.Node, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + async def delete_node(self, + request: Optional[Union[cloud_tpu.DeleteNodeRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Deletes a node. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + async def sample_delete_node(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.DeleteNodeRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_node(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v2alpha1.types.DeleteNodeRequest, dict]]): + The request object. Request for + [DeleteNode][google.cloud.tpu.v2alpha1.Tpu.DeleteNode]. + name (:class:`str`): + Required. The resource name. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to + use it as the request or the response type of an API + method. For instance: + + service Foo { + rpc Bar(google.protobuf.Empty) returns + (google.protobuf.Empty); + + } + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_tpu.DeleteNodeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.delete_node, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + empty_pb2.Empty, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + async def stop_node(self, + request: Optional[Union[cloud_tpu.StopNodeRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Stops a node. This operation is only available with + single TPU nodes. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + async def sample_stop_node(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.StopNodeRequest( + name="name_value", + ) + + # Make the request + operation = client.stop_node(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v2alpha1.types.StopNodeRequest, dict]]): + The request object. Request for + [StopNode][google.cloud.tpu.v2alpha1.Tpu.StopNode]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.tpu_v2alpha1.types.Node` A TPU + instance. + + """ + # Create or coerce a protobuf request object. + request = cloud_tpu.StopNodeRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.stop_node, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_tpu.Node, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + async def start_node(self, + request: Optional[Union[cloud_tpu.StartNodeRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Starts a node. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + async def sample_start_node(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.StartNodeRequest( + name="name_value", + ) + + # Make the request + operation = client.start_node(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v2alpha1.types.StartNodeRequest, dict]]): + The request object. Request for + [StartNode][google.cloud.tpu.v2alpha1.Tpu.StartNode]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.tpu_v2alpha1.types.Node` A TPU + instance. + + """ + # Create or coerce a protobuf request object. + request = cloud_tpu.StartNodeRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.start_node, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_tpu.Node, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + async def update_node(self, + request: Optional[Union[cloud_tpu.UpdateNodeRequest, dict]] = None, + *, + node: Optional[cloud_tpu.Node] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Updates the configurations of a node. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + async def sample_update_node(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + node = tpu_v2alpha1.Node() + node.runtime_version = "runtime_version_value" + + request = tpu_v2alpha1.UpdateNodeRequest( + node=node, + ) + + # Make the request + operation = client.update_node(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v2alpha1.types.UpdateNodeRequest, dict]]): + The request object. Request for + [UpdateNode][google.cloud.tpu.v2alpha1.Tpu.UpdateNode]. + node (:class:`google.cloud.tpu_v2alpha1.types.Node`): + Required. The node. Only fields specified in update_mask + are updated. + + This corresponds to the ``node`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): + Required. Mask of fields from [Node][Tpu.Node] to + update. Supported fields: [description, tags, labels, + metadata, network_config.enable_external_ips]. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.tpu_v2alpha1.types.Node` A TPU + instance. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([node, update_mask]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_tpu.UpdateNodeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if node is not None: + request.node = node + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.update_node, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("node.name", request.node.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_tpu.Node, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + async def list_queued_resources(self, + request: Optional[Union[cloud_tpu.ListQueuedResourcesRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListQueuedResourcesAsyncPager: + r"""Lists queued resources. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + async def sample_list_queued_resources(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.ListQueuedResourcesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_queued_resources(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v2alpha1.types.ListQueuedResourcesRequest, dict]]): + The request object. Request for + [ListQueuedResources][google.cloud.tpu.v2alpha1.Tpu.ListQueuedResources]. + parent (:class:`str`): + Required. The parent resource name. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2alpha1.services.tpu.pagers.ListQueuedResourcesAsyncPager: + Response for + [ListQueuedResources][google.cloud.tpu.v2alpha1.Tpu.ListQueuedResources]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_tpu.ListQueuedResourcesRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_queued_resources, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListQueuedResourcesAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_queued_resource(self, + request: Optional[Union[cloud_tpu.GetQueuedResourceRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_tpu.QueuedResource: + r"""Gets details of a queued resource. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + async def sample_get_queued_resource(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.GetQueuedResourceRequest( + name="name_value", + ) + + # Make the request + response = await client.get_queued_resource(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v2alpha1.types.GetQueuedResourceRequest, dict]]): + The request object. Request for + [GetQueuedResource][google.cloud.tpu.v2alpha1.Tpu.GetQueuedResource] + name (:class:`str`): + Required. The resource name. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2alpha1.types.QueuedResource: + A QueuedResource represents a request + for resources that will be placed in a + queue and fulfilled when the necessary + resources are available. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_tpu.GetQueuedResourceRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.get_queued_resource, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def create_queued_resource(self, + request: Optional[Union[cloud_tpu.CreateQueuedResourceRequest, dict]] = None, + *, + parent: Optional[str] = None, + queued_resource: Optional[cloud_tpu.QueuedResource] = None, + queued_resource_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Creates a QueuedResource TPU instance. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + async def sample_create_queued_resource(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.CreateQueuedResourceRequest( + parent="parent_value", + ) + + # Make the request + operation = client.create_queued_resource(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v2alpha1.types.CreateQueuedResourceRequest, dict]]): + The request object. Request for + [CreateQueuedResource][google.cloud.tpu.v2alpha1.Tpu.CreateQueuedResource]. + parent (:class:`str`): + Required. The parent resource name. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + queued_resource (:class:`google.cloud.tpu_v2alpha1.types.QueuedResource`): + Required. The queued resource. + This corresponds to the ``queued_resource`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + queued_resource_id (:class:`str`): + The unqualified resource name. Should follow the + ``^[A-Za-z0-9_.~+%-]+$`` regex format. + + This corresponds to the ``queued_resource_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.tpu_v2alpha1.types.QueuedResource` A QueuedResource represents a request for resources that will be placed + in a queue and fulfilled when the necessary resources + are available. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, queued_resource, queued_resource_id]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_tpu.CreateQueuedResourceRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if queued_resource is not None: + request.queued_resource = queued_resource + if queued_resource_id is not None: + request.queued_resource_id = queued_resource_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.create_queued_resource, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_tpu.QueuedResource, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + async def delete_queued_resource(self, + request: Optional[Union[cloud_tpu.DeleteQueuedResourceRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Deletes a QueuedResource TPU instance. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + async def sample_delete_queued_resource(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.DeleteQueuedResourceRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_queued_resource(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v2alpha1.types.DeleteQueuedResourceRequest, dict]]): + The request object. Request for + [DeleteQueuedResource][google.cloud.tpu.v2alpha1.Tpu.DeleteQueuedResource]. + name (:class:`str`): + Required. The resource name. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.tpu_v2alpha1.types.QueuedResource` A QueuedResource represents a request for resources that will be placed + in a queue and fulfilled when the necessary resources + are available. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_tpu.DeleteQueuedResourceRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.delete_queued_resource, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_tpu.QueuedResource, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + async def generate_service_identity(self, + request: Optional[Union[cloud_tpu.GenerateServiceIdentityRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_tpu.GenerateServiceIdentityResponse: + r"""Generates the Cloud TPU service identity for the + project. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + async def sample_generate_service_identity(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.GenerateServiceIdentityRequest( + parent="parent_value", + ) + + # Make the request + response = await client.generate_service_identity(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v2alpha1.types.GenerateServiceIdentityRequest, dict]]): + The request object. Request for + [GenerateServiceIdentity][google.cloud.tpu.v2alpha1.Tpu.GenerateServiceIdentity]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2alpha1.types.GenerateServiceIdentityResponse: + Response for + [GenerateServiceIdentity][google.cloud.tpu.v2alpha1.Tpu.GenerateServiceIdentity]. + + """ + # Create or coerce a protobuf request object. + request = cloud_tpu.GenerateServiceIdentityRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.generate_service_identity, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def list_accelerator_types(self, + request: Optional[Union[cloud_tpu.ListAcceleratorTypesRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListAcceleratorTypesAsyncPager: + r"""Lists accelerator types supported by this API. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + async def sample_list_accelerator_types(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.ListAcceleratorTypesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_accelerator_types(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v2alpha1.types.ListAcceleratorTypesRequest, dict]]): + The request object. Request for + [ListAcceleratorTypes][google.cloud.tpu.v2alpha1.Tpu.ListAcceleratorTypes]. + parent (:class:`str`): + Required. The parent resource name. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2alpha1.services.tpu.pagers.ListAcceleratorTypesAsyncPager: + Response for + [ListAcceleratorTypes][google.cloud.tpu.v2alpha1.Tpu.ListAcceleratorTypes]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_tpu.ListAcceleratorTypesRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_accelerator_types, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListAcceleratorTypesAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_accelerator_type(self, + request: Optional[Union[cloud_tpu.GetAcceleratorTypeRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_tpu.AcceleratorType: + r"""Gets AcceleratorType. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + async def sample_get_accelerator_type(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.GetAcceleratorTypeRequest( + name="name_value", + ) + + # Make the request + response = await client.get_accelerator_type(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v2alpha1.types.GetAcceleratorTypeRequest, dict]]): + The request object. Request for + [GetAcceleratorType][google.cloud.tpu.v2alpha1.Tpu.GetAcceleratorType]. + name (:class:`str`): + Required. The resource name. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2alpha1.types.AcceleratorType: + A accelerator type that a Node can be + configured with. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_tpu.GetAcceleratorTypeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.get_accelerator_type, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def list_runtime_versions(self, + request: Optional[Union[cloud_tpu.ListRuntimeVersionsRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListRuntimeVersionsAsyncPager: + r"""Lists runtime versions supported by this API. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + async def sample_list_runtime_versions(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.ListRuntimeVersionsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_runtime_versions(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v2alpha1.types.ListRuntimeVersionsRequest, dict]]): + The request object. Request for + [ListRuntimeVersions][google.cloud.tpu.v2alpha1.Tpu.ListRuntimeVersions]. + parent (:class:`str`): + Required. The parent resource name. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2alpha1.services.tpu.pagers.ListRuntimeVersionsAsyncPager: + Response for + [ListRuntimeVersions][google.cloud.tpu.v2alpha1.Tpu.ListRuntimeVersions]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_tpu.ListRuntimeVersionsRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_runtime_versions, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListRuntimeVersionsAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_runtime_version(self, + request: Optional[Union[cloud_tpu.GetRuntimeVersionRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_tpu.RuntimeVersion: + r"""Gets a runtime version. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + async def sample_get_runtime_version(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.GetRuntimeVersionRequest( + name="name_value", + ) + + # Make the request + response = await client.get_runtime_version(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v2alpha1.types.GetRuntimeVersionRequest, dict]]): + The request object. Request for + [GetRuntimeVersion][google.cloud.tpu.v2alpha1.Tpu.GetRuntimeVersion]. + name (:class:`str`): + Required. The resource name. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2alpha1.types.RuntimeVersion: + A runtime version that a Node can be + configured with. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = cloud_tpu.GetRuntimeVersionRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.get_runtime_version, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_guest_attributes(self, + request: Optional[Union[cloud_tpu.GetGuestAttributesRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_tpu.GetGuestAttributesResponse: + r"""Retrieves the guest attributes for the node. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + async def sample_get_guest_attributes(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.GetGuestAttributesRequest( + name="name_value", + ) + + # Make the request + response = await client.get_guest_attributes(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v2alpha1.types.GetGuestAttributesRequest, dict]]): + The request object. Request for + [GetGuestAttributes][google.cloud.tpu.v2alpha1.Tpu.GetGuestAttributes]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2alpha1.types.GetGuestAttributesResponse: + Response for + [GetGuestAttributes][google.cloud.tpu.v2alpha1.Tpu.GetGuestAttributes]. + + """ + # Create or coerce a protobuf request object. + request = cloud_tpu.GetGuestAttributesRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.get_guest_attributes, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def simulate_maintenance_event(self, + request: Optional[Union[cloud_tpu.SimulateMaintenanceEventRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Simulates a maintenance event. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + async def sample_simulate_maintenance_event(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.SimulateMaintenanceEventRequest( + name="name_value", + ) + + # Make the request + operation = client.simulate_maintenance_event(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.tpu_v2alpha1.types.SimulateMaintenanceEventRequest, dict]]): + The request object. Request for + [SimulateMaintenanceEvent][google.cloud.tpu.v2alpha1.Tpu.SimulateMaintenanceEvent]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.tpu_v2alpha1.types.Node` A TPU + instance. + + """ + # Create or coerce a protobuf request object. + request = cloud_tpu.SimulateMaintenanceEventRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.simulate_maintenance_event, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_tpu.Node, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + async def list_operations( + self, + request: Optional[operations_pb2.ListOperationsRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.ListOperationsResponse: + r"""Lists operations that match the specified filter in the request. + + Args: + request (:class:`~.operations_pb2.ListOperationsRequest`): + The request object. Request message for + `ListOperations` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.ListOperationsResponse: + Response message for ``ListOperations`` method. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.ListOperationsRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.list_operations, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + response = await rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + async def get_operation( + self, + request: Optional[operations_pb2.GetOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.Operation: + r"""Gets the latest state of a long-running operation. + + Args: + request (:class:`~.operations_pb2.GetOperationRequest`): + The request object. Request message for + `GetOperation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.Operation: + An ``Operation`` object. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.GetOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.get_operation, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + response = await rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + async def delete_operation( + self, + request: Optional[operations_pb2.DeleteOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes a long-running operation. + + This method indicates that the client is no longer interested + in the operation result. It does not cancel the operation. + If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + + Args: + request (:class:`~.operations_pb2.DeleteOperationRequest`): + The request object. Request message for + `DeleteOperation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + None + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.DeleteOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.delete_operation, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + async def cancel_operation( + self, + request: Optional[operations_pb2.CancelOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Starts asynchronous cancellation on a long-running operation. + + The server makes a best effort to cancel the operation, but success + is not guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + + Args: + request (:class:`~.operations_pb2.CancelOperationRequest`): + The request object. Request message for + `CancelOperation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + None + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.CancelOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.cancel_operation, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + async def get_location( + self, + request: Optional[locations_pb2.GetLocationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> locations_pb2.Location: + r"""Gets information about a location. + + Args: + request (:class:`~.location_pb2.GetLocationRequest`): + The request object. Request message for + `GetLocation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.location_pb2.Location: + Location object. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = locations_pb2.GetLocationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.get_location, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + response = await rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + async def list_locations( + self, + request: Optional[locations_pb2.ListLocationsRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> locations_pb2.ListLocationsResponse: + r"""Lists information about the supported locations for this service. + + Args: + request (:class:`~.location_pb2.ListLocationsRequest`): + The request object. Request message for + `ListLocations` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.location_pb2.ListLocationsResponse: + Response message for ``ListLocations`` method. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = locations_pb2.ListLocationsRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.list_locations, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + response = await rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + async def __aenter__(self): + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__all__ = ( + "TpuAsyncClient", +) diff --git a/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/tpu/client.py b/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/tpu/client.py new file mode 100644 index 0000000..b5997a7 --- /dev/null +++ b/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/tpu/client.py @@ -0,0 +1,2674 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import os +import re +from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast + +from google.cloud.tpu_v2alpha1 import gapic_version as package_version + +from google.api_core import client_options as client_options_lib +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.oauth2 import service_account # type: ignore + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + +from google.api_core import operation # type: ignore +from google.api_core import operation_async # type: ignore +from google.cloud.location import locations_pb2 # type: ignore +from google.cloud.tpu_v2alpha1.services.tpu import pagers +from google.cloud.tpu_v2alpha1.types import cloud_tpu +from google.longrunning import operations_pb2 +from google.protobuf import empty_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from .transports.base import TpuTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import TpuGrpcTransport +from .transports.grpc_asyncio import TpuGrpcAsyncIOTransport + + +class TpuClientMeta(type): + """Metaclass for the Tpu client. + + This provides class-level methods for building and retrieving + support objects (e.g. transport) without polluting the client instance + objects. + """ + _transport_registry = OrderedDict() # type: Dict[str, Type[TpuTransport]] + _transport_registry["grpc"] = TpuGrpcTransport + _transport_registry["grpc_asyncio"] = TpuGrpcAsyncIOTransport + + def get_transport_class(cls, + label: Optional[str] = None, + ) -> Type[TpuTransport]: + """Returns an appropriate transport class. + + Args: + label: The name of the desired transport. If none is + provided, then the first transport in the registry is used. + + Returns: + The transport class to use. + """ + # If a specific transport is requested, return that one. + if label: + return cls._transport_registry[label] + + # No transport is requested; return the default (that is, the first one + # in the dictionary). + return next(iter(cls._transport_registry.values())) + + +class TpuClient(metaclass=TpuClientMeta): + """Manages TPU nodes and other resources + TPU API v2alpha1 + """ + + @staticmethod + def _get_default_mtls_endpoint(api_endpoint): + """Converts api endpoint to mTLS endpoint. + + Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to + "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. + Args: + api_endpoint (Optional[str]): the api endpoint to convert. + Returns: + str: converted mTLS api endpoint. + """ + if not api_endpoint: + return api_endpoint + + mtls_endpoint_re = re.compile( + r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" + ) + + m = mtls_endpoint_re.match(api_endpoint) + name, mtls, sandbox, googledomain = m.groups() + if mtls or not googledomain: + return api_endpoint + + if sandbox: + return api_endpoint.replace( + "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" + ) + + return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") + + DEFAULT_ENDPOINT = "tpu.googleapis.com" + DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore + DEFAULT_ENDPOINT + ) + + @classmethod + def from_service_account_info(cls, info: dict, *args, **kwargs): + """Creates an instance of this client using the provided credentials + info. + + Args: + info (dict): The service account private key info. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + TpuClient: The constructed client. + """ + credentials = service_account.Credentials.from_service_account_info(info) + kwargs["credentials"] = credentials + return cls(*args, **kwargs) + + @classmethod + def from_service_account_file(cls, filename: str, *args, **kwargs): + """Creates an instance of this client using the provided credentials + file. + + Args: + filename (str): The path to the service account private key json + file. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + TpuClient: The constructed client. + """ + credentials = service_account.Credentials.from_service_account_file( + filename) + kwargs["credentials"] = credentials + return cls(*args, **kwargs) + + from_service_account_json = from_service_account_file + + @property + def transport(self) -> TpuTransport: + """Returns the transport used by the client instance. + + Returns: + TpuTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def accelerator_type_path(project: str,location: str,accelerator_type: str,) -> str: + """Returns a fully-qualified accelerator_type string.""" + return "projects/{project}/locations/{location}/acceleratorTypes/{accelerator_type}".format(project=project, location=location, accelerator_type=accelerator_type, ) + + @staticmethod + def parse_accelerator_type_path(path: str) -> Dict[str,str]: + """Parses a accelerator_type path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/acceleratorTypes/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def node_path(project: str,location: str,node: str,) -> str: + """Returns a fully-qualified node string.""" + return "projects/{project}/locations/{location}/nodes/{node}".format(project=project, location=location, node=node, ) + + @staticmethod + def parse_node_path(path: str) -> Dict[str,str]: + """Parses a node path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/nodes/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def queued_resource_path(project: str,location: str,queued_resource: str,) -> str: + """Returns a fully-qualified queued_resource string.""" + return "projects/{project}/locations/{location}/queuedResources/{queued_resource}".format(project=project, location=location, queued_resource=queued_resource, ) + + @staticmethod + def parse_queued_resource_path(path: str) -> Dict[str,str]: + """Parses a queued_resource path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/queuedResources/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def runtime_version_path(project: str,location: str,runtime_version: str,) -> str: + """Returns a fully-qualified runtime_version string.""" + return "projects/{project}/locations/{location}/runtimeVersions/{runtime_version}".format(project=project, location=location, runtime_version=runtime_version, ) + + @staticmethod + def parse_runtime_version_path(path: str) -> Dict[str,str]: + """Parses a runtime_version path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/runtimeVersions/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_billing_account_path(billing_account: str, ) -> str: + """Returns a fully-qualified billing_account string.""" + return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + + @staticmethod + def parse_common_billing_account_path(path: str) -> Dict[str,str]: + """Parse a billing_account path into its component segments.""" + m = re.match(r"^billingAccounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_folder_path(folder: str, ) -> str: + """Returns a fully-qualified folder string.""" + return "folders/{folder}".format(folder=folder, ) + + @staticmethod + def parse_common_folder_path(path: str) -> Dict[str,str]: + """Parse a folder path into its component segments.""" + m = re.match(r"^folders/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_organization_path(organization: str, ) -> str: + """Returns a fully-qualified organization string.""" + return "organizations/{organization}".format(organization=organization, ) + + @staticmethod + def parse_common_organization_path(path: str) -> Dict[str,str]: + """Parse a organization path into its component segments.""" + m = re.match(r"^organizations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_project_path(project: str, ) -> str: + """Returns a fully-qualified project string.""" + return "projects/{project}".format(project=project, ) + + @staticmethod + def parse_common_project_path(path: str) -> Dict[str,str]: + """Parse a project path into its component segments.""" + m = re.match(r"^projects/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_location_path(project: str, location: str, ) -> str: + """Returns a fully-qualified location string.""" + return "projects/{project}/locations/{location}".format(project=project, location=location, ) + + @staticmethod + def parse_common_location_path(path: str) -> Dict[str,str]: + """Parse a location path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @classmethod + def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_options_lib.ClientOptions] = None): + """Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variable is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + if client_options is None: + client_options = client_options_lib.ClientOptions() + use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") + use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_client_cert not in ("true", "false"): + raise ValueError("Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`") + if use_mtls_endpoint not in ("auto", "never", "always"): + raise MutualTLSChannelError("Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`") + + # Figure out the client cert source to use. + client_cert_source = None + if use_client_cert == "true": + if client_options.client_cert_source: + client_cert_source = client_options.client_cert_source + elif mtls.has_default_client_cert_source(): + client_cert_source = mtls.default_client_cert_source() + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): + api_endpoint = cls.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = cls.DEFAULT_ENDPOINT + + return api_endpoint, client_cert_source + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[Union[str, TpuTransport]] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the tpu client. + + Args: + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + transport (Union[str, TpuTransport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): Custom options for the + client. It won't take effect if a ``transport`` instance is provided. + (1) The ``api_endpoint`` property can be used to override the + default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT + environment variable can also be used to override the endpoint: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto switch to the + default mTLS endpoint if client certificate is present, this is + the default value). However, the ``api_endpoint`` property takes + precedence if provided. + (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide client certificate for mutual TLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + """ + if isinstance(client_options, dict): + client_options = client_options_lib.from_dict(client_options) + if client_options is None: + client_options = client_options_lib.ClientOptions() + client_options = cast(client_options_lib.ClientOptions, client_options) + + api_endpoint, client_cert_source_func = self.get_mtls_endpoint_and_cert_source(client_options) + + api_key_value = getattr(client_options, "api_key", None) + if api_key_value and credentials: + raise ValueError("client_options.api_key and credentials are mutually exclusive") + + # Save or instantiate the transport. + # Ordinarily, we provide the transport, but allowing a custom transport + # instance provides an extensibility point for unusual situations. + if isinstance(transport, TpuTransport): + # transport is a TpuTransport instance. + if credentials or client_options.credentials_file or api_key_value: + raise ValueError("When providing a transport instance, " + "provide its credentials directly.") + if client_options.scopes: + raise ValueError( + "When providing a transport instance, provide its scopes " + "directly." + ) + self._transport = transport + else: + import google.auth._default # type: ignore + + if api_key_value and hasattr(google.auth._default, "get_api_key_credentials"): + credentials = google.auth._default.get_api_key_credentials(api_key_value) + + Transport = type(self).get_transport_class(transport) + self._transport = Transport( + credentials=credentials, + credentials_file=client_options.credentials_file, + host=api_endpoint, + scopes=client_options.scopes, + client_cert_source_for_mtls=client_cert_source_func, + quota_project_id=client_options.quota_project_id, + client_info=client_info, + always_use_jwt_access=True, + api_audience=client_options.api_audience, + ) + + def list_nodes(self, + request: Optional[Union[cloud_tpu.ListNodesRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListNodesPager: + r"""Lists nodes. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + def sample_list_nodes(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.ListNodesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_nodes(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.tpu_v2alpha1.types.ListNodesRequest, dict]): + The request object. Request for + [ListNodes][google.cloud.tpu.v2alpha1.Tpu.ListNodes]. + parent (str): + Required. The parent resource name. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2alpha1.services.tpu.pagers.ListNodesPager: + Response for + [ListNodes][google.cloud.tpu.v2alpha1.Tpu.ListNodes]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.ListNodesRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.ListNodesRequest): + request = cloud_tpu.ListNodesRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_nodes] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListNodesPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_node(self, + request: Optional[Union[cloud_tpu.GetNodeRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_tpu.Node: + r"""Gets the details of a node. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + def sample_get_node(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.GetNodeRequest( + name="name_value", + ) + + # Make the request + response = client.get_node(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.tpu_v2alpha1.types.GetNodeRequest, dict]): + The request object. Request for + [GetNode][google.cloud.tpu.v2alpha1.Tpu.GetNode]. + name (str): + Required. The resource name. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2alpha1.types.Node: + A TPU instance. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.GetNodeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.GetNodeRequest): + request = cloud_tpu.GetNodeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_node] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def create_node(self, + request: Optional[Union[cloud_tpu.CreateNodeRequest, dict]] = None, + *, + parent: Optional[str] = None, + node: Optional[cloud_tpu.Node] = None, + node_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Creates a node. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + def sample_create_node(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + node = tpu_v2alpha1.Node() + node.runtime_version = "runtime_version_value" + + request = tpu_v2alpha1.CreateNodeRequest( + parent="parent_value", + node=node, + ) + + # Make the request + operation = client.create_node(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.tpu_v2alpha1.types.CreateNodeRequest, dict]): + The request object. Request for + [CreateNode][google.cloud.tpu.v2alpha1.Tpu.CreateNode]. + parent (str): + Required. The parent resource name. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + node (google.cloud.tpu_v2alpha1.types.Node): + Required. The node. + This corresponds to the ``node`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + node_id (str): + The unqualified resource name. + This corresponds to the ``node_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.tpu_v2alpha1.types.Node` A TPU + instance. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, node, node_id]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.CreateNodeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.CreateNodeRequest): + request = cloud_tpu.CreateNodeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if node is not None: + request.node = node + if node_id is not None: + request.node_id = node_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_node] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_tpu.Node, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + def delete_node(self, + request: Optional[Union[cloud_tpu.DeleteNodeRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Deletes a node. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + def sample_delete_node(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.DeleteNodeRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_node(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.tpu_v2alpha1.types.DeleteNodeRequest, dict]): + The request object. Request for + [DeleteNode][google.cloud.tpu.v2alpha1.Tpu.DeleteNode]. + name (str): + Required. The resource name. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to + use it as the request or the response type of an API + method. For instance: + + service Foo { + rpc Bar(google.protobuf.Empty) returns + (google.protobuf.Empty); + + } + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.DeleteNodeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.DeleteNodeRequest): + request = cloud_tpu.DeleteNodeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.delete_node] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + empty_pb2.Empty, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + def stop_node(self, + request: Optional[Union[cloud_tpu.StopNodeRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Stops a node. This operation is only available with + single TPU nodes. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + def sample_stop_node(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.StopNodeRequest( + name="name_value", + ) + + # Make the request + operation = client.stop_node(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.tpu_v2alpha1.types.StopNodeRequest, dict]): + The request object. Request for + [StopNode][google.cloud.tpu.v2alpha1.Tpu.StopNode]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.tpu_v2alpha1.types.Node` A TPU + instance. + + """ + # Create or coerce a protobuf request object. + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.StopNodeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.StopNodeRequest): + request = cloud_tpu.StopNodeRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.stop_node] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_tpu.Node, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + def start_node(self, + request: Optional[Union[cloud_tpu.StartNodeRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Starts a node. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + def sample_start_node(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.StartNodeRequest( + name="name_value", + ) + + # Make the request + operation = client.start_node(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.tpu_v2alpha1.types.StartNodeRequest, dict]): + The request object. Request for + [StartNode][google.cloud.tpu.v2alpha1.Tpu.StartNode]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.tpu_v2alpha1.types.Node` A TPU + instance. + + """ + # Create or coerce a protobuf request object. + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.StartNodeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.StartNodeRequest): + request = cloud_tpu.StartNodeRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.start_node] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_tpu.Node, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + def update_node(self, + request: Optional[Union[cloud_tpu.UpdateNodeRequest, dict]] = None, + *, + node: Optional[cloud_tpu.Node] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Updates the configurations of a node. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + def sample_update_node(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + node = tpu_v2alpha1.Node() + node.runtime_version = "runtime_version_value" + + request = tpu_v2alpha1.UpdateNodeRequest( + node=node, + ) + + # Make the request + operation = client.update_node(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.tpu_v2alpha1.types.UpdateNodeRequest, dict]): + The request object. Request for + [UpdateNode][google.cloud.tpu.v2alpha1.Tpu.UpdateNode]. + node (google.cloud.tpu_v2alpha1.types.Node): + Required. The node. Only fields specified in update_mask + are updated. + + This corresponds to the ``node`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Required. Mask of fields from [Node][Tpu.Node] to + update. Supported fields: [description, tags, labels, + metadata, network_config.enable_external_ips]. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.tpu_v2alpha1.types.Node` A TPU + instance. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([node, update_mask]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.UpdateNodeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.UpdateNodeRequest): + request = cloud_tpu.UpdateNodeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if node is not None: + request.node = node + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.update_node] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("node.name", request.node.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_tpu.Node, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + def list_queued_resources(self, + request: Optional[Union[cloud_tpu.ListQueuedResourcesRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListQueuedResourcesPager: + r"""Lists queued resources. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + def sample_list_queued_resources(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.ListQueuedResourcesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_queued_resources(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.tpu_v2alpha1.types.ListQueuedResourcesRequest, dict]): + The request object. Request for + [ListQueuedResources][google.cloud.tpu.v2alpha1.Tpu.ListQueuedResources]. + parent (str): + Required. The parent resource name. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2alpha1.services.tpu.pagers.ListQueuedResourcesPager: + Response for + [ListQueuedResources][google.cloud.tpu.v2alpha1.Tpu.ListQueuedResources]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.ListQueuedResourcesRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.ListQueuedResourcesRequest): + request = cloud_tpu.ListQueuedResourcesRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_queued_resources] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListQueuedResourcesPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_queued_resource(self, + request: Optional[Union[cloud_tpu.GetQueuedResourceRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_tpu.QueuedResource: + r"""Gets details of a queued resource. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + def sample_get_queued_resource(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.GetQueuedResourceRequest( + name="name_value", + ) + + # Make the request + response = client.get_queued_resource(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.tpu_v2alpha1.types.GetQueuedResourceRequest, dict]): + The request object. Request for + [GetQueuedResource][google.cloud.tpu.v2alpha1.Tpu.GetQueuedResource] + name (str): + Required. The resource name. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2alpha1.types.QueuedResource: + A QueuedResource represents a request + for resources that will be placed in a + queue and fulfilled when the necessary + resources are available. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.GetQueuedResourceRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.GetQueuedResourceRequest): + request = cloud_tpu.GetQueuedResourceRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_queued_resource] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def create_queued_resource(self, + request: Optional[Union[cloud_tpu.CreateQueuedResourceRequest, dict]] = None, + *, + parent: Optional[str] = None, + queued_resource: Optional[cloud_tpu.QueuedResource] = None, + queued_resource_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Creates a QueuedResource TPU instance. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + def sample_create_queued_resource(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.CreateQueuedResourceRequest( + parent="parent_value", + ) + + # Make the request + operation = client.create_queued_resource(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.tpu_v2alpha1.types.CreateQueuedResourceRequest, dict]): + The request object. Request for + [CreateQueuedResource][google.cloud.tpu.v2alpha1.Tpu.CreateQueuedResource]. + parent (str): + Required. The parent resource name. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + queued_resource (google.cloud.tpu_v2alpha1.types.QueuedResource): + Required. The queued resource. + This corresponds to the ``queued_resource`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + queued_resource_id (str): + The unqualified resource name. Should follow the + ``^[A-Za-z0-9_.~+%-]+$`` regex format. + + This corresponds to the ``queued_resource_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.tpu_v2alpha1.types.QueuedResource` A QueuedResource represents a request for resources that will be placed + in a queue and fulfilled when the necessary resources + are available. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, queued_resource, queued_resource_id]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.CreateQueuedResourceRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.CreateQueuedResourceRequest): + request = cloud_tpu.CreateQueuedResourceRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if queued_resource is not None: + request.queued_resource = queued_resource + if queued_resource_id is not None: + request.queued_resource_id = queued_resource_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_queued_resource] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_tpu.QueuedResource, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + def delete_queued_resource(self, + request: Optional[Union[cloud_tpu.DeleteQueuedResourceRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Deletes a QueuedResource TPU instance. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + def sample_delete_queued_resource(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.DeleteQueuedResourceRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_queued_resource(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.tpu_v2alpha1.types.DeleteQueuedResourceRequest, dict]): + The request object. Request for + [DeleteQueuedResource][google.cloud.tpu.v2alpha1.Tpu.DeleteQueuedResource]. + name (str): + Required. The resource name. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.tpu_v2alpha1.types.QueuedResource` A QueuedResource represents a request for resources that will be placed + in a queue and fulfilled when the necessary resources + are available. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.DeleteQueuedResourceRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.DeleteQueuedResourceRequest): + request = cloud_tpu.DeleteQueuedResourceRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.delete_queued_resource] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_tpu.QueuedResource, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + def generate_service_identity(self, + request: Optional[Union[cloud_tpu.GenerateServiceIdentityRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_tpu.GenerateServiceIdentityResponse: + r"""Generates the Cloud TPU service identity for the + project. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + def sample_generate_service_identity(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.GenerateServiceIdentityRequest( + parent="parent_value", + ) + + # Make the request + response = client.generate_service_identity(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.tpu_v2alpha1.types.GenerateServiceIdentityRequest, dict]): + The request object. Request for + [GenerateServiceIdentity][google.cloud.tpu.v2alpha1.Tpu.GenerateServiceIdentity]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2alpha1.types.GenerateServiceIdentityResponse: + Response for + [GenerateServiceIdentity][google.cloud.tpu.v2alpha1.Tpu.GenerateServiceIdentity]. + + """ + # Create or coerce a protobuf request object. + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.GenerateServiceIdentityRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.GenerateServiceIdentityRequest): + request = cloud_tpu.GenerateServiceIdentityRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.generate_service_identity] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def list_accelerator_types(self, + request: Optional[Union[cloud_tpu.ListAcceleratorTypesRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListAcceleratorTypesPager: + r"""Lists accelerator types supported by this API. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + def sample_list_accelerator_types(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.ListAcceleratorTypesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_accelerator_types(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.tpu_v2alpha1.types.ListAcceleratorTypesRequest, dict]): + The request object. Request for + [ListAcceleratorTypes][google.cloud.tpu.v2alpha1.Tpu.ListAcceleratorTypes]. + parent (str): + Required. The parent resource name. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2alpha1.services.tpu.pagers.ListAcceleratorTypesPager: + Response for + [ListAcceleratorTypes][google.cloud.tpu.v2alpha1.Tpu.ListAcceleratorTypes]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.ListAcceleratorTypesRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.ListAcceleratorTypesRequest): + request = cloud_tpu.ListAcceleratorTypesRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_accelerator_types] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListAcceleratorTypesPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_accelerator_type(self, + request: Optional[Union[cloud_tpu.GetAcceleratorTypeRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_tpu.AcceleratorType: + r"""Gets AcceleratorType. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + def sample_get_accelerator_type(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.GetAcceleratorTypeRequest( + name="name_value", + ) + + # Make the request + response = client.get_accelerator_type(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.tpu_v2alpha1.types.GetAcceleratorTypeRequest, dict]): + The request object. Request for + [GetAcceleratorType][google.cloud.tpu.v2alpha1.Tpu.GetAcceleratorType]. + name (str): + Required. The resource name. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2alpha1.types.AcceleratorType: + A accelerator type that a Node can be + configured with. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.GetAcceleratorTypeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.GetAcceleratorTypeRequest): + request = cloud_tpu.GetAcceleratorTypeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_accelerator_type] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def list_runtime_versions(self, + request: Optional[Union[cloud_tpu.ListRuntimeVersionsRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListRuntimeVersionsPager: + r"""Lists runtime versions supported by this API. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + def sample_list_runtime_versions(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.ListRuntimeVersionsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_runtime_versions(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.tpu_v2alpha1.types.ListRuntimeVersionsRequest, dict]): + The request object. Request for + [ListRuntimeVersions][google.cloud.tpu.v2alpha1.Tpu.ListRuntimeVersions]. + parent (str): + Required. The parent resource name. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2alpha1.services.tpu.pagers.ListRuntimeVersionsPager: + Response for + [ListRuntimeVersions][google.cloud.tpu.v2alpha1.Tpu.ListRuntimeVersions]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.ListRuntimeVersionsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.ListRuntimeVersionsRequest): + request = cloud_tpu.ListRuntimeVersionsRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_runtime_versions] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListRuntimeVersionsPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_runtime_version(self, + request: Optional[Union[cloud_tpu.GetRuntimeVersionRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_tpu.RuntimeVersion: + r"""Gets a runtime version. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + def sample_get_runtime_version(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.GetRuntimeVersionRequest( + name="name_value", + ) + + # Make the request + response = client.get_runtime_version(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.tpu_v2alpha1.types.GetRuntimeVersionRequest, dict]): + The request object. Request for + [GetRuntimeVersion][google.cloud.tpu.v2alpha1.Tpu.GetRuntimeVersion]. + name (str): + Required. The resource name. + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2alpha1.types.RuntimeVersion: + A runtime version that a Node can be + configured with. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.GetRuntimeVersionRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.GetRuntimeVersionRequest): + request = cloud_tpu.GetRuntimeVersionRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_runtime_version] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_guest_attributes(self, + request: Optional[Union[cloud_tpu.GetGuestAttributesRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_tpu.GetGuestAttributesResponse: + r"""Retrieves the guest attributes for the node. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + def sample_get_guest_attributes(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.GetGuestAttributesRequest( + name="name_value", + ) + + # Make the request + response = client.get_guest_attributes(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.tpu_v2alpha1.types.GetGuestAttributesRequest, dict]): + The request object. Request for + [GetGuestAttributes][google.cloud.tpu.v2alpha1.Tpu.GetGuestAttributes]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.tpu_v2alpha1.types.GetGuestAttributesResponse: + Response for + [GetGuestAttributes][google.cloud.tpu.v2alpha1.Tpu.GetGuestAttributes]. + + """ + # Create or coerce a protobuf request object. + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.GetGuestAttributesRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.GetGuestAttributesRequest): + request = cloud_tpu.GetGuestAttributesRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_guest_attributes] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def simulate_maintenance_event(self, + request: Optional[Union[cloud_tpu.SimulateMaintenanceEventRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Simulates a maintenance event. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import tpu_v2alpha1 + + def sample_simulate_maintenance_event(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.SimulateMaintenanceEventRequest( + name="name_value", + ) + + # Make the request + operation = client.simulate_maintenance_event(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.tpu_v2alpha1.types.SimulateMaintenanceEventRequest, dict]): + The request object. Request for + [SimulateMaintenanceEvent][google.cloud.tpu.v2alpha1.Tpu.SimulateMaintenanceEvent]. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.tpu_v2alpha1.types.Node` A TPU + instance. + + """ + # Create or coerce a protobuf request object. + # Minor optimization to avoid making a copy if the user passes + # in a cloud_tpu.SimulateMaintenanceEventRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_tpu.SimulateMaintenanceEventRequest): + request = cloud_tpu.SimulateMaintenanceEventRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.simulate_maintenance_event] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_tpu.Node, + metadata_type=cloud_tpu.OperationMetadata, + ) + + # Done; return the response. + return response + + def __enter__(self) -> "TpuClient": + return self + + def __exit__(self, type, value, traceback): + """Releases underlying transport's resources. + + .. warning:: + ONLY use as a context manager if the transport is NOT shared + with other clients! Exiting the with block will CLOSE the transport + and may cause errors in other clients! + """ + self.transport.close() + + def list_operations( + self, + request: Optional[operations_pb2.ListOperationsRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.ListOperationsResponse: + r"""Lists operations that match the specified filter in the request. + + Args: + request (:class:`~.operations_pb2.ListOperationsRequest`): + The request object. Request message for + `ListOperations` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.ListOperationsResponse: + Response message for ``ListOperations`` method. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.ListOperationsRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.list_operations, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + response = rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + def get_operation( + self, + request: Optional[operations_pb2.GetOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.Operation: + r"""Gets the latest state of a long-running operation. + + Args: + request (:class:`~.operations_pb2.GetOperationRequest`): + The request object. Request message for + `GetOperation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.Operation: + An ``Operation`` object. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.GetOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.get_operation, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + response = rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + def delete_operation( + self, + request: Optional[operations_pb2.DeleteOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes a long-running operation. + + This method indicates that the client is no longer interested + in the operation result. It does not cancel the operation. + If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + + Args: + request (:class:`~.operations_pb2.DeleteOperationRequest`): + The request object. Request message for + `DeleteOperation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + None + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.DeleteOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.delete_operation, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + def cancel_operation( + self, + request: Optional[operations_pb2.CancelOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Starts asynchronous cancellation on a long-running operation. + + The server makes a best effort to cancel the operation, but success + is not guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + + Args: + request (:class:`~.operations_pb2.CancelOperationRequest`): + The request object. Request message for + `CancelOperation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + None + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.CancelOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.cancel_operation, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + def get_location( + self, + request: Optional[locations_pb2.GetLocationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> locations_pb2.Location: + r"""Gets information about a location. + + Args: + request (:class:`~.location_pb2.GetLocationRequest`): + The request object. Request message for + `GetLocation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.location_pb2.Location: + Location object. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = locations_pb2.GetLocationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.get_location, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + response = rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + def list_locations( + self, + request: Optional[locations_pb2.ListLocationsRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> locations_pb2.ListLocationsResponse: + r"""Lists information about the supported locations for this service. + + Args: + request (:class:`~.location_pb2.ListLocationsRequest`): + The request object. Request message for + `ListLocations` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.location_pb2.ListLocationsResponse: + Response message for ``ListLocations`` method. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = locations_pb2.ListLocationsRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.list_locations, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("name", request.name),)), + ) + + # Send the request. + response = rpc( + request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__all__ = ( + "TpuClient", +) diff --git a/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/tpu/pagers.py b/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/tpu/pagers.py new file mode 100644 index 0000000..d074b6e --- /dev/null +++ b/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/tpu/pagers.py @@ -0,0 +1,502 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from typing import Any, AsyncIterator, Awaitable, Callable, Sequence, Tuple, Optional, Iterator + +from google.cloud.tpu_v2alpha1.types import cloud_tpu + + +class ListNodesPager: + """A pager for iterating through ``list_nodes`` requests. + + This class thinly wraps an initial + :class:`google.cloud.tpu_v2alpha1.types.ListNodesResponse` object, and + provides an ``__iter__`` method to iterate through its + ``nodes`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListNodes`` requests and continue to iterate + through the ``nodes`` field on the + corresponding responses. + + All the usual :class:`google.cloud.tpu_v2alpha1.types.ListNodesResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., cloud_tpu.ListNodesResponse], + request: cloud_tpu.ListNodesRequest, + response: cloud_tpu.ListNodesResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.tpu_v2alpha1.types.ListNodesRequest): + The initial request object. + response (google.cloud.tpu_v2alpha1.types.ListNodesResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_tpu.ListNodesRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[cloud_tpu.ListNodesResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[cloud_tpu.Node]: + for page in self.pages: + yield from page.nodes + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListNodesAsyncPager: + """A pager for iterating through ``list_nodes`` requests. + + This class thinly wraps an initial + :class:`google.cloud.tpu_v2alpha1.types.ListNodesResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``nodes`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListNodes`` requests and continue to iterate + through the ``nodes`` field on the + corresponding responses. + + All the usual :class:`google.cloud.tpu_v2alpha1.types.ListNodesResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., Awaitable[cloud_tpu.ListNodesResponse]], + request: cloud_tpu.ListNodesRequest, + response: cloud_tpu.ListNodesResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.tpu_v2alpha1.types.ListNodesRequest): + The initial request object. + response (google.cloud.tpu_v2alpha1.types.ListNodesResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_tpu.ListNodesRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[cloud_tpu.ListNodesResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + def __aiter__(self) -> AsyncIterator[cloud_tpu.Node]: + async def async_generator(): + async for page in self.pages: + for response in page.nodes: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListQueuedResourcesPager: + """A pager for iterating through ``list_queued_resources`` requests. + + This class thinly wraps an initial + :class:`google.cloud.tpu_v2alpha1.types.ListQueuedResourcesResponse` object, and + provides an ``__iter__`` method to iterate through its + ``queued_resources`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListQueuedResources`` requests and continue to iterate + through the ``queued_resources`` field on the + corresponding responses. + + All the usual :class:`google.cloud.tpu_v2alpha1.types.ListQueuedResourcesResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., cloud_tpu.ListQueuedResourcesResponse], + request: cloud_tpu.ListQueuedResourcesRequest, + response: cloud_tpu.ListQueuedResourcesResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.tpu_v2alpha1.types.ListQueuedResourcesRequest): + The initial request object. + response (google.cloud.tpu_v2alpha1.types.ListQueuedResourcesResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_tpu.ListQueuedResourcesRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[cloud_tpu.ListQueuedResourcesResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[cloud_tpu.QueuedResource]: + for page in self.pages: + yield from page.queued_resources + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListQueuedResourcesAsyncPager: + """A pager for iterating through ``list_queued_resources`` requests. + + This class thinly wraps an initial + :class:`google.cloud.tpu_v2alpha1.types.ListQueuedResourcesResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``queued_resources`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListQueuedResources`` requests and continue to iterate + through the ``queued_resources`` field on the + corresponding responses. + + All the usual :class:`google.cloud.tpu_v2alpha1.types.ListQueuedResourcesResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., Awaitable[cloud_tpu.ListQueuedResourcesResponse]], + request: cloud_tpu.ListQueuedResourcesRequest, + response: cloud_tpu.ListQueuedResourcesResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.tpu_v2alpha1.types.ListQueuedResourcesRequest): + The initial request object. + response (google.cloud.tpu_v2alpha1.types.ListQueuedResourcesResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_tpu.ListQueuedResourcesRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[cloud_tpu.ListQueuedResourcesResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + def __aiter__(self) -> AsyncIterator[cloud_tpu.QueuedResource]: + async def async_generator(): + async for page in self.pages: + for response in page.queued_resources: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListAcceleratorTypesPager: + """A pager for iterating through ``list_accelerator_types`` requests. + + This class thinly wraps an initial + :class:`google.cloud.tpu_v2alpha1.types.ListAcceleratorTypesResponse` object, and + provides an ``__iter__`` method to iterate through its + ``accelerator_types`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListAcceleratorTypes`` requests and continue to iterate + through the ``accelerator_types`` field on the + corresponding responses. + + All the usual :class:`google.cloud.tpu_v2alpha1.types.ListAcceleratorTypesResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., cloud_tpu.ListAcceleratorTypesResponse], + request: cloud_tpu.ListAcceleratorTypesRequest, + response: cloud_tpu.ListAcceleratorTypesResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.tpu_v2alpha1.types.ListAcceleratorTypesRequest): + The initial request object. + response (google.cloud.tpu_v2alpha1.types.ListAcceleratorTypesResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_tpu.ListAcceleratorTypesRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[cloud_tpu.ListAcceleratorTypesResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[cloud_tpu.AcceleratorType]: + for page in self.pages: + yield from page.accelerator_types + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListAcceleratorTypesAsyncPager: + """A pager for iterating through ``list_accelerator_types`` requests. + + This class thinly wraps an initial + :class:`google.cloud.tpu_v2alpha1.types.ListAcceleratorTypesResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``accelerator_types`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListAcceleratorTypes`` requests and continue to iterate + through the ``accelerator_types`` field on the + corresponding responses. + + All the usual :class:`google.cloud.tpu_v2alpha1.types.ListAcceleratorTypesResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., Awaitable[cloud_tpu.ListAcceleratorTypesResponse]], + request: cloud_tpu.ListAcceleratorTypesRequest, + response: cloud_tpu.ListAcceleratorTypesResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.tpu_v2alpha1.types.ListAcceleratorTypesRequest): + The initial request object. + response (google.cloud.tpu_v2alpha1.types.ListAcceleratorTypesResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_tpu.ListAcceleratorTypesRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[cloud_tpu.ListAcceleratorTypesResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + def __aiter__(self) -> AsyncIterator[cloud_tpu.AcceleratorType]: + async def async_generator(): + async for page in self.pages: + for response in page.accelerator_types: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListRuntimeVersionsPager: + """A pager for iterating through ``list_runtime_versions`` requests. + + This class thinly wraps an initial + :class:`google.cloud.tpu_v2alpha1.types.ListRuntimeVersionsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``runtime_versions`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListRuntimeVersions`` requests and continue to iterate + through the ``runtime_versions`` field on the + corresponding responses. + + All the usual :class:`google.cloud.tpu_v2alpha1.types.ListRuntimeVersionsResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., cloud_tpu.ListRuntimeVersionsResponse], + request: cloud_tpu.ListRuntimeVersionsRequest, + response: cloud_tpu.ListRuntimeVersionsResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.tpu_v2alpha1.types.ListRuntimeVersionsRequest): + The initial request object. + response (google.cloud.tpu_v2alpha1.types.ListRuntimeVersionsResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_tpu.ListRuntimeVersionsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[cloud_tpu.ListRuntimeVersionsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[cloud_tpu.RuntimeVersion]: + for page in self.pages: + yield from page.runtime_versions + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListRuntimeVersionsAsyncPager: + """A pager for iterating through ``list_runtime_versions`` requests. + + This class thinly wraps an initial + :class:`google.cloud.tpu_v2alpha1.types.ListRuntimeVersionsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``runtime_versions`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListRuntimeVersions`` requests and continue to iterate + through the ``runtime_versions`` field on the + corresponding responses. + + All the usual :class:`google.cloud.tpu_v2alpha1.types.ListRuntimeVersionsResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + def __init__(self, + method: Callable[..., Awaitable[cloud_tpu.ListRuntimeVersionsResponse]], + request: cloud_tpu.ListRuntimeVersionsRequest, + response: cloud_tpu.ListRuntimeVersionsResponse, + *, + metadata: Sequence[Tuple[str, str]] = ()): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.tpu_v2alpha1.types.ListRuntimeVersionsRequest): + The initial request object. + response (google.cloud.tpu_v2alpha1.types.ListRuntimeVersionsResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_tpu.ListRuntimeVersionsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[cloud_tpu.ListRuntimeVersionsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + def __aiter__(self) -> AsyncIterator[cloud_tpu.RuntimeVersion]: + async def async_generator(): + async for page in self.pages: + for response in page.runtime_versions: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) diff --git a/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/tpu/transports/__init__.py b/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/tpu/transports/__init__.py new file mode 100644 index 0000000..2064034 --- /dev/null +++ b/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/tpu/transports/__init__.py @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +from typing import Dict, Type + +from .base import TpuTransport +from .grpc import TpuGrpcTransport +from .grpc_asyncio import TpuGrpcAsyncIOTransport + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[TpuTransport]] +_transport_registry['grpc'] = TpuGrpcTransport +_transport_registry['grpc_asyncio'] = TpuGrpcAsyncIOTransport + +__all__ = ( + 'TpuTransport', + 'TpuGrpcTransport', + 'TpuGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/tpu/transports/base.py b/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/tpu/transports/base.py new file mode 100644 index 0000000..069d31d --- /dev/null +++ b/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/tpu/transports/base.py @@ -0,0 +1,447 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import abc +from typing import Awaitable, Callable, Dict, Optional, Sequence, Union + +from google.cloud.tpu_v2alpha1 import gapic_version as package_version + +import google.auth # type: ignore +import google.api_core +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.api_core import operations_v1 +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.location import locations_pb2 # type: ignore +from google.cloud.tpu_v2alpha1.types import cloud_tpu +from google.longrunning import operations_pb2 +from google.longrunning import operations_pb2 # type: ignore + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +class TpuTransport(abc.ABC): + """Abstract transport class for Tpu.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/cloud-platform', + ) + + DEFAULT_HOST: str = 'tpu.googleapis.com' + def __init__( + self, *, + host: str = DEFAULT_HOST, + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + **kwargs, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A list of scopes. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + """ + + scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES} + + # Save the scopes. + self._scopes = scopes + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") + + if credentials_file is not None: + credentials, _ = google.auth.load_credentials_from_file( + credentials_file, + **scopes_kwargs, + quota_project_id=quota_project_id + ) + elif credentials is None: + credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) + # Don't apply audience if the credentials file passed from user. + if hasattr(credentials, "with_gdch_audience"): + credentials = credentials.with_gdch_audience(api_audience if api_audience else host) + + # If the credentials are service account credentials, then always try to use self signed JWT. + if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): + credentials = credentials.with_always_use_jwt_access(True) + + # Save the credentials. + self._credentials = credentials + + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.list_nodes: gapic_v1.method.wrap_method( + self.list_nodes, + default_timeout=None, + client_info=client_info, + ), + self.get_node: gapic_v1.method.wrap_method( + self.get_node, + default_timeout=None, + client_info=client_info, + ), + self.create_node: gapic_v1.method.wrap_method( + self.create_node, + default_timeout=None, + client_info=client_info, + ), + self.delete_node: gapic_v1.method.wrap_method( + self.delete_node, + default_timeout=None, + client_info=client_info, + ), + self.stop_node: gapic_v1.method.wrap_method( + self.stop_node, + default_timeout=None, + client_info=client_info, + ), + self.start_node: gapic_v1.method.wrap_method( + self.start_node, + default_timeout=None, + client_info=client_info, + ), + self.update_node: gapic_v1.method.wrap_method( + self.update_node, + default_timeout=None, + client_info=client_info, + ), + self.list_queued_resources: gapic_v1.method.wrap_method( + self.list_queued_resources, + default_timeout=None, + client_info=client_info, + ), + self.get_queued_resource: gapic_v1.method.wrap_method( + self.get_queued_resource, + default_timeout=None, + client_info=client_info, + ), + self.create_queued_resource: gapic_v1.method.wrap_method( + self.create_queued_resource, + default_timeout=None, + client_info=client_info, + ), + self.delete_queued_resource: gapic_v1.method.wrap_method( + self.delete_queued_resource, + default_timeout=None, + client_info=client_info, + ), + self.generate_service_identity: gapic_v1.method.wrap_method( + self.generate_service_identity, + default_timeout=None, + client_info=client_info, + ), + self.list_accelerator_types: gapic_v1.method.wrap_method( + self.list_accelerator_types, + default_timeout=None, + client_info=client_info, + ), + self.get_accelerator_type: gapic_v1.method.wrap_method( + self.get_accelerator_type, + default_timeout=None, + client_info=client_info, + ), + self.list_runtime_versions: gapic_v1.method.wrap_method( + self.list_runtime_versions, + default_timeout=None, + client_info=client_info, + ), + self.get_runtime_version: gapic_v1.method.wrap_method( + self.get_runtime_version, + default_timeout=None, + client_info=client_info, + ), + self.get_guest_attributes: gapic_v1.method.wrap_method( + self.get_guest_attributes, + default_timeout=None, + client_info=client_info, + ), + self.simulate_maintenance_event: gapic_v1.method.wrap_method( + self.simulate_maintenance_event, + default_timeout=None, + client_info=client_info, + ), + } + + def close(self): + """Closes resources associated with the transport. + + .. warning:: + Only call this method if the transport is NOT shared + with other clients - this may cause errors in other clients! + """ + raise NotImplementedError() + + @property + def operations_client(self): + """Return the client designed to process long-running operations.""" + raise NotImplementedError() + + @property + def list_nodes(self) -> Callable[ + [cloud_tpu.ListNodesRequest], + Union[ + cloud_tpu.ListNodesResponse, + Awaitable[cloud_tpu.ListNodesResponse] + ]]: + raise NotImplementedError() + + @property + def get_node(self) -> Callable[ + [cloud_tpu.GetNodeRequest], + Union[ + cloud_tpu.Node, + Awaitable[cloud_tpu.Node] + ]]: + raise NotImplementedError() + + @property + def create_node(self) -> Callable[ + [cloud_tpu.CreateNodeRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def delete_node(self) -> Callable[ + [cloud_tpu.DeleteNodeRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def stop_node(self) -> Callable[ + [cloud_tpu.StopNodeRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def start_node(self) -> Callable[ + [cloud_tpu.StartNodeRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def update_node(self) -> Callable[ + [cloud_tpu.UpdateNodeRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def list_queued_resources(self) -> Callable[ + [cloud_tpu.ListQueuedResourcesRequest], + Union[ + cloud_tpu.ListQueuedResourcesResponse, + Awaitable[cloud_tpu.ListQueuedResourcesResponse] + ]]: + raise NotImplementedError() + + @property + def get_queued_resource(self) -> Callable[ + [cloud_tpu.GetQueuedResourceRequest], + Union[ + cloud_tpu.QueuedResource, + Awaitable[cloud_tpu.QueuedResource] + ]]: + raise NotImplementedError() + + @property + def create_queued_resource(self) -> Callable[ + [cloud_tpu.CreateQueuedResourceRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def delete_queued_resource(self) -> Callable[ + [cloud_tpu.DeleteQueuedResourceRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def generate_service_identity(self) -> Callable[ + [cloud_tpu.GenerateServiceIdentityRequest], + Union[ + cloud_tpu.GenerateServiceIdentityResponse, + Awaitable[cloud_tpu.GenerateServiceIdentityResponse] + ]]: + raise NotImplementedError() + + @property + def list_accelerator_types(self) -> Callable[ + [cloud_tpu.ListAcceleratorTypesRequest], + Union[ + cloud_tpu.ListAcceleratorTypesResponse, + Awaitable[cloud_tpu.ListAcceleratorTypesResponse] + ]]: + raise NotImplementedError() + + @property + def get_accelerator_type(self) -> Callable[ + [cloud_tpu.GetAcceleratorTypeRequest], + Union[ + cloud_tpu.AcceleratorType, + Awaitable[cloud_tpu.AcceleratorType] + ]]: + raise NotImplementedError() + + @property + def list_runtime_versions(self) -> Callable[ + [cloud_tpu.ListRuntimeVersionsRequest], + Union[ + cloud_tpu.ListRuntimeVersionsResponse, + Awaitable[cloud_tpu.ListRuntimeVersionsResponse] + ]]: + raise NotImplementedError() + + @property + def get_runtime_version(self) -> Callable[ + [cloud_tpu.GetRuntimeVersionRequest], + Union[ + cloud_tpu.RuntimeVersion, + Awaitable[cloud_tpu.RuntimeVersion] + ]]: + raise NotImplementedError() + + @property + def get_guest_attributes(self) -> Callable[ + [cloud_tpu.GetGuestAttributesRequest], + Union[ + cloud_tpu.GetGuestAttributesResponse, + Awaitable[cloud_tpu.GetGuestAttributesResponse] + ]]: + raise NotImplementedError() + + @property + def simulate_maintenance_event(self) -> Callable[ + [cloud_tpu.SimulateMaintenanceEventRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def list_operations( + self, + ) -> Callable[ + [operations_pb2.ListOperationsRequest], + Union[operations_pb2.ListOperationsResponse, Awaitable[operations_pb2.ListOperationsResponse]], + ]: + raise NotImplementedError() + + @property + def get_operation( + self, + ) -> Callable[ + [operations_pb2.GetOperationRequest], + Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]], + ]: + raise NotImplementedError() + + @property + def cancel_operation( + self, + ) -> Callable[ + [operations_pb2.CancelOperationRequest], + None, + ]: + raise NotImplementedError() + + @property + def delete_operation( + self, + ) -> Callable[ + [operations_pb2.DeleteOperationRequest], + None, + ]: + raise NotImplementedError() + + @property + def get_location(self, + ) -> Callable[ + [locations_pb2.GetLocationRequest], + Union[locations_pb2.Location, Awaitable[locations_pb2.Location]], + ]: + raise NotImplementedError() + + @property + def list_locations(self, + ) -> Callable[ + [locations_pb2.ListLocationsRequest], + Union[locations_pb2.ListLocationsResponse, Awaitable[locations_pb2.ListLocationsResponse]], + ]: + raise NotImplementedError() + + @property + def kind(self) -> str: + raise NotImplementedError() + + +__all__ = ( + 'TpuTransport', +) diff --git a/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/tpu/transports/grpc.py b/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/tpu/transports/grpc.py new file mode 100644 index 0000000..f0ad67d --- /dev/null +++ b/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/tpu/transports/grpc.py @@ -0,0 +1,838 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import grpc_helpers +from google.api_core import operations_v1 +from google.api_core import gapic_v1 +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore + +from google.cloud.location import locations_pb2 # type: ignore +from google.cloud.tpu_v2alpha1.types import cloud_tpu +from google.longrunning import operations_pb2 +from google.longrunning import operations_pb2 # type: ignore +from .base import TpuTransport, DEFAULT_CLIENT_INFO + + +class TpuGrpcTransport(TpuTransport): + """gRPC backend transport for Tpu. + + Manages TPU nodes and other resources + TPU API v2alpha1 + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + _stubs: Dict[str, Callable] + + def __init__(self, *, + host: str = 'tpu.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[grpc.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + channel (Optional[grpc.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + self._operations_client: Optional[operations_v1.OperationsClient] = None + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @classmethod + def create_channel(cls, + host: str = 'tpu.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> grpc.Channel: + """Create and return a gRPC channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + grpc.Channel: A gRPC channel object. + + Raises: + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service. + """ + return self._grpc_channel + + @property + def operations_client(self) -> operations_v1.OperationsClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Quick check: Only create a new client if we do not already have one. + if self._operations_client is None: + self._operations_client = operations_v1.OperationsClient( + self.grpc_channel + ) + + # Return the client from cache. + return self._operations_client + + @property + def list_nodes(self) -> Callable[ + [cloud_tpu.ListNodesRequest], + cloud_tpu.ListNodesResponse]: + r"""Return a callable for the list nodes method over gRPC. + + Lists nodes. + + Returns: + Callable[[~.ListNodesRequest], + ~.ListNodesResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_nodes' not in self._stubs: + self._stubs['list_nodes'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/ListNodes', + request_serializer=cloud_tpu.ListNodesRequest.serialize, + response_deserializer=cloud_tpu.ListNodesResponse.deserialize, + ) + return self._stubs['list_nodes'] + + @property + def get_node(self) -> Callable[ + [cloud_tpu.GetNodeRequest], + cloud_tpu.Node]: + r"""Return a callable for the get node method over gRPC. + + Gets the details of a node. + + Returns: + Callable[[~.GetNodeRequest], + ~.Node]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_node' not in self._stubs: + self._stubs['get_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/GetNode', + request_serializer=cloud_tpu.GetNodeRequest.serialize, + response_deserializer=cloud_tpu.Node.deserialize, + ) + return self._stubs['get_node'] + + @property + def create_node(self) -> Callable[ + [cloud_tpu.CreateNodeRequest], + operations_pb2.Operation]: + r"""Return a callable for the create node method over gRPC. + + Creates a node. + + Returns: + Callable[[~.CreateNodeRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'create_node' not in self._stubs: + self._stubs['create_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/CreateNode', + request_serializer=cloud_tpu.CreateNodeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['create_node'] + + @property + def delete_node(self) -> Callable[ + [cloud_tpu.DeleteNodeRequest], + operations_pb2.Operation]: + r"""Return a callable for the delete node method over gRPC. + + Deletes a node. + + Returns: + Callable[[~.DeleteNodeRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_node' not in self._stubs: + self._stubs['delete_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/DeleteNode', + request_serializer=cloud_tpu.DeleteNodeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['delete_node'] + + @property + def stop_node(self) -> Callable[ + [cloud_tpu.StopNodeRequest], + operations_pb2.Operation]: + r"""Return a callable for the stop node method over gRPC. + + Stops a node. This operation is only available with + single TPU nodes. + + Returns: + Callable[[~.StopNodeRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'stop_node' not in self._stubs: + self._stubs['stop_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/StopNode', + request_serializer=cloud_tpu.StopNodeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['stop_node'] + + @property + def start_node(self) -> Callable[ + [cloud_tpu.StartNodeRequest], + operations_pb2.Operation]: + r"""Return a callable for the start node method over gRPC. + + Starts a node. + + Returns: + Callable[[~.StartNodeRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'start_node' not in self._stubs: + self._stubs['start_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/StartNode', + request_serializer=cloud_tpu.StartNodeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['start_node'] + + @property + def update_node(self) -> Callable[ + [cloud_tpu.UpdateNodeRequest], + operations_pb2.Operation]: + r"""Return a callable for the update node method over gRPC. + + Updates the configurations of a node. + + Returns: + Callable[[~.UpdateNodeRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'update_node' not in self._stubs: + self._stubs['update_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/UpdateNode', + request_serializer=cloud_tpu.UpdateNodeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['update_node'] + + @property + def list_queued_resources(self) -> Callable[ + [cloud_tpu.ListQueuedResourcesRequest], + cloud_tpu.ListQueuedResourcesResponse]: + r"""Return a callable for the list queued resources method over gRPC. + + Lists queued resources. + + Returns: + Callable[[~.ListQueuedResourcesRequest], + ~.ListQueuedResourcesResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_queued_resources' not in self._stubs: + self._stubs['list_queued_resources'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/ListQueuedResources', + request_serializer=cloud_tpu.ListQueuedResourcesRequest.serialize, + response_deserializer=cloud_tpu.ListQueuedResourcesResponse.deserialize, + ) + return self._stubs['list_queued_resources'] + + @property + def get_queued_resource(self) -> Callable[ + [cloud_tpu.GetQueuedResourceRequest], + cloud_tpu.QueuedResource]: + r"""Return a callable for the get queued resource method over gRPC. + + Gets details of a queued resource. + + Returns: + Callable[[~.GetQueuedResourceRequest], + ~.QueuedResource]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_queued_resource' not in self._stubs: + self._stubs['get_queued_resource'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/GetQueuedResource', + request_serializer=cloud_tpu.GetQueuedResourceRequest.serialize, + response_deserializer=cloud_tpu.QueuedResource.deserialize, + ) + return self._stubs['get_queued_resource'] + + @property + def create_queued_resource(self) -> Callable[ + [cloud_tpu.CreateQueuedResourceRequest], + operations_pb2.Operation]: + r"""Return a callable for the create queued resource method over gRPC. + + Creates a QueuedResource TPU instance. + + Returns: + Callable[[~.CreateQueuedResourceRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'create_queued_resource' not in self._stubs: + self._stubs['create_queued_resource'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/CreateQueuedResource', + request_serializer=cloud_tpu.CreateQueuedResourceRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['create_queued_resource'] + + @property + def delete_queued_resource(self) -> Callable[ + [cloud_tpu.DeleteQueuedResourceRequest], + operations_pb2.Operation]: + r"""Return a callable for the delete queued resource method over gRPC. + + Deletes a QueuedResource TPU instance. + + Returns: + Callable[[~.DeleteQueuedResourceRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_queued_resource' not in self._stubs: + self._stubs['delete_queued_resource'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/DeleteQueuedResource', + request_serializer=cloud_tpu.DeleteQueuedResourceRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['delete_queued_resource'] + + @property + def generate_service_identity(self) -> Callable[ + [cloud_tpu.GenerateServiceIdentityRequest], + cloud_tpu.GenerateServiceIdentityResponse]: + r"""Return a callable for the generate service identity method over gRPC. + + Generates the Cloud TPU service identity for the + project. + + Returns: + Callable[[~.GenerateServiceIdentityRequest], + ~.GenerateServiceIdentityResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'generate_service_identity' not in self._stubs: + self._stubs['generate_service_identity'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/GenerateServiceIdentity', + request_serializer=cloud_tpu.GenerateServiceIdentityRequest.serialize, + response_deserializer=cloud_tpu.GenerateServiceIdentityResponse.deserialize, + ) + return self._stubs['generate_service_identity'] + + @property + def list_accelerator_types(self) -> Callable[ + [cloud_tpu.ListAcceleratorTypesRequest], + cloud_tpu.ListAcceleratorTypesResponse]: + r"""Return a callable for the list accelerator types method over gRPC. + + Lists accelerator types supported by this API. + + Returns: + Callable[[~.ListAcceleratorTypesRequest], + ~.ListAcceleratorTypesResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_accelerator_types' not in self._stubs: + self._stubs['list_accelerator_types'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/ListAcceleratorTypes', + request_serializer=cloud_tpu.ListAcceleratorTypesRequest.serialize, + response_deserializer=cloud_tpu.ListAcceleratorTypesResponse.deserialize, + ) + return self._stubs['list_accelerator_types'] + + @property + def get_accelerator_type(self) -> Callable[ + [cloud_tpu.GetAcceleratorTypeRequest], + cloud_tpu.AcceleratorType]: + r"""Return a callable for the get accelerator type method over gRPC. + + Gets AcceleratorType. + + Returns: + Callable[[~.GetAcceleratorTypeRequest], + ~.AcceleratorType]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_accelerator_type' not in self._stubs: + self._stubs['get_accelerator_type'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/GetAcceleratorType', + request_serializer=cloud_tpu.GetAcceleratorTypeRequest.serialize, + response_deserializer=cloud_tpu.AcceleratorType.deserialize, + ) + return self._stubs['get_accelerator_type'] + + @property + def list_runtime_versions(self) -> Callable[ + [cloud_tpu.ListRuntimeVersionsRequest], + cloud_tpu.ListRuntimeVersionsResponse]: + r"""Return a callable for the list runtime versions method over gRPC. + + Lists runtime versions supported by this API. + + Returns: + Callable[[~.ListRuntimeVersionsRequest], + ~.ListRuntimeVersionsResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_runtime_versions' not in self._stubs: + self._stubs['list_runtime_versions'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/ListRuntimeVersions', + request_serializer=cloud_tpu.ListRuntimeVersionsRequest.serialize, + response_deserializer=cloud_tpu.ListRuntimeVersionsResponse.deserialize, + ) + return self._stubs['list_runtime_versions'] + + @property + def get_runtime_version(self) -> Callable[ + [cloud_tpu.GetRuntimeVersionRequest], + cloud_tpu.RuntimeVersion]: + r"""Return a callable for the get runtime version method over gRPC. + + Gets a runtime version. + + Returns: + Callable[[~.GetRuntimeVersionRequest], + ~.RuntimeVersion]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_runtime_version' not in self._stubs: + self._stubs['get_runtime_version'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/GetRuntimeVersion', + request_serializer=cloud_tpu.GetRuntimeVersionRequest.serialize, + response_deserializer=cloud_tpu.RuntimeVersion.deserialize, + ) + return self._stubs['get_runtime_version'] + + @property + def get_guest_attributes(self) -> Callable[ + [cloud_tpu.GetGuestAttributesRequest], + cloud_tpu.GetGuestAttributesResponse]: + r"""Return a callable for the get guest attributes method over gRPC. + + Retrieves the guest attributes for the node. + + Returns: + Callable[[~.GetGuestAttributesRequest], + ~.GetGuestAttributesResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_guest_attributes' not in self._stubs: + self._stubs['get_guest_attributes'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/GetGuestAttributes', + request_serializer=cloud_tpu.GetGuestAttributesRequest.serialize, + response_deserializer=cloud_tpu.GetGuestAttributesResponse.deserialize, + ) + return self._stubs['get_guest_attributes'] + + @property + def simulate_maintenance_event(self) -> Callable[ + [cloud_tpu.SimulateMaintenanceEventRequest], + operations_pb2.Operation]: + r"""Return a callable for the simulate maintenance event method over gRPC. + + Simulates a maintenance event. + + Returns: + Callable[[~.SimulateMaintenanceEventRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'simulate_maintenance_event' not in self._stubs: + self._stubs['simulate_maintenance_event'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/SimulateMaintenanceEvent', + request_serializer=cloud_tpu.SimulateMaintenanceEventRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['simulate_maintenance_event'] + + def close(self): + self.grpc_channel.close() + + @property + def delete_operation( + self, + ) -> Callable[[operations_pb2.DeleteOperationRequest], None]: + r"""Return a callable for the delete_operation method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "delete_operation" not in self._stubs: + self._stubs["delete_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/DeleteOperation", + request_serializer=operations_pb2.DeleteOperationRequest.SerializeToString, + response_deserializer=None, + ) + return self._stubs["delete_operation"] + + @property + def cancel_operation( + self, + ) -> Callable[[operations_pb2.CancelOperationRequest], None]: + r"""Return a callable for the cancel_operation method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "cancel_operation" not in self._stubs: + self._stubs["cancel_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/CancelOperation", + request_serializer=operations_pb2.CancelOperationRequest.SerializeToString, + response_deserializer=None, + ) + return self._stubs["cancel_operation"] + + @property + def get_operation( + self, + ) -> Callable[[operations_pb2.GetOperationRequest], operations_pb2.Operation]: + r"""Return a callable for the get_operation method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_operation" not in self._stubs: + self._stubs["get_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/GetOperation", + request_serializer=operations_pb2.GetOperationRequest.SerializeToString, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["get_operation"] + + @property + def list_operations( + self, + ) -> Callable[[operations_pb2.ListOperationsRequest], operations_pb2.ListOperationsResponse]: + r"""Return a callable for the list_operations method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_operations" not in self._stubs: + self._stubs["list_operations"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/ListOperations", + request_serializer=operations_pb2.ListOperationsRequest.SerializeToString, + response_deserializer=operations_pb2.ListOperationsResponse.FromString, + ) + return self._stubs["list_operations"] + + @property + def list_locations( + self, + ) -> Callable[[locations_pb2.ListLocationsRequest], locations_pb2.ListLocationsResponse]: + r"""Return a callable for the list locations method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_locations" not in self._stubs: + self._stubs["list_locations"] = self.grpc_channel.unary_unary( + "/google.cloud.location.Locations/ListLocations", + request_serializer=locations_pb2.ListLocationsRequest.SerializeToString, + response_deserializer=locations_pb2.ListLocationsResponse.FromString, + ) + return self._stubs["list_locations"] + + @property + def get_location( + self, + ) -> Callable[[locations_pb2.GetLocationRequest], locations_pb2.Location]: + r"""Return a callable for the list locations method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_location" not in self._stubs: + self._stubs["get_location"] = self.grpc_channel.unary_unary( + "/google.cloud.location.Locations/GetLocation", + request_serializer=locations_pb2.GetLocationRequest.SerializeToString, + response_deserializer=locations_pb2.Location.FromString, + ) + return self._stubs["get_location"] + + @property + def kind(self) -> str: + return "grpc" + + +__all__ = ( + 'TpuGrpcTransport', +) diff --git a/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/tpu/transports/grpc_asyncio.py b/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/tpu/transports/grpc_asyncio.py new file mode 100644 index 0000000..c86251a --- /dev/null +++ b/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/services/tpu/transports/grpc_asyncio.py @@ -0,0 +1,837 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers_async +from google.api_core import operations_v1 +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore +from grpc.experimental import aio # type: ignore + +from google.cloud.location import locations_pb2 # type: ignore +from google.cloud.tpu_v2alpha1.types import cloud_tpu +from google.longrunning import operations_pb2 +from google.longrunning import operations_pb2 # type: ignore +from .base import TpuTransport, DEFAULT_CLIENT_INFO +from .grpc import TpuGrpcTransport + + +class TpuGrpcAsyncIOTransport(TpuTransport): + """gRPC AsyncIO backend transport for Tpu. + + Manages TPU nodes and other resources + TPU API v2alpha1 + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + + _grpc_channel: aio.Channel + _stubs: Dict[str, Callable] = {} + + @classmethod + def create_channel(cls, + host: str = 'tpu.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> aio.Channel: + """Create and return a gRPC AsyncIO channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + aio.Channel: A gRPC AsyncIO channel object. + """ + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + def __init__(self, *, + host: str = 'tpu.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[aio.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + channel (Optional[aio.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + self._operations_client: Optional[operations_v1.OperationsAsyncClient] = None + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @property + def grpc_channel(self) -> aio.Channel: + """Create the channel designed to connect to this service. + + This property caches on the instance; repeated calls return + the same channel. + """ + # Return the channel from cache. + return self._grpc_channel + + @property + def operations_client(self) -> operations_v1.OperationsAsyncClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Quick check: Only create a new client if we do not already have one. + if self._operations_client is None: + self._operations_client = operations_v1.OperationsAsyncClient( + self.grpc_channel + ) + + # Return the client from cache. + return self._operations_client + + @property + def list_nodes(self) -> Callable[ + [cloud_tpu.ListNodesRequest], + Awaitable[cloud_tpu.ListNodesResponse]]: + r"""Return a callable for the list nodes method over gRPC. + + Lists nodes. + + Returns: + Callable[[~.ListNodesRequest], + Awaitable[~.ListNodesResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_nodes' not in self._stubs: + self._stubs['list_nodes'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/ListNodes', + request_serializer=cloud_tpu.ListNodesRequest.serialize, + response_deserializer=cloud_tpu.ListNodesResponse.deserialize, + ) + return self._stubs['list_nodes'] + + @property + def get_node(self) -> Callable[ + [cloud_tpu.GetNodeRequest], + Awaitable[cloud_tpu.Node]]: + r"""Return a callable for the get node method over gRPC. + + Gets the details of a node. + + Returns: + Callable[[~.GetNodeRequest], + Awaitable[~.Node]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_node' not in self._stubs: + self._stubs['get_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/GetNode', + request_serializer=cloud_tpu.GetNodeRequest.serialize, + response_deserializer=cloud_tpu.Node.deserialize, + ) + return self._stubs['get_node'] + + @property + def create_node(self) -> Callable[ + [cloud_tpu.CreateNodeRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the create node method over gRPC. + + Creates a node. + + Returns: + Callable[[~.CreateNodeRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'create_node' not in self._stubs: + self._stubs['create_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/CreateNode', + request_serializer=cloud_tpu.CreateNodeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['create_node'] + + @property + def delete_node(self) -> Callable[ + [cloud_tpu.DeleteNodeRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the delete node method over gRPC. + + Deletes a node. + + Returns: + Callable[[~.DeleteNodeRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_node' not in self._stubs: + self._stubs['delete_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/DeleteNode', + request_serializer=cloud_tpu.DeleteNodeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['delete_node'] + + @property + def stop_node(self) -> Callable[ + [cloud_tpu.StopNodeRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the stop node method over gRPC. + + Stops a node. This operation is only available with + single TPU nodes. + + Returns: + Callable[[~.StopNodeRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'stop_node' not in self._stubs: + self._stubs['stop_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/StopNode', + request_serializer=cloud_tpu.StopNodeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['stop_node'] + + @property + def start_node(self) -> Callable[ + [cloud_tpu.StartNodeRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the start node method over gRPC. + + Starts a node. + + Returns: + Callable[[~.StartNodeRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'start_node' not in self._stubs: + self._stubs['start_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/StartNode', + request_serializer=cloud_tpu.StartNodeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['start_node'] + + @property + def update_node(self) -> Callable[ + [cloud_tpu.UpdateNodeRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the update node method over gRPC. + + Updates the configurations of a node. + + Returns: + Callable[[~.UpdateNodeRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'update_node' not in self._stubs: + self._stubs['update_node'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/UpdateNode', + request_serializer=cloud_tpu.UpdateNodeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['update_node'] + + @property + def list_queued_resources(self) -> Callable[ + [cloud_tpu.ListQueuedResourcesRequest], + Awaitable[cloud_tpu.ListQueuedResourcesResponse]]: + r"""Return a callable for the list queued resources method over gRPC. + + Lists queued resources. + + Returns: + Callable[[~.ListQueuedResourcesRequest], + Awaitable[~.ListQueuedResourcesResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_queued_resources' not in self._stubs: + self._stubs['list_queued_resources'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/ListQueuedResources', + request_serializer=cloud_tpu.ListQueuedResourcesRequest.serialize, + response_deserializer=cloud_tpu.ListQueuedResourcesResponse.deserialize, + ) + return self._stubs['list_queued_resources'] + + @property + def get_queued_resource(self) -> Callable[ + [cloud_tpu.GetQueuedResourceRequest], + Awaitable[cloud_tpu.QueuedResource]]: + r"""Return a callable for the get queued resource method over gRPC. + + Gets details of a queued resource. + + Returns: + Callable[[~.GetQueuedResourceRequest], + Awaitable[~.QueuedResource]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_queued_resource' not in self._stubs: + self._stubs['get_queued_resource'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/GetQueuedResource', + request_serializer=cloud_tpu.GetQueuedResourceRequest.serialize, + response_deserializer=cloud_tpu.QueuedResource.deserialize, + ) + return self._stubs['get_queued_resource'] + + @property + def create_queued_resource(self) -> Callable[ + [cloud_tpu.CreateQueuedResourceRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the create queued resource method over gRPC. + + Creates a QueuedResource TPU instance. + + Returns: + Callable[[~.CreateQueuedResourceRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'create_queued_resource' not in self._stubs: + self._stubs['create_queued_resource'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/CreateQueuedResource', + request_serializer=cloud_tpu.CreateQueuedResourceRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['create_queued_resource'] + + @property + def delete_queued_resource(self) -> Callable[ + [cloud_tpu.DeleteQueuedResourceRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the delete queued resource method over gRPC. + + Deletes a QueuedResource TPU instance. + + Returns: + Callable[[~.DeleteQueuedResourceRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_queued_resource' not in self._stubs: + self._stubs['delete_queued_resource'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/DeleteQueuedResource', + request_serializer=cloud_tpu.DeleteQueuedResourceRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['delete_queued_resource'] + + @property + def generate_service_identity(self) -> Callable[ + [cloud_tpu.GenerateServiceIdentityRequest], + Awaitable[cloud_tpu.GenerateServiceIdentityResponse]]: + r"""Return a callable for the generate service identity method over gRPC. + + Generates the Cloud TPU service identity for the + project. + + Returns: + Callable[[~.GenerateServiceIdentityRequest], + Awaitable[~.GenerateServiceIdentityResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'generate_service_identity' not in self._stubs: + self._stubs['generate_service_identity'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/GenerateServiceIdentity', + request_serializer=cloud_tpu.GenerateServiceIdentityRequest.serialize, + response_deserializer=cloud_tpu.GenerateServiceIdentityResponse.deserialize, + ) + return self._stubs['generate_service_identity'] + + @property + def list_accelerator_types(self) -> Callable[ + [cloud_tpu.ListAcceleratorTypesRequest], + Awaitable[cloud_tpu.ListAcceleratorTypesResponse]]: + r"""Return a callable for the list accelerator types method over gRPC. + + Lists accelerator types supported by this API. + + Returns: + Callable[[~.ListAcceleratorTypesRequest], + Awaitable[~.ListAcceleratorTypesResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_accelerator_types' not in self._stubs: + self._stubs['list_accelerator_types'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/ListAcceleratorTypes', + request_serializer=cloud_tpu.ListAcceleratorTypesRequest.serialize, + response_deserializer=cloud_tpu.ListAcceleratorTypesResponse.deserialize, + ) + return self._stubs['list_accelerator_types'] + + @property + def get_accelerator_type(self) -> Callable[ + [cloud_tpu.GetAcceleratorTypeRequest], + Awaitable[cloud_tpu.AcceleratorType]]: + r"""Return a callable for the get accelerator type method over gRPC. + + Gets AcceleratorType. + + Returns: + Callable[[~.GetAcceleratorTypeRequest], + Awaitable[~.AcceleratorType]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_accelerator_type' not in self._stubs: + self._stubs['get_accelerator_type'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/GetAcceleratorType', + request_serializer=cloud_tpu.GetAcceleratorTypeRequest.serialize, + response_deserializer=cloud_tpu.AcceleratorType.deserialize, + ) + return self._stubs['get_accelerator_type'] + + @property + def list_runtime_versions(self) -> Callable[ + [cloud_tpu.ListRuntimeVersionsRequest], + Awaitable[cloud_tpu.ListRuntimeVersionsResponse]]: + r"""Return a callable for the list runtime versions method over gRPC. + + Lists runtime versions supported by this API. + + Returns: + Callable[[~.ListRuntimeVersionsRequest], + Awaitable[~.ListRuntimeVersionsResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_runtime_versions' not in self._stubs: + self._stubs['list_runtime_versions'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/ListRuntimeVersions', + request_serializer=cloud_tpu.ListRuntimeVersionsRequest.serialize, + response_deserializer=cloud_tpu.ListRuntimeVersionsResponse.deserialize, + ) + return self._stubs['list_runtime_versions'] + + @property + def get_runtime_version(self) -> Callable[ + [cloud_tpu.GetRuntimeVersionRequest], + Awaitable[cloud_tpu.RuntimeVersion]]: + r"""Return a callable for the get runtime version method over gRPC. + + Gets a runtime version. + + Returns: + Callable[[~.GetRuntimeVersionRequest], + Awaitable[~.RuntimeVersion]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_runtime_version' not in self._stubs: + self._stubs['get_runtime_version'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/GetRuntimeVersion', + request_serializer=cloud_tpu.GetRuntimeVersionRequest.serialize, + response_deserializer=cloud_tpu.RuntimeVersion.deserialize, + ) + return self._stubs['get_runtime_version'] + + @property + def get_guest_attributes(self) -> Callable[ + [cloud_tpu.GetGuestAttributesRequest], + Awaitable[cloud_tpu.GetGuestAttributesResponse]]: + r"""Return a callable for the get guest attributes method over gRPC. + + Retrieves the guest attributes for the node. + + Returns: + Callable[[~.GetGuestAttributesRequest], + Awaitable[~.GetGuestAttributesResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_guest_attributes' not in self._stubs: + self._stubs['get_guest_attributes'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/GetGuestAttributes', + request_serializer=cloud_tpu.GetGuestAttributesRequest.serialize, + response_deserializer=cloud_tpu.GetGuestAttributesResponse.deserialize, + ) + return self._stubs['get_guest_attributes'] + + @property + def simulate_maintenance_event(self) -> Callable[ + [cloud_tpu.SimulateMaintenanceEventRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the simulate maintenance event method over gRPC. + + Simulates a maintenance event. + + Returns: + Callable[[~.SimulateMaintenanceEventRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'simulate_maintenance_event' not in self._stubs: + self._stubs['simulate_maintenance_event'] = self.grpc_channel.unary_unary( + '/google.cloud.tpu.v2alpha1.Tpu/SimulateMaintenanceEvent', + request_serializer=cloud_tpu.SimulateMaintenanceEventRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['simulate_maintenance_event'] + + def close(self): + return self.grpc_channel.close() + + @property + def delete_operation( + self, + ) -> Callable[[operations_pb2.DeleteOperationRequest], None]: + r"""Return a callable for the delete_operation method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "delete_operation" not in self._stubs: + self._stubs["delete_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/DeleteOperation", + request_serializer=operations_pb2.DeleteOperationRequest.SerializeToString, + response_deserializer=None, + ) + return self._stubs["delete_operation"] + + @property + def cancel_operation( + self, + ) -> Callable[[operations_pb2.CancelOperationRequest], None]: + r"""Return a callable for the cancel_operation method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "cancel_operation" not in self._stubs: + self._stubs["cancel_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/CancelOperation", + request_serializer=operations_pb2.CancelOperationRequest.SerializeToString, + response_deserializer=None, + ) + return self._stubs["cancel_operation"] + + @property + def get_operation( + self, + ) -> Callable[[operations_pb2.GetOperationRequest], operations_pb2.Operation]: + r"""Return a callable for the get_operation method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_operation" not in self._stubs: + self._stubs["get_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/GetOperation", + request_serializer=operations_pb2.GetOperationRequest.SerializeToString, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["get_operation"] + + @property + def list_operations( + self, + ) -> Callable[[operations_pb2.ListOperationsRequest], operations_pb2.ListOperationsResponse]: + r"""Return a callable for the list_operations method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_operations" not in self._stubs: + self._stubs["list_operations"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/ListOperations", + request_serializer=operations_pb2.ListOperationsRequest.SerializeToString, + response_deserializer=operations_pb2.ListOperationsResponse.FromString, + ) + return self._stubs["list_operations"] + + @property + def list_locations( + self, + ) -> Callable[[locations_pb2.ListLocationsRequest], locations_pb2.ListLocationsResponse]: + r"""Return a callable for the list locations method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_locations" not in self._stubs: + self._stubs["list_locations"] = self.grpc_channel.unary_unary( + "/google.cloud.location.Locations/ListLocations", + request_serializer=locations_pb2.ListLocationsRequest.SerializeToString, + response_deserializer=locations_pb2.ListLocationsResponse.FromString, + ) + return self._stubs["list_locations"] + + @property + def get_location( + self, + ) -> Callable[[locations_pb2.GetLocationRequest], locations_pb2.Location]: + r"""Return a callable for the list locations method over gRPC. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_location" not in self._stubs: + self._stubs["get_location"] = self.grpc_channel.unary_unary( + "/google.cloud.location.Locations/GetLocation", + request_serializer=locations_pb2.GetLocationRequest.SerializeToString, + response_deserializer=locations_pb2.Location.FromString, + ) + return self._stubs["get_location"] + + +__all__ = ( + 'TpuGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/types/__init__.py b/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/types/__init__.py new file mode 100644 index 0000000..ee95c47 --- /dev/null +++ b/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/types/__init__.py @@ -0,0 +1,106 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .cloud_tpu import ( + AcceleratorConfig, + AcceleratorType, + AccessConfig, + AttachedDisk, + CreateNodeRequest, + CreateQueuedResourceRequest, + DeleteNodeRequest, + DeleteQueuedResourceRequest, + GenerateServiceIdentityRequest, + GenerateServiceIdentityResponse, + GetAcceleratorTypeRequest, + GetGuestAttributesRequest, + GetGuestAttributesResponse, + GetNodeRequest, + GetQueuedResourceRequest, + GetRuntimeVersionRequest, + GuestAttributes, + GuestAttributesEntry, + GuestAttributesValue, + ListAcceleratorTypesRequest, + ListAcceleratorTypesResponse, + ListNodesRequest, + ListNodesResponse, + ListQueuedResourcesRequest, + ListQueuedResourcesResponse, + ListRuntimeVersionsRequest, + ListRuntimeVersionsResponse, + NetworkConfig, + NetworkEndpoint, + Node, + OperationMetadata, + QueuedResource, + QueuedResourceState, + RuntimeVersion, + SchedulingConfig, + ServiceAccount, + ServiceIdentity, + ShieldedInstanceConfig, + SimulateMaintenanceEventRequest, + StartNodeRequest, + StopNodeRequest, + Symptom, + UpdateNodeRequest, +) + +__all__ = ( + 'AcceleratorConfig', + 'AcceleratorType', + 'AccessConfig', + 'AttachedDisk', + 'CreateNodeRequest', + 'CreateQueuedResourceRequest', + 'DeleteNodeRequest', + 'DeleteQueuedResourceRequest', + 'GenerateServiceIdentityRequest', + 'GenerateServiceIdentityResponse', + 'GetAcceleratorTypeRequest', + 'GetGuestAttributesRequest', + 'GetGuestAttributesResponse', + 'GetNodeRequest', + 'GetQueuedResourceRequest', + 'GetRuntimeVersionRequest', + 'GuestAttributes', + 'GuestAttributesEntry', + 'GuestAttributesValue', + 'ListAcceleratorTypesRequest', + 'ListAcceleratorTypesResponse', + 'ListNodesRequest', + 'ListNodesResponse', + 'ListQueuedResourcesRequest', + 'ListQueuedResourcesResponse', + 'ListRuntimeVersionsRequest', + 'ListRuntimeVersionsResponse', + 'NetworkConfig', + 'NetworkEndpoint', + 'Node', + 'OperationMetadata', + 'QueuedResource', + 'QueuedResourceState', + 'RuntimeVersion', + 'SchedulingConfig', + 'ServiceAccount', + 'ServiceIdentity', + 'ShieldedInstanceConfig', + 'SimulateMaintenanceEventRequest', + 'StartNodeRequest', + 'StopNodeRequest', + 'Symptom', + 'UpdateNodeRequest', +) diff --git a/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/types/cloud_tpu.py b/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/types/cloud_tpu.py new file mode 100644 index 0000000..c5ce097 --- /dev/null +++ b/owl-bot-staging/v2alpha1/google/cloud/tpu_v2alpha1/types/cloud_tpu.py @@ -0,0 +1,1868 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from __future__ import annotations + +from typing import MutableMapping, MutableSequence + +import proto # type: ignore + +from google.protobuf import duration_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from google.rpc import status_pb2 # type: ignore +from google.type import interval_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.tpu.v2alpha1', + manifest={ + 'GuestAttributes', + 'GuestAttributesValue', + 'GuestAttributesEntry', + 'AttachedDisk', + 'SchedulingConfig', + 'NetworkEndpoint', + 'AccessConfig', + 'NetworkConfig', + 'ServiceAccount', + 'Node', + 'QueuedResource', + 'QueuedResourceState', + 'ListNodesRequest', + 'ListNodesResponse', + 'GetNodeRequest', + 'CreateNodeRequest', + 'DeleteNodeRequest', + 'StopNodeRequest', + 'StartNodeRequest', + 'UpdateNodeRequest', + 'ListQueuedResourcesRequest', + 'ListQueuedResourcesResponse', + 'GetQueuedResourceRequest', + 'CreateQueuedResourceRequest', + 'DeleteQueuedResourceRequest', + 'ServiceIdentity', + 'GenerateServiceIdentityRequest', + 'GenerateServiceIdentityResponse', + 'AcceleratorType', + 'GetAcceleratorTypeRequest', + 'ListAcceleratorTypesRequest', + 'ListAcceleratorTypesResponse', + 'RuntimeVersion', + 'GetRuntimeVersionRequest', + 'ListRuntimeVersionsRequest', + 'ListRuntimeVersionsResponse', + 'OperationMetadata', + 'Symptom', + 'GetGuestAttributesRequest', + 'GetGuestAttributesResponse', + 'SimulateMaintenanceEventRequest', + 'AcceleratorConfig', + 'ShieldedInstanceConfig', + }, +) + + +class GuestAttributes(proto.Message): + r"""A guest attributes. + + Attributes: + query_path (str): + The path to be queried. This can be the + default namespace ('/') or a nested namespace + ('/\/') or a specified key + ('/\/\') + query_value (google.cloud.tpu_v2alpha1.types.GuestAttributesValue): + The value of the requested queried path. + """ + + query_path: str = proto.Field( + proto.STRING, + number=1, + ) + query_value: 'GuestAttributesValue' = proto.Field( + proto.MESSAGE, + number=2, + message='GuestAttributesValue', + ) + + +class GuestAttributesValue(proto.Message): + r"""Array of guest attribute namespace/key/value tuples. + + Attributes: + items (MutableSequence[google.cloud.tpu_v2alpha1.types.GuestAttributesEntry]): + The list of guest attributes entries. + """ + + items: MutableSequence['GuestAttributesEntry'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='GuestAttributesEntry', + ) + + +class GuestAttributesEntry(proto.Message): + r"""A guest attributes namespace/key/value entry. + + Attributes: + namespace (str): + Namespace for the guest attribute entry. + key (str): + Key for the guest attribute entry. + value (str): + Value for the guest attribute entry. + """ + + namespace: str = proto.Field( + proto.STRING, + number=1, + ) + key: str = proto.Field( + proto.STRING, + number=2, + ) + value: str = proto.Field( + proto.STRING, + number=3, + ) + + +class AttachedDisk(proto.Message): + r"""A node-attached disk resource. + Next ID: 8; + + Attributes: + source_disk (str): + Specifies the full path to an existing disk. + For example: + "projects/my-project/zones/us-central1-c/disks/my-disk". + mode (google.cloud.tpu_v2alpha1.types.AttachedDisk.DiskMode): + The mode in which to attach this disk. If not specified, the + default is READ_WRITE mode. Only applicable to data_disks. + """ + class DiskMode(proto.Enum): + r"""The different mode of the attached disk. + + Values: + DISK_MODE_UNSPECIFIED (0): + The disk mode is not known/set. + READ_WRITE (1): + Attaches the disk in read-write mode. Only + one TPU node can attach a disk in read-write + mode at a time. + READ_ONLY (2): + Attaches the disk in read-only mode. Multiple + TPU nodes can attach a disk in read-only mode at + a time. + """ + DISK_MODE_UNSPECIFIED = 0 + READ_WRITE = 1 + READ_ONLY = 2 + + source_disk: str = proto.Field( + proto.STRING, + number=3, + ) + mode: DiskMode = proto.Field( + proto.ENUM, + number=4, + enum=DiskMode, + ) + + +class SchedulingConfig(proto.Message): + r"""Sets the scheduling options for this node. + + Attributes: + preemptible (bool): + Defines whether the node is preemptible. + reserved (bool): + Whether the node is created under a + reservation. + """ + + preemptible: bool = proto.Field( + proto.BOOL, + number=1, + ) + reserved: bool = proto.Field( + proto.BOOL, + number=2, + ) + + +class NetworkEndpoint(proto.Message): + r"""A network endpoint over which a TPU worker can be reached. + + Attributes: + ip_address (str): + The internal IP address of this network + endpoint. + port (int): + The port of this network endpoint. + access_config (google.cloud.tpu_v2alpha1.types.AccessConfig): + The access config for the TPU worker. + """ + + ip_address: str = proto.Field( + proto.STRING, + number=1, + ) + port: int = proto.Field( + proto.INT32, + number=2, + ) + access_config: 'AccessConfig' = proto.Field( + proto.MESSAGE, + number=5, + message='AccessConfig', + ) + + +class AccessConfig(proto.Message): + r"""An access config attached to the TPU worker. + + Attributes: + external_ip (str): + Output only. An external IP address + associated with the TPU worker. + """ + + external_ip: str = proto.Field( + proto.STRING, + number=1, + ) + + +class NetworkConfig(proto.Message): + r"""Network related configurations. + + Attributes: + network (str): + The name of the network for the TPU node. It + must be a preexisting Google Compute Engine + network. If none is provided, "default" will be + used. + subnetwork (str): + The name of the subnetwork for the TPU node. + It must be a preexisting Google Compute Engine + subnetwork. If none is provided, "default" will + be used. + enable_external_ips (bool): + Indicates that external IP addresses would be + associated with the TPU workers. If set to + false, the specified subnetwork or network + should have Private Google Access enabled. + can_ip_forward (bool): + Allows the TPU node to send and receive + packets with non-matching destination or source + IPs. This is required if you plan to use the TPU + workers to forward routes. + """ + + network: str = proto.Field( + proto.STRING, + number=1, + ) + subnetwork: str = proto.Field( + proto.STRING, + number=2, + ) + enable_external_ips: bool = proto.Field( + proto.BOOL, + number=3, + ) + can_ip_forward: bool = proto.Field( + proto.BOOL, + number=4, + ) + + +class ServiceAccount(proto.Message): + r"""A service account. + + Attributes: + email (str): + Email address of the service account. If + empty, default Compute service account will be + used. + scope (MutableSequence[str]): + The list of scopes to be made available for + this service account. If empty, access to all + Cloud APIs will be allowed. + """ + + email: str = proto.Field( + proto.STRING, + number=1, + ) + scope: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=2, + ) + + +class Node(proto.Message): + r"""A TPU instance. + + Attributes: + name (str): + Output only. Immutable. The name of the TPU. + description (str): + The user-supplied description of the TPU. + Maximum of 512 characters. + accelerator_type (str): + The type of hardware accelerators associated + with this node. + state (google.cloud.tpu_v2alpha1.types.Node.State): + Output only. The current state for the TPU + Node. + health_description (str): + Output only. If this field is populated, it + contains a description of why the TPU Node is + unhealthy. + runtime_version (str): + Required. The runtime version running in the + Node. + network_config (google.cloud.tpu_v2alpha1.types.NetworkConfig): + Network configurations for the TPU node. + cidr_block (str): + The CIDR block that the TPU node will use + when selecting an IP address. This CIDR block + must be a /29 block; the Compute Engine networks + API forbids a smaller block, and using a larger + block would be wasteful (a node can only consume + one IP address). Errors will occur if the CIDR + block has already been used for a currently + existing TPU node, the CIDR block conflicts with + any subnetworks in the user's provided network, + or the provided network is peered with another + network that is using that CIDR block. + service_account (google.cloud.tpu_v2alpha1.types.ServiceAccount): + The Google Cloud Platform Service Account to + be used by the TPU node VMs. If None is + specified, the default compute service account + will be used. + create_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time when the node was + created. + scheduling_config (google.cloud.tpu_v2alpha1.types.SchedulingConfig): + The scheduling options for this node. + network_endpoints (MutableSequence[google.cloud.tpu_v2alpha1.types.NetworkEndpoint]): + Output only. The network endpoints where TPU + workers can be accessed and sent work. It is + recommended that runtime clients of the node + reach out to the 0th entry in this map first. + health (google.cloud.tpu_v2alpha1.types.Node.Health): + The health status of the TPU node. + labels (MutableMapping[str, str]): + Resource labels to represent user-provided + metadata. + metadata (MutableMapping[str, str]): + Custom metadata to apply to the TPU Node. + Can set startup-script and shutdown-script + tags (MutableSequence[str]): + Tags to apply to the TPU Node. Tags are used + to identify valid sources or targets for network + firewalls. + id (int): + Output only. The unique identifier for the + TPU Node. + data_disks (MutableSequence[google.cloud.tpu_v2alpha1.types.AttachedDisk]): + The additional data disks for the Node. + api_version (google.cloud.tpu_v2alpha1.types.Node.ApiVersion): + Output only. The API version that created + this Node. + symptoms (MutableSequence[google.cloud.tpu_v2alpha1.types.Symptom]): + Output only. The Symptoms that have occurred + to the TPU Node. + queued_resource (str): + Output only. The qualified name of the + QueuedResource that requested this Node. + accelerator_config (google.cloud.tpu_v2alpha1.types.AcceleratorConfig): + The AccleratorConfig for the TPU Node. + shielded_instance_config (google.cloud.tpu_v2alpha1.types.ShieldedInstanceConfig): + Shielded Instance options. + multislice_node (bool): + Output only. Whether the Node belongs to a + Multislice group. + """ + class State(proto.Enum): + r"""Represents the different states of a TPU node during its + lifecycle. + + Values: + STATE_UNSPECIFIED (0): + TPU node state is not known/set. + CREATING (1): + TPU node is being created. + READY (2): + TPU node has been created. + RESTARTING (3): + TPU node is restarting. + REIMAGING (4): + TPU node is undergoing reimaging. + DELETING (5): + TPU node is being deleted. + REPAIRING (6): + TPU node is being repaired and may be unusable. Details can + be found in the 'help_description' field. + STOPPED (8): + TPU node is stopped. + STOPPING (9): + TPU node is currently stopping. + STARTING (10): + TPU node is currently starting. + PREEMPTED (11): + TPU node has been preempted. Only applies to + Preemptible TPU Nodes. + TERMINATED (12): + TPU node has been terminated due to + maintenance or has reached the end of its life + cycle (for preemptible nodes). + HIDING (13): + TPU node is currently hiding. + HIDDEN (14): + TPU node has been hidden. + UNHIDING (15): + TPU node is currently unhiding. + """ + STATE_UNSPECIFIED = 0 + CREATING = 1 + READY = 2 + RESTARTING = 3 + REIMAGING = 4 + DELETING = 5 + REPAIRING = 6 + STOPPED = 8 + STOPPING = 9 + STARTING = 10 + PREEMPTED = 11 + TERMINATED = 12 + HIDING = 13 + HIDDEN = 14 + UNHIDING = 15 + + class Health(proto.Enum): + r"""Health defines the status of a TPU node as reported by + Health Monitor. + + Values: + HEALTH_UNSPECIFIED (0): + Health status is unknown: not initialized or + failed to retrieve. + HEALTHY (1): + The resource is healthy. + TIMEOUT (3): + The resource is unresponsive. + UNHEALTHY_TENSORFLOW (4): + The in-guest ML stack is unhealthy. + UNHEALTHY_MAINTENANCE (5): + The node is under maintenance/priority boost + caused rescheduling and will resume running once + rescheduled. + """ + HEALTH_UNSPECIFIED = 0 + HEALTHY = 1 + TIMEOUT = 3 + UNHEALTHY_TENSORFLOW = 4 + UNHEALTHY_MAINTENANCE = 5 + + class ApiVersion(proto.Enum): + r"""TPU API Version. + + Values: + API_VERSION_UNSPECIFIED (0): + API version is unknown. + V1_ALPHA1 (1): + TPU API V1Alpha1 version. + V1 (2): + TPU API V1 version. + V2_ALPHA1 (3): + TPU API V2Alpha1 version. + """ + API_VERSION_UNSPECIFIED = 0 + V1_ALPHA1 = 1 + V1 = 2 + V2_ALPHA1 = 3 + + name: str = proto.Field( + proto.STRING, + number=1, + ) + description: str = proto.Field( + proto.STRING, + number=3, + ) + accelerator_type: str = proto.Field( + proto.STRING, + number=5, + ) + state: State = proto.Field( + proto.ENUM, + number=9, + enum=State, + ) + health_description: str = proto.Field( + proto.STRING, + number=10, + ) + runtime_version: str = proto.Field( + proto.STRING, + number=11, + ) + network_config: 'NetworkConfig' = proto.Field( + proto.MESSAGE, + number=36, + message='NetworkConfig', + ) + cidr_block: str = proto.Field( + proto.STRING, + number=13, + ) + service_account: 'ServiceAccount' = proto.Field( + proto.MESSAGE, + number=37, + message='ServiceAccount', + ) + create_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=16, + message=timestamp_pb2.Timestamp, + ) + scheduling_config: 'SchedulingConfig' = proto.Field( + proto.MESSAGE, + number=17, + message='SchedulingConfig', + ) + network_endpoints: MutableSequence['NetworkEndpoint'] = proto.RepeatedField( + proto.MESSAGE, + number=21, + message='NetworkEndpoint', + ) + health: Health = proto.Field( + proto.ENUM, + number=22, + enum=Health, + ) + labels: MutableMapping[str, str] = proto.MapField( + proto.STRING, + proto.STRING, + number=24, + ) + metadata: MutableMapping[str, str] = proto.MapField( + proto.STRING, + proto.STRING, + number=34, + ) + tags: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=40, + ) + id: int = proto.Field( + proto.INT64, + number=33, + ) + data_disks: MutableSequence['AttachedDisk'] = proto.RepeatedField( + proto.MESSAGE, + number=41, + message='AttachedDisk', + ) + api_version: ApiVersion = proto.Field( + proto.ENUM, + number=38, + enum=ApiVersion, + ) + symptoms: MutableSequence['Symptom'] = proto.RepeatedField( + proto.MESSAGE, + number=39, + message='Symptom', + ) + queued_resource: str = proto.Field( + proto.STRING, + number=43, + ) + accelerator_config: 'AcceleratorConfig' = proto.Field( + proto.MESSAGE, + number=44, + message='AcceleratorConfig', + ) + shielded_instance_config: 'ShieldedInstanceConfig' = proto.Field( + proto.MESSAGE, + number=45, + message='ShieldedInstanceConfig', + ) + multislice_node: bool = proto.Field( + proto.BOOL, + number=47, + ) + + +class QueuedResource(proto.Message): + r"""A QueuedResource represents a request for resources that will + be placed in a queue and fulfilled when the necessary resources + are available. + + This message has `oneof`_ fields (mutually exclusive fields). + For each oneof, at most one member field can be set at the same time. + Setting any member of the oneof automatically clears all other + members. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + name (str): + Output only. Immutable. The name of the + QueuedResource. + tpu (google.cloud.tpu_v2alpha1.types.QueuedResource.Tpu): + Defines a TPU resource. + + This field is a member of `oneof`_ ``resource``. + best_effort (google.cloud.tpu_v2alpha1.types.QueuedResource.BestEffort): + The BestEffort tier. + + This field is a member of `oneof`_ ``tier``. + guaranteed (google.cloud.tpu_v2alpha1.types.QueuedResource.Guaranteed): + The Guaranteed tier + + This field is a member of `oneof`_ ``tier``. + queueing_policy (google.cloud.tpu_v2alpha1.types.QueuedResource.QueueingPolicy): + The queueing policy of the QueuedRequest. + state (google.cloud.tpu_v2alpha1.types.QueuedResourceState): + Output only. State of the QueuedResource + request. + reservation_name (str): + Name of the reservation in which the resource + should be provisioned. Format: + projects/{project}/locations/{zone}/reservations/{reservation} + """ + + class Tpu(proto.Message): + r"""Details of the TPU resource(s) being requested. + + Attributes: + node_spec (MutableSequence[google.cloud.tpu_v2alpha1.types.QueuedResource.Tpu.NodeSpec]): + The TPU node(s) being requested. + """ + + class NodeSpec(proto.Message): + r"""Details of the TPU node(s) being requested. Users can request + either a single node or multiple nodes. + NodeSpec provides the specification for node(s) to be created. + + Attributes: + parent (str): + Required. The parent resource name. + node_id (str): + The unqualified resource name. Should follow the + ``^[A-Za-z0-9_.~+%-]+$`` regex format. This is only + specified when requesting a single node. In case of + multi-node requests, multi_node_params must be populated + instead. It's an error to specify both node_id and + multi_node_params. + node (google.cloud.tpu_v2alpha1.types.Node): + Required. The node. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + node_id: str = proto.Field( + proto.STRING, + number=2, + ) + node: 'Node' = proto.Field( + proto.MESSAGE, + number=3, + message='Node', + ) + + node_spec: MutableSequence['QueuedResource.Tpu.NodeSpec'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='QueuedResource.Tpu.NodeSpec', + ) + + class BestEffort(proto.Message): + r"""BestEffort tier definition. + """ + + class Guaranteed(proto.Message): + r"""Guaranteed tier definition. + + Attributes: + min_duration (google.protobuf.duration_pb2.Duration): + Optional. Defines the minimum duration of the + guarantee. If specified, the requested resources + will only be provisioned if they can be + allocated for at least the given duration. + reserved (bool): + Optional. Specifies the request should be + scheduled on reserved capacity. + """ + + min_duration: duration_pb2.Duration = proto.Field( + proto.MESSAGE, + number=1, + message=duration_pb2.Duration, + ) + reserved: bool = proto.Field( + proto.BOOL, + number=2, + ) + + class QueueingPolicy(proto.Message): + r"""Defines the policy of the QueuedRequest. + + This message has `oneof`_ fields (mutually exclusive fields). + For each oneof, at most one member field can be set at the same time. + Setting any member of the oneof automatically clears all other + members. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + valid_until_duration (google.protobuf.duration_pb2.Duration): + A relative time after which resources should + not be created. If the request cannot be + fulfilled by this time the request will be + failed. + + This field is a member of `oneof`_ ``start_timing_constraints``. + valid_until_time (google.protobuf.timestamp_pb2.Timestamp): + An absolute time after which resources should + not be created. If the request cannot be + fulfilled by this time the request will be + failed. + + This field is a member of `oneof`_ ``start_timing_constraints``. + valid_after_duration (google.protobuf.duration_pb2.Duration): + A relative time after which resources may be + created. + + This field is a member of `oneof`_ ``start_timing_constraints``. + valid_after_time (google.protobuf.timestamp_pb2.Timestamp): + An absolute time at which resources may be + created. + + This field is a member of `oneof`_ ``start_timing_constraints``. + valid_interval (google.type.interval_pb2.Interval): + An absolute time interval within which + resources may be created. + + This field is a member of `oneof`_ ``start_timing_constraints``. + """ + + valid_until_duration: duration_pb2.Duration = proto.Field( + proto.MESSAGE, + number=1, + oneof='start_timing_constraints', + message=duration_pb2.Duration, + ) + valid_until_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=2, + oneof='start_timing_constraints', + message=timestamp_pb2.Timestamp, + ) + valid_after_duration: duration_pb2.Duration = proto.Field( + proto.MESSAGE, + number=3, + oneof='start_timing_constraints', + message=duration_pb2.Duration, + ) + valid_after_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=4, + oneof='start_timing_constraints', + message=timestamp_pb2.Timestamp, + ) + valid_interval: interval_pb2.Interval = proto.Field( + proto.MESSAGE, + number=5, + oneof='start_timing_constraints', + message=interval_pb2.Interval, + ) + + name: str = proto.Field( + proto.STRING, + number=1, + ) + tpu: Tpu = proto.Field( + proto.MESSAGE, + number=2, + oneof='resource', + message=Tpu, + ) + best_effort: BestEffort = proto.Field( + proto.MESSAGE, + number=3, + oneof='tier', + message=BestEffort, + ) + guaranteed: Guaranteed = proto.Field( + proto.MESSAGE, + number=4, + oneof='tier', + message=Guaranteed, + ) + queueing_policy: QueueingPolicy = proto.Field( + proto.MESSAGE, + number=5, + message=QueueingPolicy, + ) + state: 'QueuedResourceState' = proto.Field( + proto.MESSAGE, + number=6, + message='QueuedResourceState', + ) + reservation_name: str = proto.Field( + proto.STRING, + number=8, + ) + + +class QueuedResourceState(proto.Message): + r"""QueuedResourceState defines the details of the QueuedResource + request. + + This message has `oneof`_ fields (mutually exclusive fields). + For each oneof, at most one member field can be set at the same time. + Setting any member of the oneof automatically clears all other + members. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + state (google.cloud.tpu_v2alpha1.types.QueuedResourceState.State): + State of the QueuedResource request. + creating_data (google.cloud.tpu_v2alpha1.types.QueuedResourceState.CreatingData): + Further data for the creating state. + + This field is a member of `oneof`_ ``state_data``. + accepted_data (google.cloud.tpu_v2alpha1.types.QueuedResourceState.AcceptedData): + Further data for the accepted state. + + This field is a member of `oneof`_ ``state_data``. + provisioning_data (google.cloud.tpu_v2alpha1.types.QueuedResourceState.ProvisioningData): + Further data for the provisioning state. + + This field is a member of `oneof`_ ``state_data``. + failed_data (google.cloud.tpu_v2alpha1.types.QueuedResourceState.FailedData): + Further data for the failed state. + + This field is a member of `oneof`_ ``state_data``. + deleting_data (google.cloud.tpu_v2alpha1.types.QueuedResourceState.DeletingData): + Further data for the deleting state. + + This field is a member of `oneof`_ ``state_data``. + active_data (google.cloud.tpu_v2alpha1.types.QueuedResourceState.ActiveData): + Further data for the active state. + + This field is a member of `oneof`_ ``state_data``. + suspending_data (google.cloud.tpu_v2alpha1.types.QueuedResourceState.SuspendingData): + Further data for the suspending state. + + This field is a member of `oneof`_ ``state_data``. + suspended_data (google.cloud.tpu_v2alpha1.types.QueuedResourceState.SuspendedData): + Further data for the suspended state. + + This field is a member of `oneof`_ ``state_data``. + """ + class State(proto.Enum): + r"""Output only state of the request + + Values: + STATE_UNSPECIFIED (0): + State of the QueuedResource request is not + known/set. + CREATING (1): + The QueuedResource request has been received. + We're still working on determining if we will be + able to honor this request. + ACCEPTED (2): + The QueuedResource request has passed initial + validation/admission control and has been + persisted in the queue. + PROVISIONING (3): + The QueuedResource request has been selected. + The associated resources are currently being + provisioned (or very soon will begin + provisioning). + FAILED (4): + The request could not be completed. This may + be due to some late-discovered problem with the + request itself, or due to unavailability of + resources within the constraints of the request + (e.g., the 'valid until' start timing constraint + expired). + DELETING (5): + The QueuedResource is being deleted. + ACTIVE (6): + The resources specified in the QueuedResource + request have been provisioned and are ready for + use by the end-user/consumer. + SUSPENDING (7): + The resources specified in the QueuedResource + request are being deleted. This may have been + initiated by the user, or the Cloud TPU service. + Inspect the state data for more details. + SUSPENDED (8): + The resources specified in the QueuedResource + request have been deleted. + """ + STATE_UNSPECIFIED = 0 + CREATING = 1 + ACCEPTED = 2 + PROVISIONING = 3 + FAILED = 4 + DELETING = 5 + ACTIVE = 6 + SUSPENDING = 7 + SUSPENDED = 8 + + class CreatingData(proto.Message): + r"""Further data for the creating state. + """ + + class AcceptedData(proto.Message): + r"""Further data for the accepted state. + """ + + class ProvisioningData(proto.Message): + r"""Further data for the provisioning state. + """ + + class FailedData(proto.Message): + r"""Further data for the failed state. + + Attributes: + error (google.rpc.status_pb2.Status): + The error that caused the queued resource to + enter the FAILED state. + """ + + error: status_pb2.Status = proto.Field( + proto.MESSAGE, + number=1, + message=status_pb2.Status, + ) + + class DeletingData(proto.Message): + r"""Further data for the deleting state. + """ + + class ActiveData(proto.Message): + r"""Further data for the active state. + """ + + class SuspendingData(proto.Message): + r"""Further data for the suspending state. + """ + + class SuspendedData(proto.Message): + r"""Further data for the suspended state. + """ + + state: State = proto.Field( + proto.ENUM, + number=1, + enum=State, + ) + creating_data: CreatingData = proto.Field( + proto.MESSAGE, + number=2, + oneof='state_data', + message=CreatingData, + ) + accepted_data: AcceptedData = proto.Field( + proto.MESSAGE, + number=3, + oneof='state_data', + message=AcceptedData, + ) + provisioning_data: ProvisioningData = proto.Field( + proto.MESSAGE, + number=4, + oneof='state_data', + message=ProvisioningData, + ) + failed_data: FailedData = proto.Field( + proto.MESSAGE, + number=5, + oneof='state_data', + message=FailedData, + ) + deleting_data: DeletingData = proto.Field( + proto.MESSAGE, + number=6, + oneof='state_data', + message=DeletingData, + ) + active_data: ActiveData = proto.Field( + proto.MESSAGE, + number=7, + oneof='state_data', + message=ActiveData, + ) + suspending_data: SuspendingData = proto.Field( + proto.MESSAGE, + number=8, + oneof='state_data', + message=SuspendingData, + ) + suspended_data: SuspendedData = proto.Field( + proto.MESSAGE, + number=9, + oneof='state_data', + message=SuspendedData, + ) + + +class ListNodesRequest(proto.Message): + r"""Request for [ListNodes][google.cloud.tpu.v2alpha1.Tpu.ListNodes]. + + Attributes: + parent (str): + Required. The parent resource name. + page_size (int): + The maximum number of items to return. + page_token (str): + The next_page_token value returned from a previous List + request, if any. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + page_size: int = proto.Field( + proto.INT32, + number=2, + ) + page_token: str = proto.Field( + proto.STRING, + number=3, + ) + + +class ListNodesResponse(proto.Message): + r"""Response for [ListNodes][google.cloud.tpu.v2alpha1.Tpu.ListNodes]. + + Attributes: + nodes (MutableSequence[google.cloud.tpu_v2alpha1.types.Node]): + The listed nodes. + next_page_token (str): + The next page token or empty if none. + unreachable (MutableSequence[str]): + Locations that could not be reached. + """ + + @property + def raw_page(self): + return self + + nodes: MutableSequence['Node'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='Node', + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + unreachable: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=3, + ) + + +class GetNodeRequest(proto.Message): + r"""Request for [GetNode][google.cloud.tpu.v2alpha1.Tpu.GetNode]. + + Attributes: + name (str): + Required. The resource name. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class CreateNodeRequest(proto.Message): + r"""Request for [CreateNode][google.cloud.tpu.v2alpha1.Tpu.CreateNode]. + + Attributes: + parent (str): + Required. The parent resource name. + node_id (str): + The unqualified resource name. + node (google.cloud.tpu_v2alpha1.types.Node): + Required. The node. + request_id (str): + Idempotent request UUID. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + node_id: str = proto.Field( + proto.STRING, + number=2, + ) + node: 'Node' = proto.Field( + proto.MESSAGE, + number=3, + message='Node', + ) + request_id: str = proto.Field( + proto.STRING, + number=6, + ) + + +class DeleteNodeRequest(proto.Message): + r"""Request for [DeleteNode][google.cloud.tpu.v2alpha1.Tpu.DeleteNode]. + + Attributes: + name (str): + Required. The resource name. + request_id (str): + Idempotent request UUID. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + request_id: str = proto.Field( + proto.STRING, + number=3, + ) + + +class StopNodeRequest(proto.Message): + r"""Request for [StopNode][google.cloud.tpu.v2alpha1.Tpu.StopNode]. + + Attributes: + name (str): + Required. The resource name. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class StartNodeRequest(proto.Message): + r"""Request for [StartNode][google.cloud.tpu.v2alpha1.Tpu.StartNode]. + + Attributes: + name (str): + Required. The resource name. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class UpdateNodeRequest(proto.Message): + r"""Request for [UpdateNode][google.cloud.tpu.v2alpha1.Tpu.UpdateNode]. + + Attributes: + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Required. Mask of fields from [Node][Tpu.Node] to update. + Supported fields: [description, tags, labels, metadata, + network_config.enable_external_ips]. + node (google.cloud.tpu_v2alpha1.types.Node): + Required. The node. Only fields specified in update_mask are + updated. + """ + + update_mask: field_mask_pb2.FieldMask = proto.Field( + proto.MESSAGE, + number=1, + message=field_mask_pb2.FieldMask, + ) + node: 'Node' = proto.Field( + proto.MESSAGE, + number=2, + message='Node', + ) + + +class ListQueuedResourcesRequest(proto.Message): + r"""Request for + [ListQueuedResources][google.cloud.tpu.v2alpha1.Tpu.ListQueuedResources]. + + Attributes: + parent (str): + Required. The parent resource name. + page_size (int): + The maximum number of items to return. + page_token (str): + The next_page_token value returned from a previous List + request, if any. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + page_size: int = proto.Field( + proto.INT32, + number=2, + ) + page_token: str = proto.Field( + proto.STRING, + number=3, + ) + + +class ListQueuedResourcesResponse(proto.Message): + r"""Response for + [ListQueuedResources][google.cloud.tpu.v2alpha1.Tpu.ListQueuedResources]. + + Attributes: + queued_resources (MutableSequence[google.cloud.tpu_v2alpha1.types.QueuedResource]): + The listed queued resources. + next_page_token (str): + The next page token or empty if none. + unreachable (MutableSequence[str]): + Locations that could not be reached. + """ + + @property + def raw_page(self): + return self + + queued_resources: MutableSequence['QueuedResource'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='QueuedResource', + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + unreachable: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=3, + ) + + +class GetQueuedResourceRequest(proto.Message): + r"""Request for + [GetQueuedResource][google.cloud.tpu.v2alpha1.Tpu.GetQueuedResource] + + Attributes: + name (str): + Required. The resource name. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class CreateQueuedResourceRequest(proto.Message): + r"""Request for + [CreateQueuedResource][google.cloud.tpu.v2alpha1.Tpu.CreateQueuedResource]. + + Attributes: + parent (str): + Required. The parent resource name. + queued_resource_id (str): + The unqualified resource name. Should follow the + ``^[A-Za-z0-9_.~+%-]+$`` regex format. + queued_resource (google.cloud.tpu_v2alpha1.types.QueuedResource): + Required. The queued resource. + request_id (str): + Idempotent request UUID. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + queued_resource_id: str = proto.Field( + proto.STRING, + number=2, + ) + queued_resource: 'QueuedResource' = proto.Field( + proto.MESSAGE, + number=3, + message='QueuedResource', + ) + request_id: str = proto.Field( + proto.STRING, + number=4, + ) + + +class DeleteQueuedResourceRequest(proto.Message): + r"""Request for + [DeleteQueuedResource][google.cloud.tpu.v2alpha1.Tpu.DeleteQueuedResource]. + + Attributes: + name (str): + Required. The resource name. + request_id (str): + Idempotent request UUID. + force (bool): + If set to true, all running nodes belonging + to this queued resource will be deleted first + and then the queued resource will be deleted. + Otherwise (i.e. force=false), the queued + resource will only be deleted if its nodes have + already been deleted or the queued resource is + in the ACCEPTED, FAILED, or SUSPENDED state. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + request_id: str = proto.Field( + proto.STRING, + number=2, + ) + force: bool = proto.Field( + proto.BOOL, + number=3, + ) + + +class ServiceIdentity(proto.Message): + r"""The per-product per-project service identity for Cloud TPU + service. + + Attributes: + email (str): + The email address of the service identity. + """ + + email: str = proto.Field( + proto.STRING, + number=1, + ) + + +class GenerateServiceIdentityRequest(proto.Message): + r"""Request for + [GenerateServiceIdentity][google.cloud.tpu.v2alpha1.Tpu.GenerateServiceIdentity]. + + Attributes: + parent (str): + Required. The parent resource name. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + + +class GenerateServiceIdentityResponse(proto.Message): + r"""Response for + [GenerateServiceIdentity][google.cloud.tpu.v2alpha1.Tpu.GenerateServiceIdentity]. + + Attributes: + identity (google.cloud.tpu_v2alpha1.types.ServiceIdentity): + ServiceIdentity that was created or + retrieved. + """ + + identity: 'ServiceIdentity' = proto.Field( + proto.MESSAGE, + number=1, + message='ServiceIdentity', + ) + + +class AcceleratorType(proto.Message): + r"""A accelerator type that a Node can be configured with. + + Attributes: + name (str): + The resource name. + type_ (str): + The accelerator type. + accelerator_configs (MutableSequence[google.cloud.tpu_v2alpha1.types.AcceleratorConfig]): + The accelerator config. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + type_: str = proto.Field( + proto.STRING, + number=2, + ) + accelerator_configs: MutableSequence['AcceleratorConfig'] = proto.RepeatedField( + proto.MESSAGE, + number=3, + message='AcceleratorConfig', + ) + + +class GetAcceleratorTypeRequest(proto.Message): + r"""Request for + [GetAcceleratorType][google.cloud.tpu.v2alpha1.Tpu.GetAcceleratorType]. + + Attributes: + name (str): + Required. The resource name. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class ListAcceleratorTypesRequest(proto.Message): + r"""Request for + [ListAcceleratorTypes][google.cloud.tpu.v2alpha1.Tpu.ListAcceleratorTypes]. + + Attributes: + parent (str): + Required. The parent resource name. + page_size (int): + The maximum number of items to return. + page_token (str): + The next_page_token value returned from a previous List + request, if any. + filter (str): + List filter. + order_by (str): + Sort results. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + page_size: int = proto.Field( + proto.INT32, + number=2, + ) + page_token: str = proto.Field( + proto.STRING, + number=3, + ) + filter: str = proto.Field( + proto.STRING, + number=5, + ) + order_by: str = proto.Field( + proto.STRING, + number=6, + ) + + +class ListAcceleratorTypesResponse(proto.Message): + r"""Response for + [ListAcceleratorTypes][google.cloud.tpu.v2alpha1.Tpu.ListAcceleratorTypes]. + + Attributes: + accelerator_types (MutableSequence[google.cloud.tpu_v2alpha1.types.AcceleratorType]): + The listed nodes. + next_page_token (str): + The next page token or empty if none. + unreachable (MutableSequence[str]): + Locations that could not be reached. + """ + + @property + def raw_page(self): + return self + + accelerator_types: MutableSequence['AcceleratorType'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='AcceleratorType', + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + unreachable: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=3, + ) + + +class RuntimeVersion(proto.Message): + r"""A runtime version that a Node can be configured with. + + Attributes: + name (str): + The resource name. + version (str): + The runtime version. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + version: str = proto.Field( + proto.STRING, + number=2, + ) + + +class GetRuntimeVersionRequest(proto.Message): + r"""Request for + [GetRuntimeVersion][google.cloud.tpu.v2alpha1.Tpu.GetRuntimeVersion]. + + Attributes: + name (str): + Required. The resource name. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class ListRuntimeVersionsRequest(proto.Message): + r"""Request for + [ListRuntimeVersions][google.cloud.tpu.v2alpha1.Tpu.ListRuntimeVersions]. + + Attributes: + parent (str): + Required. The parent resource name. + page_size (int): + The maximum number of items to return. + page_token (str): + The next_page_token value returned from a previous List + request, if any. + filter (str): + List filter. + order_by (str): + Sort results. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + page_size: int = proto.Field( + proto.INT32, + number=2, + ) + page_token: str = proto.Field( + proto.STRING, + number=3, + ) + filter: str = proto.Field( + proto.STRING, + number=5, + ) + order_by: str = proto.Field( + proto.STRING, + number=6, + ) + + +class ListRuntimeVersionsResponse(proto.Message): + r"""Response for + [ListRuntimeVersions][google.cloud.tpu.v2alpha1.Tpu.ListRuntimeVersions]. + + Attributes: + runtime_versions (MutableSequence[google.cloud.tpu_v2alpha1.types.RuntimeVersion]): + The listed nodes. + next_page_token (str): + The next page token or empty if none. + unreachable (MutableSequence[str]): + Locations that could not be reached. + """ + + @property + def raw_page(self): + return self + + runtime_versions: MutableSequence['RuntimeVersion'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='RuntimeVersion', + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + unreachable: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=3, + ) + + +class OperationMetadata(proto.Message): + r"""Metadata describing an [Operation][google.longrunning.Operation] + + Attributes: + create_time (google.protobuf.timestamp_pb2.Timestamp): + The time the operation was created. + end_time (google.protobuf.timestamp_pb2.Timestamp): + The time the operation finished running. + target (str): + Target of the operation - for example + projects/project-1/connectivityTests/test-1 + verb (str): + Name of the verb executed by the operation. + status_detail (str): + Human-readable status of the operation, if + any. + cancel_requested (bool): + Specifies if cancellation was requested for + the operation. + api_version (str): + API version. + """ + + create_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=1, + message=timestamp_pb2.Timestamp, + ) + end_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=2, + message=timestamp_pb2.Timestamp, + ) + target: str = proto.Field( + proto.STRING, + number=3, + ) + verb: str = proto.Field( + proto.STRING, + number=4, + ) + status_detail: str = proto.Field( + proto.STRING, + number=5, + ) + cancel_requested: bool = proto.Field( + proto.BOOL, + number=6, + ) + api_version: str = proto.Field( + proto.STRING, + number=7, + ) + + +class Symptom(proto.Message): + r"""A Symptom instance. + + Attributes: + create_time (google.protobuf.timestamp_pb2.Timestamp): + Timestamp when the Symptom is created. + symptom_type (google.cloud.tpu_v2alpha1.types.Symptom.SymptomType): + Type of the Symptom. + details (str): + Detailed information of the current Symptom. + worker_id (str): + A string used to uniquely distinguish a + worker within a TPU node. + """ + class SymptomType(proto.Enum): + r"""SymptomType represents the different types of Symptoms that a + TPU can be at. + + Values: + SYMPTOM_TYPE_UNSPECIFIED (0): + Unspecified symptom. + LOW_MEMORY (1): + TPU VM memory is low. + OUT_OF_MEMORY (2): + TPU runtime is out of memory. + EXECUTE_TIMED_OUT (3): + TPU runtime execution has timed out. + MESH_BUILD_FAIL (4): + TPU runtime fails to construct a mesh that + recognizes each TPU device's neighbors. + HBM_OUT_OF_MEMORY (5): + TPU HBM is out of memory. + PROJECT_ABUSE (6): + Abusive behaviors have been identified on the + current project. + """ + SYMPTOM_TYPE_UNSPECIFIED = 0 + LOW_MEMORY = 1 + OUT_OF_MEMORY = 2 + EXECUTE_TIMED_OUT = 3 + MESH_BUILD_FAIL = 4 + HBM_OUT_OF_MEMORY = 5 + PROJECT_ABUSE = 6 + + create_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=1, + message=timestamp_pb2.Timestamp, + ) + symptom_type: SymptomType = proto.Field( + proto.ENUM, + number=2, + enum=SymptomType, + ) + details: str = proto.Field( + proto.STRING, + number=3, + ) + worker_id: str = proto.Field( + proto.STRING, + number=4, + ) + + +class GetGuestAttributesRequest(proto.Message): + r"""Request for + [GetGuestAttributes][google.cloud.tpu.v2alpha1.Tpu.GetGuestAttributes]. + + Attributes: + name (str): + Required. The resource name. + query_path (str): + The guest attributes path to be queried. + worker_ids (MutableSequence[str]): + The 0-based worker ID. If it is empty, all + workers' GuestAttributes will be returned. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + query_path: str = proto.Field( + proto.STRING, + number=2, + ) + worker_ids: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=3, + ) + + +class GetGuestAttributesResponse(proto.Message): + r"""Response for + [GetGuestAttributes][google.cloud.tpu.v2alpha1.Tpu.GetGuestAttributes]. + + Attributes: + guest_attributes (MutableSequence[google.cloud.tpu_v2alpha1.types.GuestAttributes]): + The guest attributes for the TPU workers. + """ + + guest_attributes: MutableSequence['GuestAttributes'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='GuestAttributes', + ) + + +class SimulateMaintenanceEventRequest(proto.Message): + r"""Request for + [SimulateMaintenanceEvent][google.cloud.tpu.v2alpha1.Tpu.SimulateMaintenanceEvent]. + + Attributes: + name (str): + Required. The resource name. + worker_ids (MutableSequence[str]): + The 0-based worker ID. If it is empty, worker + ID 0 will be selected for maintenance event + simulation. A maintenance event will only be + fired on the first specified worker ID. Future + implementations may support firing on multiple + workers. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + worker_ids: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=2, + ) + + +class AcceleratorConfig(proto.Message): + r"""A TPU accelerator configuration. + + Attributes: + type_ (google.cloud.tpu_v2alpha1.types.AcceleratorConfig.Type): + Required. Type of TPU. + topology (str): + Required. Topology of TPU in chips. + """ + class Type(proto.Enum): + r"""TPU type. + + Values: + TYPE_UNSPECIFIED (0): + Unspecified version. + V2 (2): + TPU v2. + V3 (4): + TPU v3. + V4 (7): + TPU v4. + """ + TYPE_UNSPECIFIED = 0 + V2 = 2 + V3 = 4 + V4 = 7 + + type_: Type = proto.Field( + proto.ENUM, + number=1, + enum=Type, + ) + topology: str = proto.Field( + proto.STRING, + number=2, + ) + + +class ShieldedInstanceConfig(proto.Message): + r"""A set of Shielded Instance options. + + Attributes: + enable_secure_boot (bool): + Defines whether the instance has Secure Boot + enabled. + """ + + enable_secure_boot: bool = proto.Field( + proto.BOOL, + number=1, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v2alpha1/mypy.ini b/owl-bot-staging/v2alpha1/mypy.ini new file mode 100644 index 0000000..574c5ae --- /dev/null +++ b/owl-bot-staging/v2alpha1/mypy.ini @@ -0,0 +1,3 @@ +[mypy] +python_version = 3.7 +namespace_packages = True diff --git a/owl-bot-staging/v2alpha1/noxfile.py b/owl-bot-staging/v2alpha1/noxfile.py new file mode 100644 index 0000000..1d69ae3 --- /dev/null +++ b/owl-bot-staging/v2alpha1/noxfile.py @@ -0,0 +1,184 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +import pathlib +import shutil +import subprocess +import sys + + +import nox # type: ignore + +ALL_PYTHON = [ + "3.7", + "3.8", + "3.9", + "3.10", + "3.11", +] + +CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() + +LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" +PACKAGE_NAME = subprocess.check_output([sys.executable, "setup.py", "--name"], encoding="utf-8") + +BLACK_VERSION = "black==22.3.0" +BLACK_PATHS = ["docs", "google", "tests", "samples", "noxfile.py", "setup.py"] +DEFAULT_PYTHON_VERSION = "3.11" + +nox.sessions = [ + "unit", + "cover", + "mypy", + "check_lower_bounds" + # exclude update_lower_bounds from default + "docs", + "blacken", + "lint", + "lint_setup_py", +] + +@nox.session(python=ALL_PYTHON) +def unit(session): + """Run the unit test suite.""" + + session.install('coverage', 'pytest', 'pytest-cov', 'pytest-asyncio', 'asyncmock; python_version < "3.8"') + session.install('-e', '.') + + session.run( + 'py.test', + '--quiet', + '--cov=google/cloud/tpu_v2alpha1/', + '--cov=tests/', + '--cov-config=.coveragerc', + '--cov-report=term', + '--cov-report=html', + os.path.join('tests', 'unit', ''.join(session.posargs)) + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def cover(session): + """Run the final coverage report. + This outputs the coverage report aggregating coverage from the unit + test runs (not system test runs), and then erases coverage data. + """ + session.install("coverage", "pytest-cov") + session.run("coverage", "report", "--show-missing", "--fail-under=100") + + session.run("coverage", "erase") + + +@nox.session(python=ALL_PYTHON) +def mypy(session): + """Run the type checker.""" + session.install( + 'mypy', + 'types-requests', + 'types-protobuf' + ) + session.install('.') + session.run( + 'mypy', + '--explicit-package-bases', + 'google', + ) + + +@nox.session +def update_lower_bounds(session): + """Update lower bounds in constraints.txt to match setup.py""" + session.install('google-cloud-testutils') + session.install('.') + + session.run( + 'lower-bound-checker', + 'update', + '--package-name', + PACKAGE_NAME, + '--constraints-file', + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + + +@nox.session +def check_lower_bounds(session): + """Check lower bounds in setup.py are reflected in constraints file""" + session.install('google-cloud-testutils') + session.install('.') + + session.run( + 'lower-bound-checker', + 'check', + '--package-name', + PACKAGE_NAME, + '--constraints-file', + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def docs(session): + """Build the docs for this library.""" + + session.install("-e", ".") + session.install("sphinx==4.0.1", "alabaster", "recommonmark") + + shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) + session.run( + "sphinx-build", + "-W", # warnings as errors + "-T", # show full traceback on exception + "-N", # no colors + "-b", + "html", + "-d", + os.path.join("docs", "_build", "doctrees", ""), + os.path.join("docs", ""), + os.path.join("docs", "_build", "html", ""), + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint(session): + """Run linters. + + Returns a failure if the linters find linting errors or sufficiently + serious code quality issues. + """ + session.install("flake8", BLACK_VERSION) + session.run( + "black", + "--check", + *BLACK_PATHS, + ) + session.run("flake8", "google", "tests", "samples") + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def blacken(session): + """Run black. Format code to uniform standard.""" + session.install(BLACK_VERSION) + session.run( + "black", + *BLACK_PATHS, + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint_setup_py(session): + """Verify that setup.py is valid (including RST check).""" + session.install("docutils", "pygments") + session.run("python", "setup.py", "check", "--restructuredtext", "--strict") diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/snippet_metadata_google.cloud.tpu.v2alpha1.json b/owl-bot-staging/v2alpha1/samples/generated_samples/snippet_metadata_google.cloud.tpu.v2alpha1.json new file mode 100644 index 0000000..2512354 --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/snippet_metadata_google.cloud.tpu.v2alpha1.json @@ -0,0 +1,2913 @@ +{ + "clientLibrary": { + "apis": [ + { + "id": "google.cloud.tpu.v2alpha1", + "version": "v2alpha1" + } + ], + "language": "PYTHON", + "name": "google-cloud-tpu", + "version": "0.1.0" + }, + "snippets": [ + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient.create_node", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.CreateNode", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "CreateNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.CreateNodeRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "node", + "type": "google.cloud.tpu_v2alpha1.types.Node" + }, + { + "name": "node_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "create_node" + }, + "description": "Sample for CreateNode", + "file": "tpu_v2alpha1_generated_tpu_create_node_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_CreateNode_async", + "segments": [ + { + "end": 59, + "start": 27, + "type": "FULL" + }, + { + "end": 59, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 49, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 56, + "start": 50, + "type": "REQUEST_EXECUTION" + }, + { + "end": 60, + "start": 57, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_create_node_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuClient.create_node", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.CreateNode", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "CreateNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.CreateNodeRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "node", + "type": "google.cloud.tpu_v2alpha1.types.Node" + }, + { + "name": "node_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "create_node" + }, + "description": "Sample for CreateNode", + "file": "tpu_v2alpha1_generated_tpu_create_node_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_CreateNode_sync", + "segments": [ + { + "end": 59, + "start": 27, + "type": "FULL" + }, + { + "end": 59, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 49, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 56, + "start": 50, + "type": "REQUEST_EXECUTION" + }, + { + "end": 60, + "start": 57, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_create_node_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient.create_queued_resource", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.CreateQueuedResource", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "CreateQueuedResource" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.CreateQueuedResourceRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "queued_resource", + "type": "google.cloud.tpu_v2alpha1.types.QueuedResource" + }, + { + "name": "queued_resource_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "create_queued_resource" + }, + "description": "Sample for CreateQueuedResource", + "file": "tpu_v2alpha1_generated_tpu_create_queued_resource_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_CreateQueuedResource_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_create_queued_resource_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuClient.create_queued_resource", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.CreateQueuedResource", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "CreateQueuedResource" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.CreateQueuedResourceRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "queued_resource", + "type": "google.cloud.tpu_v2alpha1.types.QueuedResource" + }, + { + "name": "queued_resource_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "create_queued_resource" + }, + "description": "Sample for CreateQueuedResource", + "file": "tpu_v2alpha1_generated_tpu_create_queued_resource_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_CreateQueuedResource_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_create_queued_resource_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient.delete_node", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.DeleteNode", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "DeleteNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.DeleteNodeRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "delete_node" + }, + "description": "Sample for DeleteNode", + "file": "tpu_v2alpha1_generated_tpu_delete_node_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_DeleteNode_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_delete_node_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuClient.delete_node", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.DeleteNode", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "DeleteNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.DeleteNodeRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "delete_node" + }, + "description": "Sample for DeleteNode", + "file": "tpu_v2alpha1_generated_tpu_delete_node_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_DeleteNode_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_delete_node_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient.delete_queued_resource", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.DeleteQueuedResource", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "DeleteQueuedResource" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.DeleteQueuedResourceRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "delete_queued_resource" + }, + "description": "Sample for DeleteQueuedResource", + "file": "tpu_v2alpha1_generated_tpu_delete_queued_resource_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_DeleteQueuedResource_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_delete_queued_resource_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuClient.delete_queued_resource", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.DeleteQueuedResource", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "DeleteQueuedResource" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.DeleteQueuedResourceRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "delete_queued_resource" + }, + "description": "Sample for DeleteQueuedResource", + "file": "tpu_v2alpha1_generated_tpu_delete_queued_resource_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_DeleteQueuedResource_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_delete_queued_resource_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient.generate_service_identity", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.GenerateServiceIdentity", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "GenerateServiceIdentity" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.GenerateServiceIdentityRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2alpha1.types.GenerateServiceIdentityResponse", + "shortName": "generate_service_identity" + }, + "description": "Sample for GenerateServiceIdentity", + "file": "tpu_v2alpha1_generated_tpu_generate_service_identity_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_GenerateServiceIdentity_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_generate_service_identity_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuClient.generate_service_identity", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.GenerateServiceIdentity", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "GenerateServiceIdentity" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.GenerateServiceIdentityRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2alpha1.types.GenerateServiceIdentityResponse", + "shortName": "generate_service_identity" + }, + "description": "Sample for GenerateServiceIdentity", + "file": "tpu_v2alpha1_generated_tpu_generate_service_identity_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_GenerateServiceIdentity_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_generate_service_identity_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient.get_accelerator_type", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.GetAcceleratorType", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "GetAcceleratorType" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.GetAcceleratorTypeRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2alpha1.types.AcceleratorType", + "shortName": "get_accelerator_type" + }, + "description": "Sample for GetAcceleratorType", + "file": "tpu_v2alpha1_generated_tpu_get_accelerator_type_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_GetAcceleratorType_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_get_accelerator_type_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuClient.get_accelerator_type", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.GetAcceleratorType", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "GetAcceleratorType" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.GetAcceleratorTypeRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2alpha1.types.AcceleratorType", + "shortName": "get_accelerator_type" + }, + "description": "Sample for GetAcceleratorType", + "file": "tpu_v2alpha1_generated_tpu_get_accelerator_type_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_GetAcceleratorType_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_get_accelerator_type_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient.get_guest_attributes", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.GetGuestAttributes", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "GetGuestAttributes" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.GetGuestAttributesRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2alpha1.types.GetGuestAttributesResponse", + "shortName": "get_guest_attributes" + }, + "description": "Sample for GetGuestAttributes", + "file": "tpu_v2alpha1_generated_tpu_get_guest_attributes_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_GetGuestAttributes_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_get_guest_attributes_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuClient.get_guest_attributes", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.GetGuestAttributes", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "GetGuestAttributes" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.GetGuestAttributesRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2alpha1.types.GetGuestAttributesResponse", + "shortName": "get_guest_attributes" + }, + "description": "Sample for GetGuestAttributes", + "file": "tpu_v2alpha1_generated_tpu_get_guest_attributes_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_GetGuestAttributes_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_get_guest_attributes_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient.get_node", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.GetNode", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "GetNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.GetNodeRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2alpha1.types.Node", + "shortName": "get_node" + }, + "description": "Sample for GetNode", + "file": "tpu_v2alpha1_generated_tpu_get_node_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_GetNode_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_get_node_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuClient.get_node", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.GetNode", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "GetNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.GetNodeRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2alpha1.types.Node", + "shortName": "get_node" + }, + "description": "Sample for GetNode", + "file": "tpu_v2alpha1_generated_tpu_get_node_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_GetNode_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_get_node_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient.get_queued_resource", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.GetQueuedResource", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "GetQueuedResource" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.GetQueuedResourceRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2alpha1.types.QueuedResource", + "shortName": "get_queued_resource" + }, + "description": "Sample for GetQueuedResource", + "file": "tpu_v2alpha1_generated_tpu_get_queued_resource_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_GetQueuedResource_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_get_queued_resource_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuClient.get_queued_resource", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.GetQueuedResource", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "GetQueuedResource" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.GetQueuedResourceRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2alpha1.types.QueuedResource", + "shortName": "get_queued_resource" + }, + "description": "Sample for GetQueuedResource", + "file": "tpu_v2alpha1_generated_tpu_get_queued_resource_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_GetQueuedResource_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_get_queued_resource_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient.get_runtime_version", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.GetRuntimeVersion", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "GetRuntimeVersion" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.GetRuntimeVersionRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2alpha1.types.RuntimeVersion", + "shortName": "get_runtime_version" + }, + "description": "Sample for GetRuntimeVersion", + "file": "tpu_v2alpha1_generated_tpu_get_runtime_version_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_GetRuntimeVersion_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_get_runtime_version_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuClient.get_runtime_version", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.GetRuntimeVersion", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "GetRuntimeVersion" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.GetRuntimeVersionRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2alpha1.types.RuntimeVersion", + "shortName": "get_runtime_version" + }, + "description": "Sample for GetRuntimeVersion", + "file": "tpu_v2alpha1_generated_tpu_get_runtime_version_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_GetRuntimeVersion_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_get_runtime_version_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient.list_accelerator_types", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.ListAcceleratorTypes", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "ListAcceleratorTypes" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.ListAcceleratorTypesRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2alpha1.services.tpu.pagers.ListAcceleratorTypesAsyncPager", + "shortName": "list_accelerator_types" + }, + "description": "Sample for ListAcceleratorTypes", + "file": "tpu_v2alpha1_generated_tpu_list_accelerator_types_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_ListAcceleratorTypes_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_list_accelerator_types_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuClient.list_accelerator_types", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.ListAcceleratorTypes", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "ListAcceleratorTypes" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.ListAcceleratorTypesRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2alpha1.services.tpu.pagers.ListAcceleratorTypesPager", + "shortName": "list_accelerator_types" + }, + "description": "Sample for ListAcceleratorTypes", + "file": "tpu_v2alpha1_generated_tpu_list_accelerator_types_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_ListAcceleratorTypes_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_list_accelerator_types_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient.list_nodes", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.ListNodes", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "ListNodes" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.ListNodesRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2alpha1.services.tpu.pagers.ListNodesAsyncPager", + "shortName": "list_nodes" + }, + "description": "Sample for ListNodes", + "file": "tpu_v2alpha1_generated_tpu_list_nodes_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_ListNodes_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_list_nodes_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuClient.list_nodes", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.ListNodes", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "ListNodes" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.ListNodesRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2alpha1.services.tpu.pagers.ListNodesPager", + "shortName": "list_nodes" + }, + "description": "Sample for ListNodes", + "file": "tpu_v2alpha1_generated_tpu_list_nodes_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_ListNodes_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_list_nodes_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient.list_queued_resources", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.ListQueuedResources", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "ListQueuedResources" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.ListQueuedResourcesRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2alpha1.services.tpu.pagers.ListQueuedResourcesAsyncPager", + "shortName": "list_queued_resources" + }, + "description": "Sample for ListQueuedResources", + "file": "tpu_v2alpha1_generated_tpu_list_queued_resources_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_ListQueuedResources_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_list_queued_resources_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuClient.list_queued_resources", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.ListQueuedResources", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "ListQueuedResources" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.ListQueuedResourcesRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2alpha1.services.tpu.pagers.ListQueuedResourcesPager", + "shortName": "list_queued_resources" + }, + "description": "Sample for ListQueuedResources", + "file": "tpu_v2alpha1_generated_tpu_list_queued_resources_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_ListQueuedResources_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_list_queued_resources_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient.list_runtime_versions", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.ListRuntimeVersions", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "ListRuntimeVersions" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.ListRuntimeVersionsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2alpha1.services.tpu.pagers.ListRuntimeVersionsAsyncPager", + "shortName": "list_runtime_versions" + }, + "description": "Sample for ListRuntimeVersions", + "file": "tpu_v2alpha1_generated_tpu_list_runtime_versions_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_ListRuntimeVersions_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_list_runtime_versions_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuClient.list_runtime_versions", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.ListRuntimeVersions", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "ListRuntimeVersions" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.ListRuntimeVersionsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.tpu_v2alpha1.services.tpu.pagers.ListRuntimeVersionsPager", + "shortName": "list_runtime_versions" + }, + "description": "Sample for ListRuntimeVersions", + "file": "tpu_v2alpha1_generated_tpu_list_runtime_versions_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_ListRuntimeVersions_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_list_runtime_versions_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient.simulate_maintenance_event", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.SimulateMaintenanceEvent", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "SimulateMaintenanceEvent" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.SimulateMaintenanceEventRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "simulate_maintenance_event" + }, + "description": "Sample for SimulateMaintenanceEvent", + "file": "tpu_v2alpha1_generated_tpu_simulate_maintenance_event_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_SimulateMaintenanceEvent_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_simulate_maintenance_event_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuClient.simulate_maintenance_event", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.SimulateMaintenanceEvent", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "SimulateMaintenanceEvent" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.SimulateMaintenanceEventRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "simulate_maintenance_event" + }, + "description": "Sample for SimulateMaintenanceEvent", + "file": "tpu_v2alpha1_generated_tpu_simulate_maintenance_event_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_SimulateMaintenanceEvent_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_simulate_maintenance_event_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient.start_node", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.StartNode", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "StartNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.StartNodeRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "start_node" + }, + "description": "Sample for StartNode", + "file": "tpu_v2alpha1_generated_tpu_start_node_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_StartNode_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_start_node_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuClient.start_node", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.StartNode", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "StartNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.StartNodeRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "start_node" + }, + "description": "Sample for StartNode", + "file": "tpu_v2alpha1_generated_tpu_start_node_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_StartNode_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_start_node_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient.stop_node", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.StopNode", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "StopNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.StopNodeRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "stop_node" + }, + "description": "Sample for StopNode", + "file": "tpu_v2alpha1_generated_tpu_stop_node_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_StopNode_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_stop_node_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuClient.stop_node", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.StopNode", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "StopNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.StopNodeRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "stop_node" + }, + "description": "Sample for StopNode", + "file": "tpu_v2alpha1_generated_tpu_stop_node_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_StopNode_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_stop_node_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient", + "shortName": "TpuAsyncClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuAsyncClient.update_node", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.UpdateNode", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "UpdateNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.UpdateNodeRequest" + }, + { + "name": "node", + "type": "google.cloud.tpu_v2alpha1.types.Node" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "update_node" + }, + "description": "Sample for UpdateNode", + "file": "tpu_v2alpha1_generated_tpu_update_node_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_UpdateNode_async", + "segments": [ + { + "end": 58, + "start": 27, + "type": "FULL" + }, + { + "end": 58, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 48, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 55, + "start": 49, + "type": "REQUEST_EXECUTION" + }, + { + "end": 59, + "start": 56, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_update_node_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.tpu_v2alpha1.TpuClient", + "shortName": "TpuClient" + }, + "fullName": "google.cloud.tpu_v2alpha1.TpuClient.update_node", + "method": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu.UpdateNode", + "service": { + "fullName": "google.cloud.tpu.v2alpha1.Tpu", + "shortName": "Tpu" + }, + "shortName": "UpdateNode" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.tpu_v2alpha1.types.UpdateNodeRequest" + }, + { + "name": "node", + "type": "google.cloud.tpu_v2alpha1.types.Node" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "update_node" + }, + "description": "Sample for UpdateNode", + "file": "tpu_v2alpha1_generated_tpu_update_node_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "tpu_v2alpha1_generated_Tpu_UpdateNode_sync", + "segments": [ + { + "end": 58, + "start": 27, + "type": "FULL" + }, + { + "end": 58, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 48, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 55, + "start": 49, + "type": "REQUEST_EXECUTION" + }, + { + "end": 59, + "start": 56, + "type": "RESPONSE_HANDLING" + } + ], + "title": "tpu_v2alpha1_generated_tpu_update_node_sync.py" + } + ] +} diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_create_node_async.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_create_node_async.py new file mode 100644 index 0000000..9662d1e --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_create_node_async.py @@ -0,0 +1,60 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreateNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_CreateNode_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +async def sample_create_node(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + node = tpu_v2alpha1.Node() + node.runtime_version = "runtime_version_value" + + request = tpu_v2alpha1.CreateNodeRequest( + parent="parent_value", + node=node, + ) + + # Make the request + operation = client.create_node(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END tpu_v2alpha1_generated_Tpu_CreateNode_async] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_create_node_sync.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_create_node_sync.py new file mode 100644 index 0000000..263d857 --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_create_node_sync.py @@ -0,0 +1,60 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreateNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_CreateNode_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +def sample_create_node(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + node = tpu_v2alpha1.Node() + node.runtime_version = "runtime_version_value" + + request = tpu_v2alpha1.CreateNodeRequest( + parent="parent_value", + node=node, + ) + + # Make the request + operation = client.create_node(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END tpu_v2alpha1_generated_Tpu_CreateNode_sync] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_create_queued_resource_async.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_create_queued_resource_async.py new file mode 100644 index 0000000..632b17e --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_create_queued_resource_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreateQueuedResource +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_CreateQueuedResource_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +async def sample_create_queued_resource(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.CreateQueuedResourceRequest( + parent="parent_value", + ) + + # Make the request + operation = client.create_queued_resource(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END tpu_v2alpha1_generated_Tpu_CreateQueuedResource_async] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_create_queued_resource_sync.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_create_queued_resource_sync.py new file mode 100644 index 0000000..04e3809 --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_create_queued_resource_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreateQueuedResource +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_CreateQueuedResource_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +def sample_create_queued_resource(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.CreateQueuedResourceRequest( + parent="parent_value", + ) + + # Make the request + operation = client.create_queued_resource(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END tpu_v2alpha1_generated_Tpu_CreateQueuedResource_sync] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_delete_node_async.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_delete_node_async.py new file mode 100644 index 0000000..22b160a --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_delete_node_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_DeleteNode_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +async def sample_delete_node(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.DeleteNodeRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_node(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END tpu_v2alpha1_generated_Tpu_DeleteNode_async] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_delete_node_sync.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_delete_node_sync.py new file mode 100644 index 0000000..0442c52 --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_delete_node_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_DeleteNode_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +def sample_delete_node(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.DeleteNodeRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_node(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END tpu_v2alpha1_generated_Tpu_DeleteNode_sync] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_delete_queued_resource_async.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_delete_queued_resource_async.py new file mode 100644 index 0000000..7093245 --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_delete_queued_resource_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteQueuedResource +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_DeleteQueuedResource_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +async def sample_delete_queued_resource(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.DeleteQueuedResourceRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_queued_resource(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END tpu_v2alpha1_generated_Tpu_DeleteQueuedResource_async] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_delete_queued_resource_sync.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_delete_queued_resource_sync.py new file mode 100644 index 0000000..0d3fbad --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_delete_queued_resource_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteQueuedResource +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_DeleteQueuedResource_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +def sample_delete_queued_resource(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.DeleteQueuedResourceRequest( + name="name_value", + ) + + # Make the request + operation = client.delete_queued_resource(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END tpu_v2alpha1_generated_Tpu_DeleteQueuedResource_sync] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_generate_service_identity_async.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_generate_service_identity_async.py new file mode 100644 index 0000000..43487a3 --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_generate_service_identity_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GenerateServiceIdentity +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_GenerateServiceIdentity_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +async def sample_generate_service_identity(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.GenerateServiceIdentityRequest( + parent="parent_value", + ) + + # Make the request + response = await client.generate_service_identity(request=request) + + # Handle the response + print(response) + +# [END tpu_v2alpha1_generated_Tpu_GenerateServiceIdentity_async] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_generate_service_identity_sync.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_generate_service_identity_sync.py new file mode 100644 index 0000000..35d9e14 --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_generate_service_identity_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GenerateServiceIdentity +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_GenerateServiceIdentity_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +def sample_generate_service_identity(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.GenerateServiceIdentityRequest( + parent="parent_value", + ) + + # Make the request + response = client.generate_service_identity(request=request) + + # Handle the response + print(response) + +# [END tpu_v2alpha1_generated_Tpu_GenerateServiceIdentity_sync] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_accelerator_type_async.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_accelerator_type_async.py new file mode 100644 index 0000000..e749945 --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_accelerator_type_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetAcceleratorType +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_GetAcceleratorType_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +async def sample_get_accelerator_type(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.GetAcceleratorTypeRequest( + name="name_value", + ) + + # Make the request + response = await client.get_accelerator_type(request=request) + + # Handle the response + print(response) + +# [END tpu_v2alpha1_generated_Tpu_GetAcceleratorType_async] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_accelerator_type_sync.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_accelerator_type_sync.py new file mode 100644 index 0000000..36505a9 --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_accelerator_type_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetAcceleratorType +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_GetAcceleratorType_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +def sample_get_accelerator_type(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.GetAcceleratorTypeRequest( + name="name_value", + ) + + # Make the request + response = client.get_accelerator_type(request=request) + + # Handle the response + print(response) + +# [END tpu_v2alpha1_generated_Tpu_GetAcceleratorType_sync] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_guest_attributes_async.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_guest_attributes_async.py new file mode 100644 index 0000000..25bdf2b --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_guest_attributes_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetGuestAttributes +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_GetGuestAttributes_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +async def sample_get_guest_attributes(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.GetGuestAttributesRequest( + name="name_value", + ) + + # Make the request + response = await client.get_guest_attributes(request=request) + + # Handle the response + print(response) + +# [END tpu_v2alpha1_generated_Tpu_GetGuestAttributes_async] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_guest_attributes_sync.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_guest_attributes_sync.py new file mode 100644 index 0000000..6ed032c --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_guest_attributes_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetGuestAttributes +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_GetGuestAttributes_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +def sample_get_guest_attributes(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.GetGuestAttributesRequest( + name="name_value", + ) + + # Make the request + response = client.get_guest_attributes(request=request) + + # Handle the response + print(response) + +# [END tpu_v2alpha1_generated_Tpu_GetGuestAttributes_sync] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_node_async.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_node_async.py new file mode 100644 index 0000000..3f13f32 --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_node_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_GetNode_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +async def sample_get_node(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.GetNodeRequest( + name="name_value", + ) + + # Make the request + response = await client.get_node(request=request) + + # Handle the response + print(response) + +# [END tpu_v2alpha1_generated_Tpu_GetNode_async] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_node_sync.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_node_sync.py new file mode 100644 index 0000000..c5a09b9 --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_node_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_GetNode_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +def sample_get_node(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.GetNodeRequest( + name="name_value", + ) + + # Make the request + response = client.get_node(request=request) + + # Handle the response + print(response) + +# [END tpu_v2alpha1_generated_Tpu_GetNode_sync] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_queued_resource_async.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_queued_resource_async.py new file mode 100644 index 0000000..d808fdd --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_queued_resource_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetQueuedResource +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_GetQueuedResource_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +async def sample_get_queued_resource(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.GetQueuedResourceRequest( + name="name_value", + ) + + # Make the request + response = await client.get_queued_resource(request=request) + + # Handle the response + print(response) + +# [END tpu_v2alpha1_generated_Tpu_GetQueuedResource_async] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_queued_resource_sync.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_queued_resource_sync.py new file mode 100644 index 0000000..336289a --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_queued_resource_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetQueuedResource +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_GetQueuedResource_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +def sample_get_queued_resource(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.GetQueuedResourceRequest( + name="name_value", + ) + + # Make the request + response = client.get_queued_resource(request=request) + + # Handle the response + print(response) + +# [END tpu_v2alpha1_generated_Tpu_GetQueuedResource_sync] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_runtime_version_async.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_runtime_version_async.py new file mode 100644 index 0000000..b019058 --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_runtime_version_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetRuntimeVersion +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_GetRuntimeVersion_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +async def sample_get_runtime_version(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.GetRuntimeVersionRequest( + name="name_value", + ) + + # Make the request + response = await client.get_runtime_version(request=request) + + # Handle the response + print(response) + +# [END tpu_v2alpha1_generated_Tpu_GetRuntimeVersion_async] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_runtime_version_sync.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_runtime_version_sync.py new file mode 100644 index 0000000..3b27cff --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_get_runtime_version_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetRuntimeVersion +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_GetRuntimeVersion_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +def sample_get_runtime_version(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.GetRuntimeVersionRequest( + name="name_value", + ) + + # Make the request + response = client.get_runtime_version(request=request) + + # Handle the response + print(response) + +# [END tpu_v2alpha1_generated_Tpu_GetRuntimeVersion_sync] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_list_accelerator_types_async.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_list_accelerator_types_async.py new file mode 100644 index 0000000..15bce5a --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_list_accelerator_types_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListAcceleratorTypes +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_ListAcceleratorTypes_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +async def sample_list_accelerator_types(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.ListAcceleratorTypesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_accelerator_types(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END tpu_v2alpha1_generated_Tpu_ListAcceleratorTypes_async] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_list_accelerator_types_sync.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_list_accelerator_types_sync.py new file mode 100644 index 0000000..7ece285 --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_list_accelerator_types_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListAcceleratorTypes +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_ListAcceleratorTypes_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +def sample_list_accelerator_types(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.ListAcceleratorTypesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_accelerator_types(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END tpu_v2alpha1_generated_Tpu_ListAcceleratorTypes_sync] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_list_nodes_async.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_list_nodes_async.py new file mode 100644 index 0000000..3810458 --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_list_nodes_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListNodes +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_ListNodes_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +async def sample_list_nodes(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.ListNodesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_nodes(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END tpu_v2alpha1_generated_Tpu_ListNodes_async] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_list_nodes_sync.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_list_nodes_sync.py new file mode 100644 index 0000000..7c1720f --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_list_nodes_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListNodes +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_ListNodes_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +def sample_list_nodes(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.ListNodesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_nodes(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END tpu_v2alpha1_generated_Tpu_ListNodes_sync] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_list_queued_resources_async.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_list_queued_resources_async.py new file mode 100644 index 0000000..94714d5 --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_list_queued_resources_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListQueuedResources +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_ListQueuedResources_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +async def sample_list_queued_resources(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.ListQueuedResourcesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_queued_resources(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END tpu_v2alpha1_generated_Tpu_ListQueuedResources_async] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_list_queued_resources_sync.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_list_queued_resources_sync.py new file mode 100644 index 0000000..ec651b7 --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_list_queued_resources_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListQueuedResources +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_ListQueuedResources_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +def sample_list_queued_resources(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.ListQueuedResourcesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_queued_resources(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END tpu_v2alpha1_generated_Tpu_ListQueuedResources_sync] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_list_runtime_versions_async.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_list_runtime_versions_async.py new file mode 100644 index 0000000..86aa8af --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_list_runtime_versions_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListRuntimeVersions +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_ListRuntimeVersions_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +async def sample_list_runtime_versions(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.ListRuntimeVersionsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_runtime_versions(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END tpu_v2alpha1_generated_Tpu_ListRuntimeVersions_async] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_list_runtime_versions_sync.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_list_runtime_versions_sync.py new file mode 100644 index 0000000..f577175 --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_list_runtime_versions_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListRuntimeVersions +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_ListRuntimeVersions_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +def sample_list_runtime_versions(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.ListRuntimeVersionsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_runtime_versions(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END tpu_v2alpha1_generated_Tpu_ListRuntimeVersions_sync] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_simulate_maintenance_event_async.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_simulate_maintenance_event_async.py new file mode 100644 index 0000000..4a871de --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_simulate_maintenance_event_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for SimulateMaintenanceEvent +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_SimulateMaintenanceEvent_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +async def sample_simulate_maintenance_event(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.SimulateMaintenanceEventRequest( + name="name_value", + ) + + # Make the request + operation = client.simulate_maintenance_event(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END tpu_v2alpha1_generated_Tpu_SimulateMaintenanceEvent_async] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_simulate_maintenance_event_sync.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_simulate_maintenance_event_sync.py new file mode 100644 index 0000000..1766b1b --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_simulate_maintenance_event_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for SimulateMaintenanceEvent +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_SimulateMaintenanceEvent_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +def sample_simulate_maintenance_event(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.SimulateMaintenanceEventRequest( + name="name_value", + ) + + # Make the request + operation = client.simulate_maintenance_event(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END tpu_v2alpha1_generated_Tpu_SimulateMaintenanceEvent_sync] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_start_node_async.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_start_node_async.py new file mode 100644 index 0000000..7cfb4ab --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_start_node_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for StartNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_StartNode_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +async def sample_start_node(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.StartNodeRequest( + name="name_value", + ) + + # Make the request + operation = client.start_node(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END tpu_v2alpha1_generated_Tpu_StartNode_async] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_start_node_sync.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_start_node_sync.py new file mode 100644 index 0000000..b5f522c --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_start_node_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for StartNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_StartNode_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +def sample_start_node(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.StartNodeRequest( + name="name_value", + ) + + # Make the request + operation = client.start_node(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END tpu_v2alpha1_generated_Tpu_StartNode_sync] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_stop_node_async.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_stop_node_async.py new file mode 100644 index 0000000..7be2a42 --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_stop_node_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for StopNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_StopNode_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +async def sample_stop_node(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.StopNodeRequest( + name="name_value", + ) + + # Make the request + operation = client.stop_node(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END tpu_v2alpha1_generated_Tpu_StopNode_async] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_stop_node_sync.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_stop_node_sync.py new file mode 100644 index 0000000..f4fa672 --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_stop_node_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for StopNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_StopNode_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +def sample_stop_node(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + request = tpu_v2alpha1.StopNodeRequest( + name="name_value", + ) + + # Make the request + operation = client.stop_node(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END tpu_v2alpha1_generated_Tpu_StopNode_sync] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_update_node_async.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_update_node_async.py new file mode 100644 index 0000000..e13ec3b --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_update_node_async.py @@ -0,0 +1,59 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_UpdateNode_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +async def sample_update_node(): + # Create a client + client = tpu_v2alpha1.TpuAsyncClient() + + # Initialize request argument(s) + node = tpu_v2alpha1.Node() + node.runtime_version = "runtime_version_value" + + request = tpu_v2alpha1.UpdateNodeRequest( + node=node, + ) + + # Make the request + operation = client.update_node(request=request) + + print("Waiting for operation to complete...") + + response = (await operation).result() + + # Handle the response + print(response) + +# [END tpu_v2alpha1_generated_Tpu_UpdateNode_async] diff --git a/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_update_node_sync.py b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_update_node_sync.py new file mode 100644 index 0000000..073e8d8 --- /dev/null +++ b/owl-bot-staging/v2alpha1/samples/generated_samples/tpu_v2alpha1_generated_tpu_update_node_sync.py @@ -0,0 +1,59 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateNode +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-tpu + + +# [START tpu_v2alpha1_generated_Tpu_UpdateNode_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import tpu_v2alpha1 + + +def sample_update_node(): + # Create a client + client = tpu_v2alpha1.TpuClient() + + # Initialize request argument(s) + node = tpu_v2alpha1.Node() + node.runtime_version = "runtime_version_value" + + request = tpu_v2alpha1.UpdateNodeRequest( + node=node, + ) + + # Make the request + operation = client.update_node(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END tpu_v2alpha1_generated_Tpu_UpdateNode_sync] diff --git a/owl-bot-staging/v2alpha1/scripts/fixup_tpu_v2alpha1_keywords.py b/owl-bot-staging/v2alpha1/scripts/fixup_tpu_v2alpha1_keywords.py new file mode 100644 index 0000000..7f9a7b8 --- /dev/null +++ b/owl-bot-staging/v2alpha1/scripts/fixup_tpu_v2alpha1_keywords.py @@ -0,0 +1,193 @@ +#! /usr/bin/env python3 +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import argparse +import os +import libcst as cst +import pathlib +import sys +from typing import (Any, Callable, Dict, List, Sequence, Tuple) + + +def partition( + predicate: Callable[[Any], bool], + iterator: Sequence[Any] +) -> Tuple[List[Any], List[Any]]: + """A stable, out-of-place partition.""" + results = ([], []) + + for i in iterator: + results[int(predicate(i))].append(i) + + # Returns trueList, falseList + return results[1], results[0] + + +class tpuCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'create_node': ('parent', 'node', 'node_id', 'request_id', ), + 'create_queued_resource': ('parent', 'queued_resource', 'queued_resource_id', 'request_id', ), + 'delete_node': ('name', 'request_id', ), + 'delete_queued_resource': ('name', 'request_id', 'force', ), + 'generate_service_identity': ('parent', ), + 'get_accelerator_type': ('name', ), + 'get_guest_attributes': ('name', 'query_path', 'worker_ids', ), + 'get_node': ('name', ), + 'get_queued_resource': ('name', ), + 'get_runtime_version': ('name', ), + 'list_accelerator_types': ('parent', 'page_size', 'page_token', 'filter', 'order_by', ), + 'list_nodes': ('parent', 'page_size', 'page_token', ), + 'list_queued_resources': ('parent', 'page_size', 'page_token', ), + 'list_runtime_versions': ('parent', 'page_size', 'page_token', 'filter', 'order_by', ), + 'simulate_maintenance_event': ('name', 'worker_ids', ), + 'start_node': ('name', ), + 'stop_node': ('name', ), + 'update_node': ('update_mask', 'node', ), + } + + def leave_Call(self, original: cst.Call, updated: cst.Call) -> cst.CSTNode: + try: + key = original.func.attr.value + kword_params = self.METHOD_TO_PARAMS[key] + except (AttributeError, KeyError): + # Either not a method from the API or too convoluted to be sure. + return updated + + # If the existing code is valid, keyword args come after positional args. + # Therefore, all positional args must map to the first parameters. + args, kwargs = partition(lambda a: not bool(a.keyword), updated.args) + if any(k.keyword.value == "request" for k in kwargs): + # We've already fixed this file, don't fix it again. + return updated + + kwargs, ctrl_kwargs = partition( + lambda a: a.keyword.value not in self.CTRL_PARAMS, + kwargs + ) + + args, ctrl_args = args[:len(kword_params)], args[len(kword_params):] + ctrl_kwargs.extend(cst.Arg(value=a.value, keyword=cst.Name(value=ctrl)) + for a, ctrl in zip(ctrl_args, self.CTRL_PARAMS)) + + request_arg = cst.Arg( + value=cst.Dict([ + cst.DictElement( + cst.SimpleString("'{}'".format(name)), +cst.Element(value=arg.value) + ) + # Note: the args + kwargs looks silly, but keep in mind that + # the control parameters had to be stripped out, and that + # those could have been passed positionally or by keyword. + for name, arg in zip(kword_params, args + kwargs)]), + keyword=cst.Name("request") + ) + + return updated.with_changes( + args=[request_arg] + ctrl_kwargs + ) + + +def fix_files( + in_dir: pathlib.Path, + out_dir: pathlib.Path, + *, + transformer=tpuCallTransformer(), +): + """Duplicate the input dir to the output dir, fixing file method calls. + + Preconditions: + * in_dir is a real directory + * out_dir is a real, empty directory + """ + pyfile_gen = ( + pathlib.Path(os.path.join(root, f)) + for root, _, files in os.walk(in_dir) + for f in files if os.path.splitext(f)[1] == ".py" + ) + + for fpath in pyfile_gen: + with open(fpath, 'r') as f: + src = f.read() + + # Parse the code and insert method call fixes. + tree = cst.parse_module(src) + updated = tree.visit(transformer) + + # Create the path and directory structure for the new file. + updated_path = out_dir.joinpath(fpath.relative_to(in_dir)) + updated_path.parent.mkdir(parents=True, exist_ok=True) + + # Generate the updated source file at the corresponding path. + with open(updated_path, 'w') as f: + f.write(updated.code) + + +if __name__ == '__main__': + parser = argparse.ArgumentParser( + description="""Fix up source that uses the tpu client library. + +The existing sources are NOT overwritten but are copied to output_dir with changes made. + +Note: This tool operates at a best-effort level at converting positional + parameters in client method calls to keyword based parameters. + Cases where it WILL FAIL include + A) * or ** expansion in a method call. + B) Calls via function or method alias (includes free function calls) + C) Indirect or dispatched calls (e.g. the method is looked up dynamically) + + These all constitute false negatives. The tool will also detect false + positives when an API method shares a name with another method. +""") + parser.add_argument( + '-d', + '--input-directory', + required=True, + dest='input_dir', + help='the input directory to walk for python files to fix up', + ) + parser.add_argument( + '-o', + '--output-directory', + required=True, + dest='output_dir', + help='the directory to output files fixed via un-flattening', + ) + args = parser.parse_args() + input_dir = pathlib.Path(args.input_dir) + output_dir = pathlib.Path(args.output_dir) + if not input_dir.is_dir(): + print( + f"input directory '{input_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if not output_dir.is_dir(): + print( + f"output directory '{output_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if os.listdir(output_dir): + print( + f"output directory '{output_dir}' is not empty", + file=sys.stderr, + ) + sys.exit(-1) + + fix_files(input_dir, output_dir) diff --git a/owl-bot-staging/v2alpha1/setup.py b/owl-bot-staging/v2alpha1/setup.py new file mode 100644 index 0000000..47305e6 --- /dev/null +++ b/owl-bot-staging/v2alpha1/setup.py @@ -0,0 +1,90 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import io +import os + +import setuptools # type: ignore + +package_root = os.path.abspath(os.path.dirname(__file__)) + +name = 'google-cloud-tpu' + + +description = "Google Cloud Tpu API client library" + +version = {} +with open(os.path.join(package_root, 'google/cloud/tpu/gapic_version.py')) as fp: + exec(fp.read(), version) +version = version["__version__"] + +if version[0] == "0": + release_status = "Development Status :: 4 - Beta" +else: + release_status = "Development Status :: 5 - Production/Stable" + +dependencies = [ + "google-api-core[grpc] >= 1.34.0, <3.0.0dev,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*", + "proto-plus >= 1.22.0, <2.0.0dev", + "proto-plus >= 1.22.2, <2.0.0dev; python_version>='3.11'", + "protobuf>=3.19.5,<5.0.0dev,!=3.20.0,!=3.20.1,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", +] +url = "https://github.com/googleapis/python-tpu" + +package_root = os.path.abspath(os.path.dirname(__file__)) + +readme_filename = os.path.join(package_root, "README.rst") +with io.open(readme_filename, encoding="utf-8") as readme_file: + readme = readme_file.read() + +packages = [ + package + for package in setuptools.PEP420PackageFinder.find() + if package.startswith("google") +] + +namespaces = ["google", "google.cloud"] + +setuptools.setup( + name=name, + version=version, + description=description, + long_description=readme, + author="Google LLC", + author_email="googleapis-packages@google.com", + license="Apache 2.0", + url=url, + classifiers=[ + release_status, + "Intended Audience :: Developers", + "License :: OSI Approved :: Apache Software License", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Operating System :: OS Independent", + "Topic :: Internet", + ], + platforms="Posix; MacOS X; Windows", + packages=packages, + python_requires=">=3.7", + namespace_packages=namespaces, + install_requires=dependencies, + include_package_data=True, + zip_safe=False, +) diff --git a/owl-bot-staging/v2alpha1/testing/constraints-3.10.txt b/owl-bot-staging/v2alpha1/testing/constraints-3.10.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2alpha1/testing/constraints-3.10.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2alpha1/testing/constraints-3.11.txt b/owl-bot-staging/v2alpha1/testing/constraints-3.11.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2alpha1/testing/constraints-3.11.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2alpha1/testing/constraints-3.12.txt b/owl-bot-staging/v2alpha1/testing/constraints-3.12.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2alpha1/testing/constraints-3.12.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2alpha1/testing/constraints-3.7.txt b/owl-bot-staging/v2alpha1/testing/constraints-3.7.txt new file mode 100644 index 0000000..6c44adf --- /dev/null +++ b/owl-bot-staging/v2alpha1/testing/constraints-3.7.txt @@ -0,0 +1,9 @@ +# This constraints file is used to check that lower bounds +# are correct in setup.py +# List all library dependencies and extras in this file. +# Pin the version to the lower bound. +# e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0dev", +# Then this file should have google-cloud-foo==1.14.0 +google-api-core==1.34.0 +proto-plus==1.22.0 +protobuf==3.19.5 diff --git a/owl-bot-staging/v2alpha1/testing/constraints-3.8.txt b/owl-bot-staging/v2alpha1/testing/constraints-3.8.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2alpha1/testing/constraints-3.8.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2alpha1/testing/constraints-3.9.txt b/owl-bot-staging/v2alpha1/testing/constraints-3.9.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2alpha1/testing/constraints-3.9.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2alpha1/tests/__init__.py b/owl-bot-staging/v2alpha1/tests/__init__.py new file mode 100644 index 0000000..231bc12 --- /dev/null +++ b/owl-bot-staging/v2alpha1/tests/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v2alpha1/tests/unit/__init__.py b/owl-bot-staging/v2alpha1/tests/unit/__init__.py new file mode 100644 index 0000000..231bc12 --- /dev/null +++ b/owl-bot-staging/v2alpha1/tests/unit/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v2alpha1/tests/unit/gapic/__init__.py b/owl-bot-staging/v2alpha1/tests/unit/gapic/__init__.py new file mode 100644 index 0000000..231bc12 --- /dev/null +++ b/owl-bot-staging/v2alpha1/tests/unit/gapic/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v2alpha1/tests/unit/gapic/tpu_v2alpha1/__init__.py b/owl-bot-staging/v2alpha1/tests/unit/gapic/tpu_v2alpha1/__init__.py new file mode 100644 index 0000000..231bc12 --- /dev/null +++ b/owl-bot-staging/v2alpha1/tests/unit/gapic/tpu_v2alpha1/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v2alpha1/tests/unit/gapic/tpu_v2alpha1/test_tpu.py b/owl-bot-staging/v2alpha1/tests/unit/gapic/tpu_v2alpha1/test_tpu.py new file mode 100644 index 0000000..549d8ab --- /dev/null +++ b/owl-bot-staging/v2alpha1/tests/unit/gapic/tpu_v2alpha1/test_tpu.py @@ -0,0 +1,6686 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +# try/except added for compatibility with python < 3.8 +try: + from unittest import mock + from unittest.mock import AsyncMock # pragma: NO COVER +except ImportError: # pragma: NO COVER + import mock + +import grpc +from grpc.experimental import aio +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule +from proto.marshal.rules import wrappers + +from google.api_core import client_options +from google.api_core import exceptions as core_exceptions +from google.api_core import future +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers +from google.api_core import grpc_helpers_async +from google.api_core import operation +from google.api_core import operation_async # type: ignore +from google.api_core import operations_v1 +from google.api_core import path_template +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.cloud.location import locations_pb2 +from google.cloud.tpu_v2alpha1.services.tpu import TpuAsyncClient +from google.cloud.tpu_v2alpha1.services.tpu import TpuClient +from google.cloud.tpu_v2alpha1.services.tpu import pagers +from google.cloud.tpu_v2alpha1.services.tpu import transports +from google.cloud.tpu_v2alpha1.types import cloud_tpu +from google.longrunning import operations_pb2 +from google.oauth2 import service_account +from google.protobuf import any_pb2 # type: ignore +from google.protobuf import duration_pb2 # type: ignore +from google.protobuf import empty_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from google.rpc import status_pb2 # type: ignore +from google.type import interval_pb2 # type: ignore +import google.auth + + +def client_cert_source_callback(): + return b"cert bytes", b"key bytes" + + +# If default endpoint is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint(client): + return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT + + +def test__get_default_mtls_endpoint(): + api_endpoint = "example.googleapis.com" + api_mtls_endpoint = "example.mtls.googleapis.com" + sandbox_endpoint = "example.sandbox.googleapis.com" + sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" + non_googleapi = "api.example.com" + + assert TpuClient._get_default_mtls_endpoint(None) is None + assert TpuClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + assert TpuClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint + assert TpuClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint + assert TpuClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint + assert TpuClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + + +@pytest.mark.parametrize("client_class,transport_name", [ + (TpuClient, "grpc"), + (TpuAsyncClient, "grpc_asyncio"), +]) +def test_tpu_client_from_service_account_info(client_class, transport_name): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: + factory.return_value = creds + info = {"valid": True} + client = client_class.from_service_account_info(info, transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'tpu.googleapis.com:443' + ) + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.TpuGrpcTransport, "grpc"), + (transports.TpuGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_tpu_client_service_account_always_use_jwt(transport_class, transport_name): + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=True) + use_jwt.assert_called_once_with(True) + + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=False) + use_jwt.assert_not_called() + + +@pytest.mark.parametrize("client_class,transport_name", [ + (TpuClient, "grpc"), + (TpuAsyncClient, "grpc_asyncio"), +]) +def test_tpu_client_from_service_account_file(client_class, transport_name): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: + factory.return_value = creds + client = client_class.from_service_account_file("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'tpu.googleapis.com:443' + ) + + +def test_tpu_client_get_transport_class(): + transport = TpuClient.get_transport_class() + available_transports = [ + transports.TpuGrpcTransport, + ] + assert transport in available_transports + + transport = TpuClient.get_transport_class("grpc") + assert transport == transports.TpuGrpcTransport + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (TpuClient, transports.TpuGrpcTransport, "grpc"), + (TpuAsyncClient, transports.TpuGrpcAsyncIOTransport, "grpc_asyncio"), +]) +@mock.patch.object(TpuClient, "DEFAULT_ENDPOINT", modify_default_endpoint(TpuClient)) +@mock.patch.object(TpuAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(TpuAsyncClient)) +def test_tpu_client_client_options(client_class, transport_class, transport_name): + # Check that if channel is provided we won't create a new one. + with mock.patch.object(TpuClient, 'get_transport_class') as gtc: + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ) + client = client_class(transport=transport) + gtc.assert_not_called() + + # Check that if channel is provided via str we will create a new one. + with mock.patch.object(TpuClient, 'get_transport_class') as gtc: + client = client_class(transport=transport_name) + gtc.assert_called() + + # Check the case api_endpoint is provided. + options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name, client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_MTLS_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError): + client = client_class(transport=transport_name) + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): + with pytest.raises(ValueError): + client = client_class(transport=transport_name) + + # Check the case quota_project_id is provided + options = client_options.ClientOptions(quota_project_id="octopus") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id="octopus", + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + # Check the case api_endpoint is provided + options = client_options.ClientOptions(api_audience="https://language.googleapis.com") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience="https://language.googleapis.com" + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ + (TpuClient, transports.TpuGrpcTransport, "grpc", "true"), + (TpuAsyncClient, transports.TpuGrpcAsyncIOTransport, "grpc_asyncio", "true"), + (TpuClient, transports.TpuGrpcTransport, "grpc", "false"), + (TpuAsyncClient, transports.TpuGrpcAsyncIOTransport, "grpc_asyncio", "false"), +]) +@mock.patch.object(TpuClient, "DEFAULT_ENDPOINT", modify_default_endpoint(TpuClient)) +@mock.patch.object(TpuAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(TpuAsyncClient)) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_tpu_client_mtls_env_auto(client_class, transport_class, transport_name, use_client_cert_env): + # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default + # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. + + # Check the case client_cert_source is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + options = client_options.ClientOptions(client_cert_source=client_cert_source_callback) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + + if use_client_cert_env == "false": + expected_client_cert_source = None + expected_host = client.DEFAULT_ENDPOINT + else: + expected_client_cert_source = client_cert_source_callback + expected_host = client.DEFAULT_MTLS_ENDPOINT + + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case ADC client cert is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): + if use_client_cert_env == "false": + expected_host = client.DEFAULT_ENDPOINT + expected_client_cert_source = None + else: + expected_host = client.DEFAULT_MTLS_ENDPOINT + expected_client_cert_source = client_cert_source_callback + + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case client_cert_source and ADC client cert are not provided. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize("client_class", [ + TpuClient, TpuAsyncClient +]) +@mock.patch.object(TpuClient, "DEFAULT_ENDPOINT", modify_default_endpoint(TpuClient)) +@mock.patch.object(TpuAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(TpuAsyncClient)) +def test_tpu_client_get_mtls_endpoint_and_cert_source(client_class): + mock_client_cert_source = mock.Mock() + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "true". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + mock_api_endpoint = "foo" + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + assert api_endpoint == mock_api_endpoint + assert cert_source == mock_client_cert_source + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "false". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + mock_client_cert_source = mock.Mock() + mock_api_endpoint = "foo" + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + assert api_endpoint == mock_api_endpoint + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert doesn't exist. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=False): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert exists. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=mock_client_cert_source): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source == mock_client_cert_source + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (TpuClient, transports.TpuGrpcTransport, "grpc"), + (TpuAsyncClient, transports.TpuGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_tpu_client_client_options_scopes(client_class, transport_class, transport_name): + # Check the case scopes are provided. + options = client_options.ClientOptions( + scopes=["1", "2"], + ) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=["1", "2"], + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ + (TpuClient, transports.TpuGrpcTransport, "grpc", grpc_helpers), + (TpuAsyncClient, transports.TpuGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), +]) +def test_tpu_client_client_options_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + +def test_tpu_client_client_options_from_dict(): + with mock.patch('google.cloud.tpu_v2alpha1.services.tpu.transports.TpuGrpcTransport.__init__') as grpc_transport: + grpc_transport.return_value = None + client = TpuClient( + client_options={'api_endpoint': 'squid.clam.whelk'} + ) + grpc_transport.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ + (TpuClient, transports.TpuGrpcTransport, "grpc", grpc_helpers), + (TpuAsyncClient, transports.TpuGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), +]) +def test_tpu_client_create_channel_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # test that the credentials from file are saved and used as the credentials. + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel" + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + file_creds = ga_credentials.AnonymousCredentials() + load_creds.return_value = (file_creds, None) + adc.return_value = (creds, None) + client = client_class(client_options=options, transport=transport_name) + create_channel.assert_called_with( + "tpu.googleapis.com:443", + credentials=file_creds, + credentials_file=None, + quota_project_id=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + scopes=None, + default_host="tpu.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.ListNodesRequest, + dict, +]) +def test_list_nodes(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_nodes), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.ListNodesResponse( + next_page_token='next_page_token_value', + unreachable=['unreachable_value'], + ) + response = client.list_nodes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.ListNodesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListNodesPager) + assert response.next_page_token == 'next_page_token_value' + assert response.unreachable == ['unreachable_value'] + + +def test_list_nodes_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_nodes), + '__call__') as call: + client.list_nodes() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.ListNodesRequest() + +@pytest.mark.asyncio +async def test_list_nodes_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.ListNodesRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_nodes), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.ListNodesResponse( + next_page_token='next_page_token_value', + unreachable=['unreachable_value'], + )) + response = await client.list_nodes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.ListNodesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListNodesAsyncPager) + assert response.next_page_token == 'next_page_token_value' + assert response.unreachable == ['unreachable_value'] + + +@pytest.mark.asyncio +async def test_list_nodes_async_from_dict(): + await test_list_nodes_async(request_type=dict) + + +def test_list_nodes_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.ListNodesRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_nodes), + '__call__') as call: + call.return_value = cloud_tpu.ListNodesResponse() + client.list_nodes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_list_nodes_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.ListNodesRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_nodes), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.ListNodesResponse()) + await client.list_nodes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +def test_list_nodes_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_nodes), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.ListNodesResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_nodes( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + + +def test_list_nodes_flattened_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_nodes( + cloud_tpu.ListNodesRequest(), + parent='parent_value', + ) + +@pytest.mark.asyncio +async def test_list_nodes_flattened_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_nodes), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.ListNodesResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.ListNodesResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_nodes( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_list_nodes_flattened_error_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_nodes( + cloud_tpu.ListNodesRequest(), + parent='parent_value', + ) + + +def test_list_nodes_pager(transport_name: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_nodes), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + cloud_tpu.Node(), + cloud_tpu.Node(), + ], + next_page_token='abc', + ), + cloud_tpu.ListNodesResponse( + nodes=[], + next_page_token='def', + ), + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + cloud_tpu.Node(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_nodes(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, cloud_tpu.Node) + for i in results) +def test_list_nodes_pages(transport_name: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_nodes), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + cloud_tpu.Node(), + cloud_tpu.Node(), + ], + next_page_token='abc', + ), + cloud_tpu.ListNodesResponse( + nodes=[], + next_page_token='def', + ), + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + cloud_tpu.Node(), + ], + ), + RuntimeError, + ) + pages = list(client.list_nodes(request={}).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.asyncio +async def test_list_nodes_async_pager(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_nodes), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + cloud_tpu.Node(), + cloud_tpu.Node(), + ], + next_page_token='abc', + ), + cloud_tpu.ListNodesResponse( + nodes=[], + next_page_token='def', + ), + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + cloud_tpu.Node(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_nodes(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, cloud_tpu.Node) + for i in responses) + + +@pytest.mark.asyncio +async def test_list_nodes_async_pages(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_nodes), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + cloud_tpu.Node(), + cloud_tpu.Node(), + ], + next_page_token='abc', + ), + cloud_tpu.ListNodesResponse( + nodes=[], + next_page_token='def', + ), + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListNodesResponse( + nodes=[ + cloud_tpu.Node(), + cloud_tpu.Node(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_nodes(request={})).pages: # pragma: no branch + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.GetNodeRequest, + dict, +]) +def test_get_node(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.Node( + name='name_value', + description='description_value', + accelerator_type='accelerator_type_value', + state=cloud_tpu.Node.State.CREATING, + health_description='health_description_value', + runtime_version='runtime_version_value', + cidr_block='cidr_block_value', + health=cloud_tpu.Node.Health.HEALTHY, + tags=['tags_value'], + id=205, + api_version=cloud_tpu.Node.ApiVersion.V1_ALPHA1, + queued_resource='queued_resource_value', + multislice_node=True, + ) + response = client.get_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_tpu.Node) + assert response.name == 'name_value' + assert response.description == 'description_value' + assert response.accelerator_type == 'accelerator_type_value' + assert response.state == cloud_tpu.Node.State.CREATING + assert response.health_description == 'health_description_value' + assert response.runtime_version == 'runtime_version_value' + assert response.cidr_block == 'cidr_block_value' + assert response.health == cloud_tpu.Node.Health.HEALTHY + assert response.tags == ['tags_value'] + assert response.id == 205 + assert response.api_version == cloud_tpu.Node.ApiVersion.V1_ALPHA1 + assert response.queued_resource == 'queued_resource_value' + assert response.multislice_node is True + + +def test_get_node_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_node), + '__call__') as call: + client.get_node() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetNodeRequest() + +@pytest.mark.asyncio +async def test_get_node_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.GetNodeRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.Node( + name='name_value', + description='description_value', + accelerator_type='accelerator_type_value', + state=cloud_tpu.Node.State.CREATING, + health_description='health_description_value', + runtime_version='runtime_version_value', + cidr_block='cidr_block_value', + health=cloud_tpu.Node.Health.HEALTHY, + tags=['tags_value'], + id=205, + api_version=cloud_tpu.Node.ApiVersion.V1_ALPHA1, + queued_resource='queued_resource_value', + multislice_node=True, + )) + response = await client.get_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_tpu.Node) + assert response.name == 'name_value' + assert response.description == 'description_value' + assert response.accelerator_type == 'accelerator_type_value' + assert response.state == cloud_tpu.Node.State.CREATING + assert response.health_description == 'health_description_value' + assert response.runtime_version == 'runtime_version_value' + assert response.cidr_block == 'cidr_block_value' + assert response.health == cloud_tpu.Node.Health.HEALTHY + assert response.tags == ['tags_value'] + assert response.id == 205 + assert response.api_version == cloud_tpu.Node.ApiVersion.V1_ALPHA1 + assert response.queued_resource == 'queued_resource_value' + assert response.multislice_node is True + + +@pytest.mark.asyncio +async def test_get_node_async_from_dict(): + await test_get_node_async(request_type=dict) + + +def test_get_node_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.GetNodeRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_node), + '__call__') as call: + call.return_value = cloud_tpu.Node() + client.get_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_get_node_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.GetNodeRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_node), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.Node()) + await client.get_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +def test_get_node_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.Node() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_node( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_get_node_flattened_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_node( + cloud_tpu.GetNodeRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_get_node_flattened_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.Node() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.Node()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_node( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_get_node_flattened_error_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_node( + cloud_tpu.GetNodeRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.CreateNodeRequest, + dict, +]) +def test_create_node(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.create_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.CreateNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_create_node_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_node), + '__call__') as call: + client.create_node() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.CreateNodeRequest() + +@pytest.mark.asyncio +async def test_create_node_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.CreateNodeRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.create_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.CreateNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_create_node_async_from_dict(): + await test_create_node_async(request_type=dict) + + +def test_create_node_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.CreateNodeRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_node), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.create_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_create_node_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.CreateNodeRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_node), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.create_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +def test_create_node_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_node( + parent='parent_value', + node=cloud_tpu.Node(name='name_value'), + node_id='node_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].node + mock_val = cloud_tpu.Node(name='name_value') + assert arg == mock_val + arg = args[0].node_id + mock_val = 'node_id_value' + assert arg == mock_val + + +def test_create_node_flattened_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_node( + cloud_tpu.CreateNodeRequest(), + parent='parent_value', + node=cloud_tpu.Node(name='name_value'), + node_id='node_id_value', + ) + +@pytest.mark.asyncio +async def test_create_node_flattened_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_node( + parent='parent_value', + node=cloud_tpu.Node(name='name_value'), + node_id='node_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].node + mock_val = cloud_tpu.Node(name='name_value') + assert arg == mock_val + arg = args[0].node_id + mock_val = 'node_id_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_create_node_flattened_error_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.create_node( + cloud_tpu.CreateNodeRequest(), + parent='parent_value', + node=cloud_tpu.Node(name='name_value'), + node_id='node_id_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.DeleteNodeRequest, + dict, +]) +def test_delete_node(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.delete_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.DeleteNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_delete_node_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_node), + '__call__') as call: + client.delete_node() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.DeleteNodeRequest() + +@pytest.mark.asyncio +async def test_delete_node_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.DeleteNodeRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.delete_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.DeleteNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_delete_node_async_from_dict(): + await test_delete_node_async(request_type=dict) + + +def test_delete_node_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.DeleteNodeRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_node), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.delete_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_delete_node_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.DeleteNodeRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_node), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.delete_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +def test_delete_node_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.delete_node( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_delete_node_flattened_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_node( + cloud_tpu.DeleteNodeRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_delete_node_flattened_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.delete_node( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_delete_node_flattened_error_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.delete_node( + cloud_tpu.DeleteNodeRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.StopNodeRequest, + dict, +]) +def test_stop_node(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.stop_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.stop_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.StopNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_stop_node_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.stop_node), + '__call__') as call: + client.stop_node() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.StopNodeRequest() + +@pytest.mark.asyncio +async def test_stop_node_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.StopNodeRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.stop_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.stop_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.StopNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_stop_node_async_from_dict(): + await test_stop_node_async(request_type=dict) + + +def test_stop_node_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.StopNodeRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.stop_node), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.stop_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_stop_node_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.StopNodeRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.stop_node), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.stop_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.StartNodeRequest, + dict, +]) +def test_start_node(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.start_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.start_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.StartNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_start_node_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.start_node), + '__call__') as call: + client.start_node() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.StartNodeRequest() + +@pytest.mark.asyncio +async def test_start_node_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.StartNodeRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.start_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.start_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.StartNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_start_node_async_from_dict(): + await test_start_node_async(request_type=dict) + + +def test_start_node_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.StartNodeRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.start_node), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.start_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_start_node_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.StartNodeRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.start_node), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.start_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.UpdateNodeRequest, + dict, +]) +def test_update_node(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.update_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.UpdateNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_update_node_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_node), + '__call__') as call: + client.update_node() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.UpdateNodeRequest() + +@pytest.mark.asyncio +async def test_update_node_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.UpdateNodeRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.update_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.UpdateNodeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_update_node_async_from_dict(): + await test_update_node_async(request_type=dict) + + +def test_update_node_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.UpdateNodeRequest() + + request.node.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_node), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.update_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'node.name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_node_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.UpdateNodeRequest() + + request.node.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_node), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.update_node(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'node.name=name_value', + ) in kw['metadata'] + + +def test_update_node_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_node( + node=cloud_tpu.Node(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].node + mock_val = cloud_tpu.Node(name='name_value') + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val + + +def test_update_node_flattened_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_node( + cloud_tpu.UpdateNodeRequest(), + node=cloud_tpu.Node(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + +@pytest.mark.asyncio +async def test_update_node_flattened_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_node), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_node( + node=cloud_tpu.Node(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].node + mock_val = cloud_tpu.Node(name='name_value') + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val + +@pytest.mark.asyncio +async def test_update_node_flattened_error_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.update_node( + cloud_tpu.UpdateNodeRequest(), + node=cloud_tpu.Node(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.ListQueuedResourcesRequest, + dict, +]) +def test_list_queued_resources(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_queued_resources), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.ListQueuedResourcesResponse( + next_page_token='next_page_token_value', + unreachable=['unreachable_value'], + ) + response = client.list_queued_resources(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.ListQueuedResourcesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListQueuedResourcesPager) + assert response.next_page_token == 'next_page_token_value' + assert response.unreachable == ['unreachable_value'] + + +def test_list_queued_resources_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_queued_resources), + '__call__') as call: + client.list_queued_resources() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.ListQueuedResourcesRequest() + +@pytest.mark.asyncio +async def test_list_queued_resources_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.ListQueuedResourcesRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_queued_resources), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.ListQueuedResourcesResponse( + next_page_token='next_page_token_value', + unreachable=['unreachable_value'], + )) + response = await client.list_queued_resources(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.ListQueuedResourcesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListQueuedResourcesAsyncPager) + assert response.next_page_token == 'next_page_token_value' + assert response.unreachable == ['unreachable_value'] + + +@pytest.mark.asyncio +async def test_list_queued_resources_async_from_dict(): + await test_list_queued_resources_async(request_type=dict) + + +def test_list_queued_resources_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.ListQueuedResourcesRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_queued_resources), + '__call__') as call: + call.return_value = cloud_tpu.ListQueuedResourcesResponse() + client.list_queued_resources(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_list_queued_resources_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.ListQueuedResourcesRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_queued_resources), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.ListQueuedResourcesResponse()) + await client.list_queued_resources(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +def test_list_queued_resources_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_queued_resources), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.ListQueuedResourcesResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_queued_resources( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + + +def test_list_queued_resources_flattened_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_queued_resources( + cloud_tpu.ListQueuedResourcesRequest(), + parent='parent_value', + ) + +@pytest.mark.asyncio +async def test_list_queued_resources_flattened_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_queued_resources), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.ListQueuedResourcesResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.ListQueuedResourcesResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_queued_resources( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_list_queued_resources_flattened_error_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_queued_resources( + cloud_tpu.ListQueuedResourcesRequest(), + parent='parent_value', + ) + + +def test_list_queued_resources_pager(transport_name: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_queued_resources), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListQueuedResourcesResponse( + queued_resources=[ + cloud_tpu.QueuedResource(), + cloud_tpu.QueuedResource(), + cloud_tpu.QueuedResource(), + ], + next_page_token='abc', + ), + cloud_tpu.ListQueuedResourcesResponse( + queued_resources=[], + next_page_token='def', + ), + cloud_tpu.ListQueuedResourcesResponse( + queued_resources=[ + cloud_tpu.QueuedResource(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListQueuedResourcesResponse( + queued_resources=[ + cloud_tpu.QueuedResource(), + cloud_tpu.QueuedResource(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_queued_resources(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, cloud_tpu.QueuedResource) + for i in results) +def test_list_queued_resources_pages(transport_name: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_queued_resources), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListQueuedResourcesResponse( + queued_resources=[ + cloud_tpu.QueuedResource(), + cloud_tpu.QueuedResource(), + cloud_tpu.QueuedResource(), + ], + next_page_token='abc', + ), + cloud_tpu.ListQueuedResourcesResponse( + queued_resources=[], + next_page_token='def', + ), + cloud_tpu.ListQueuedResourcesResponse( + queued_resources=[ + cloud_tpu.QueuedResource(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListQueuedResourcesResponse( + queued_resources=[ + cloud_tpu.QueuedResource(), + cloud_tpu.QueuedResource(), + ], + ), + RuntimeError, + ) + pages = list(client.list_queued_resources(request={}).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.asyncio +async def test_list_queued_resources_async_pager(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_queued_resources), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListQueuedResourcesResponse( + queued_resources=[ + cloud_tpu.QueuedResource(), + cloud_tpu.QueuedResource(), + cloud_tpu.QueuedResource(), + ], + next_page_token='abc', + ), + cloud_tpu.ListQueuedResourcesResponse( + queued_resources=[], + next_page_token='def', + ), + cloud_tpu.ListQueuedResourcesResponse( + queued_resources=[ + cloud_tpu.QueuedResource(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListQueuedResourcesResponse( + queued_resources=[ + cloud_tpu.QueuedResource(), + cloud_tpu.QueuedResource(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_queued_resources(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, cloud_tpu.QueuedResource) + for i in responses) + + +@pytest.mark.asyncio +async def test_list_queued_resources_async_pages(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_queued_resources), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListQueuedResourcesResponse( + queued_resources=[ + cloud_tpu.QueuedResource(), + cloud_tpu.QueuedResource(), + cloud_tpu.QueuedResource(), + ], + next_page_token='abc', + ), + cloud_tpu.ListQueuedResourcesResponse( + queued_resources=[], + next_page_token='def', + ), + cloud_tpu.ListQueuedResourcesResponse( + queued_resources=[ + cloud_tpu.QueuedResource(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListQueuedResourcesResponse( + queued_resources=[ + cloud_tpu.QueuedResource(), + cloud_tpu.QueuedResource(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_queued_resources(request={})).pages: # pragma: no branch + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.GetQueuedResourceRequest, + dict, +]) +def test_get_queued_resource(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_queued_resource), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.QueuedResource( + name='name_value', + reservation_name='reservation_name_value', + tpu=cloud_tpu.QueuedResource.Tpu(node_spec=[cloud_tpu.QueuedResource.Tpu.NodeSpec(parent='parent_value')]), + best_effort=None, + ) + response = client.get_queued_resource(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetQueuedResourceRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_tpu.QueuedResource) + assert response.name == 'name_value' + assert response.reservation_name == 'reservation_name_value' + + +def test_get_queued_resource_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_queued_resource), + '__call__') as call: + client.get_queued_resource() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetQueuedResourceRequest() + +@pytest.mark.asyncio +async def test_get_queued_resource_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.GetQueuedResourceRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_queued_resource), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.QueuedResource( + name='name_value', + reservation_name='reservation_name_value', + )) + response = await client.get_queued_resource(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetQueuedResourceRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_tpu.QueuedResource) + assert response.name == 'name_value' + assert response.reservation_name == 'reservation_name_value' + + +@pytest.mark.asyncio +async def test_get_queued_resource_async_from_dict(): + await test_get_queued_resource_async(request_type=dict) + + +def test_get_queued_resource_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.GetQueuedResourceRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_queued_resource), + '__call__') as call: + call.return_value = cloud_tpu.QueuedResource() + client.get_queued_resource(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_get_queued_resource_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.GetQueuedResourceRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_queued_resource), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.QueuedResource()) + await client.get_queued_resource(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +def test_get_queued_resource_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_queued_resource), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.QueuedResource() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_queued_resource( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_get_queued_resource_flattened_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_queued_resource( + cloud_tpu.GetQueuedResourceRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_get_queued_resource_flattened_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_queued_resource), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.QueuedResource() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.QueuedResource()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_queued_resource( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_get_queued_resource_flattened_error_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_queued_resource( + cloud_tpu.GetQueuedResourceRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.CreateQueuedResourceRequest, + dict, +]) +def test_create_queued_resource(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_queued_resource), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.create_queued_resource(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.CreateQueuedResourceRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_create_queued_resource_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_queued_resource), + '__call__') as call: + client.create_queued_resource() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.CreateQueuedResourceRequest() + +@pytest.mark.asyncio +async def test_create_queued_resource_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.CreateQueuedResourceRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_queued_resource), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.create_queued_resource(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.CreateQueuedResourceRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_create_queued_resource_async_from_dict(): + await test_create_queued_resource_async(request_type=dict) + + +def test_create_queued_resource_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.CreateQueuedResourceRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_queued_resource), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.create_queued_resource(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_create_queued_resource_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.CreateQueuedResourceRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_queued_resource), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.create_queued_resource(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +def test_create_queued_resource_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_queued_resource), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_queued_resource( + parent='parent_value', + queued_resource=cloud_tpu.QueuedResource(name='name_value'), + queued_resource_id='queued_resource_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].queued_resource + mock_val = cloud_tpu.QueuedResource(name='name_value') + assert arg == mock_val + arg = args[0].queued_resource_id + mock_val = 'queued_resource_id_value' + assert arg == mock_val + + +def test_create_queued_resource_flattened_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_queued_resource( + cloud_tpu.CreateQueuedResourceRequest(), + parent='parent_value', + queued_resource=cloud_tpu.QueuedResource(name='name_value'), + queued_resource_id='queued_resource_id_value', + ) + +@pytest.mark.asyncio +async def test_create_queued_resource_flattened_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_queued_resource), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_queued_resource( + parent='parent_value', + queued_resource=cloud_tpu.QueuedResource(name='name_value'), + queued_resource_id='queued_resource_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].queued_resource + mock_val = cloud_tpu.QueuedResource(name='name_value') + assert arg == mock_val + arg = args[0].queued_resource_id + mock_val = 'queued_resource_id_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_create_queued_resource_flattened_error_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.create_queued_resource( + cloud_tpu.CreateQueuedResourceRequest(), + parent='parent_value', + queued_resource=cloud_tpu.QueuedResource(name='name_value'), + queued_resource_id='queued_resource_id_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.DeleteQueuedResourceRequest, + dict, +]) +def test_delete_queued_resource(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_queued_resource), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.delete_queued_resource(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.DeleteQueuedResourceRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_delete_queued_resource_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_queued_resource), + '__call__') as call: + client.delete_queued_resource() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.DeleteQueuedResourceRequest() + +@pytest.mark.asyncio +async def test_delete_queued_resource_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.DeleteQueuedResourceRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_queued_resource), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.delete_queued_resource(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.DeleteQueuedResourceRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_delete_queued_resource_async_from_dict(): + await test_delete_queued_resource_async(request_type=dict) + + +def test_delete_queued_resource_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.DeleteQueuedResourceRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_queued_resource), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.delete_queued_resource(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_delete_queued_resource_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.DeleteQueuedResourceRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_queued_resource), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.delete_queued_resource(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +def test_delete_queued_resource_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_queued_resource), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.delete_queued_resource( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_delete_queued_resource_flattened_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_queued_resource( + cloud_tpu.DeleteQueuedResourceRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_delete_queued_resource_flattened_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_queued_resource), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/op') + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.delete_queued_resource( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_delete_queued_resource_flattened_error_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.delete_queued_resource( + cloud_tpu.DeleteQueuedResourceRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.GenerateServiceIdentityRequest, + dict, +]) +def test_generate_service_identity(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.generate_service_identity), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.GenerateServiceIdentityResponse( + ) + response = client.generate_service_identity(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GenerateServiceIdentityRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_tpu.GenerateServiceIdentityResponse) + + +def test_generate_service_identity_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.generate_service_identity), + '__call__') as call: + client.generate_service_identity() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GenerateServiceIdentityRequest() + +@pytest.mark.asyncio +async def test_generate_service_identity_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.GenerateServiceIdentityRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.generate_service_identity), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.GenerateServiceIdentityResponse( + )) + response = await client.generate_service_identity(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GenerateServiceIdentityRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_tpu.GenerateServiceIdentityResponse) + + +@pytest.mark.asyncio +async def test_generate_service_identity_async_from_dict(): + await test_generate_service_identity_async(request_type=dict) + + +def test_generate_service_identity_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.GenerateServiceIdentityRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.generate_service_identity), + '__call__') as call: + call.return_value = cloud_tpu.GenerateServiceIdentityResponse() + client.generate_service_identity(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_generate_service_identity_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.GenerateServiceIdentityRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.generate_service_identity), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.GenerateServiceIdentityResponse()) + await client.generate_service_identity(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.ListAcceleratorTypesRequest, + dict, +]) +def test_list_accelerator_types(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_accelerator_types), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.ListAcceleratorTypesResponse( + next_page_token='next_page_token_value', + unreachable=['unreachable_value'], + ) + response = client.list_accelerator_types(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.ListAcceleratorTypesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListAcceleratorTypesPager) + assert response.next_page_token == 'next_page_token_value' + assert response.unreachable == ['unreachable_value'] + + +def test_list_accelerator_types_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_accelerator_types), + '__call__') as call: + client.list_accelerator_types() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.ListAcceleratorTypesRequest() + +@pytest.mark.asyncio +async def test_list_accelerator_types_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.ListAcceleratorTypesRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_accelerator_types), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.ListAcceleratorTypesResponse( + next_page_token='next_page_token_value', + unreachable=['unreachable_value'], + )) + response = await client.list_accelerator_types(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.ListAcceleratorTypesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListAcceleratorTypesAsyncPager) + assert response.next_page_token == 'next_page_token_value' + assert response.unreachable == ['unreachable_value'] + + +@pytest.mark.asyncio +async def test_list_accelerator_types_async_from_dict(): + await test_list_accelerator_types_async(request_type=dict) + + +def test_list_accelerator_types_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.ListAcceleratorTypesRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_accelerator_types), + '__call__') as call: + call.return_value = cloud_tpu.ListAcceleratorTypesResponse() + client.list_accelerator_types(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_list_accelerator_types_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.ListAcceleratorTypesRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_accelerator_types), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.ListAcceleratorTypesResponse()) + await client.list_accelerator_types(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +def test_list_accelerator_types_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_accelerator_types), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.ListAcceleratorTypesResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_accelerator_types( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + + +def test_list_accelerator_types_flattened_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_accelerator_types( + cloud_tpu.ListAcceleratorTypesRequest(), + parent='parent_value', + ) + +@pytest.mark.asyncio +async def test_list_accelerator_types_flattened_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_accelerator_types), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.ListAcceleratorTypesResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.ListAcceleratorTypesResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_accelerator_types( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_list_accelerator_types_flattened_error_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_accelerator_types( + cloud_tpu.ListAcceleratorTypesRequest(), + parent='parent_value', + ) + + +def test_list_accelerator_types_pager(transport_name: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_accelerator_types), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + ], + next_page_token='abc', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[], + next_page_token='def', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_accelerator_types(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, cloud_tpu.AcceleratorType) + for i in results) +def test_list_accelerator_types_pages(transport_name: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_accelerator_types), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + ], + next_page_token='abc', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[], + next_page_token='def', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + ], + ), + RuntimeError, + ) + pages = list(client.list_accelerator_types(request={}).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.asyncio +async def test_list_accelerator_types_async_pager(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_accelerator_types), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + ], + next_page_token='abc', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[], + next_page_token='def', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_accelerator_types(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, cloud_tpu.AcceleratorType) + for i in responses) + + +@pytest.mark.asyncio +async def test_list_accelerator_types_async_pages(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_accelerator_types), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + ], + next_page_token='abc', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[], + next_page_token='def', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListAcceleratorTypesResponse( + accelerator_types=[ + cloud_tpu.AcceleratorType(), + cloud_tpu.AcceleratorType(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_accelerator_types(request={})).pages: # pragma: no branch + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.GetAcceleratorTypeRequest, + dict, +]) +def test_get_accelerator_type(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_accelerator_type), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.AcceleratorType( + name='name_value', + type_='type__value', + ) + response = client.get_accelerator_type(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetAcceleratorTypeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_tpu.AcceleratorType) + assert response.name == 'name_value' + assert response.type_ == 'type__value' + + +def test_get_accelerator_type_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_accelerator_type), + '__call__') as call: + client.get_accelerator_type() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetAcceleratorTypeRequest() + +@pytest.mark.asyncio +async def test_get_accelerator_type_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.GetAcceleratorTypeRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_accelerator_type), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.AcceleratorType( + name='name_value', + type_='type__value', + )) + response = await client.get_accelerator_type(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetAcceleratorTypeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_tpu.AcceleratorType) + assert response.name == 'name_value' + assert response.type_ == 'type__value' + + +@pytest.mark.asyncio +async def test_get_accelerator_type_async_from_dict(): + await test_get_accelerator_type_async(request_type=dict) + + +def test_get_accelerator_type_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.GetAcceleratorTypeRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_accelerator_type), + '__call__') as call: + call.return_value = cloud_tpu.AcceleratorType() + client.get_accelerator_type(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_get_accelerator_type_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.GetAcceleratorTypeRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_accelerator_type), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.AcceleratorType()) + await client.get_accelerator_type(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +def test_get_accelerator_type_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_accelerator_type), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.AcceleratorType() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_accelerator_type( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_get_accelerator_type_flattened_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_accelerator_type( + cloud_tpu.GetAcceleratorTypeRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_get_accelerator_type_flattened_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_accelerator_type), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.AcceleratorType() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.AcceleratorType()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_accelerator_type( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_get_accelerator_type_flattened_error_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_accelerator_type( + cloud_tpu.GetAcceleratorTypeRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.ListRuntimeVersionsRequest, + dict, +]) +def test_list_runtime_versions(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_runtime_versions), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.ListRuntimeVersionsResponse( + next_page_token='next_page_token_value', + unreachable=['unreachable_value'], + ) + response = client.list_runtime_versions(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.ListRuntimeVersionsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListRuntimeVersionsPager) + assert response.next_page_token == 'next_page_token_value' + assert response.unreachable == ['unreachable_value'] + + +def test_list_runtime_versions_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_runtime_versions), + '__call__') as call: + client.list_runtime_versions() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.ListRuntimeVersionsRequest() + +@pytest.mark.asyncio +async def test_list_runtime_versions_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.ListRuntimeVersionsRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_runtime_versions), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.ListRuntimeVersionsResponse( + next_page_token='next_page_token_value', + unreachable=['unreachable_value'], + )) + response = await client.list_runtime_versions(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.ListRuntimeVersionsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListRuntimeVersionsAsyncPager) + assert response.next_page_token == 'next_page_token_value' + assert response.unreachable == ['unreachable_value'] + + +@pytest.mark.asyncio +async def test_list_runtime_versions_async_from_dict(): + await test_list_runtime_versions_async(request_type=dict) + + +def test_list_runtime_versions_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.ListRuntimeVersionsRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_runtime_versions), + '__call__') as call: + call.return_value = cloud_tpu.ListRuntimeVersionsResponse() + client.list_runtime_versions(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_list_runtime_versions_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.ListRuntimeVersionsRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_runtime_versions), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.ListRuntimeVersionsResponse()) + await client.list_runtime_versions(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +def test_list_runtime_versions_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_runtime_versions), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.ListRuntimeVersionsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_runtime_versions( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + + +def test_list_runtime_versions_flattened_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_runtime_versions( + cloud_tpu.ListRuntimeVersionsRequest(), + parent='parent_value', + ) + +@pytest.mark.asyncio +async def test_list_runtime_versions_flattened_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_runtime_versions), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.ListRuntimeVersionsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.ListRuntimeVersionsResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_runtime_versions( + parent='parent_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_list_runtime_versions_flattened_error_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_runtime_versions( + cloud_tpu.ListRuntimeVersionsRequest(), + parent='parent_value', + ) + + +def test_list_runtime_versions_pager(transport_name: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_runtime_versions), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[ + cloud_tpu.RuntimeVersion(), + cloud_tpu.RuntimeVersion(), + cloud_tpu.RuntimeVersion(), + ], + next_page_token='abc', + ), + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[], + next_page_token='def', + ), + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[ + cloud_tpu.RuntimeVersion(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[ + cloud_tpu.RuntimeVersion(), + cloud_tpu.RuntimeVersion(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_runtime_versions(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, cloud_tpu.RuntimeVersion) + for i in results) +def test_list_runtime_versions_pages(transport_name: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_runtime_versions), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[ + cloud_tpu.RuntimeVersion(), + cloud_tpu.RuntimeVersion(), + cloud_tpu.RuntimeVersion(), + ], + next_page_token='abc', + ), + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[], + next_page_token='def', + ), + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[ + cloud_tpu.RuntimeVersion(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[ + cloud_tpu.RuntimeVersion(), + cloud_tpu.RuntimeVersion(), + ], + ), + RuntimeError, + ) + pages = list(client.list_runtime_versions(request={}).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.asyncio +async def test_list_runtime_versions_async_pager(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_runtime_versions), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[ + cloud_tpu.RuntimeVersion(), + cloud_tpu.RuntimeVersion(), + cloud_tpu.RuntimeVersion(), + ], + next_page_token='abc', + ), + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[], + next_page_token='def', + ), + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[ + cloud_tpu.RuntimeVersion(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[ + cloud_tpu.RuntimeVersion(), + cloud_tpu.RuntimeVersion(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_runtime_versions(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, cloud_tpu.RuntimeVersion) + for i in responses) + + +@pytest.mark.asyncio +async def test_list_runtime_versions_async_pages(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_runtime_versions), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[ + cloud_tpu.RuntimeVersion(), + cloud_tpu.RuntimeVersion(), + cloud_tpu.RuntimeVersion(), + ], + next_page_token='abc', + ), + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[], + next_page_token='def', + ), + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[ + cloud_tpu.RuntimeVersion(), + ], + next_page_token='ghi', + ), + cloud_tpu.ListRuntimeVersionsResponse( + runtime_versions=[ + cloud_tpu.RuntimeVersion(), + cloud_tpu.RuntimeVersion(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_runtime_versions(request={})).pages: # pragma: no branch + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.GetRuntimeVersionRequest, + dict, +]) +def test_get_runtime_version(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_runtime_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.RuntimeVersion( + name='name_value', + version='version_value', + ) + response = client.get_runtime_version(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetRuntimeVersionRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_tpu.RuntimeVersion) + assert response.name == 'name_value' + assert response.version == 'version_value' + + +def test_get_runtime_version_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_runtime_version), + '__call__') as call: + client.get_runtime_version() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetRuntimeVersionRequest() + +@pytest.mark.asyncio +async def test_get_runtime_version_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.GetRuntimeVersionRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_runtime_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.RuntimeVersion( + name='name_value', + version='version_value', + )) + response = await client.get_runtime_version(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetRuntimeVersionRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_tpu.RuntimeVersion) + assert response.name == 'name_value' + assert response.version == 'version_value' + + +@pytest.mark.asyncio +async def test_get_runtime_version_async_from_dict(): + await test_get_runtime_version_async(request_type=dict) + + +def test_get_runtime_version_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.GetRuntimeVersionRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_runtime_version), + '__call__') as call: + call.return_value = cloud_tpu.RuntimeVersion() + client.get_runtime_version(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_get_runtime_version_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.GetRuntimeVersionRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_runtime_version), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.RuntimeVersion()) + await client.get_runtime_version(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +def test_get_runtime_version_flattened(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_runtime_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.RuntimeVersion() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_runtime_version( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_get_runtime_version_flattened_error(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_runtime_version( + cloud_tpu.GetRuntimeVersionRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_get_runtime_version_flattened_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_runtime_version), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.RuntimeVersion() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.RuntimeVersion()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_runtime_version( + name='name_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_get_runtime_version_flattened_error_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_runtime_version( + cloud_tpu.GetRuntimeVersionRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.GetGuestAttributesRequest, + dict, +]) +def test_get_guest_attributes(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_guest_attributes), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_tpu.GetGuestAttributesResponse( + ) + response = client.get_guest_attributes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetGuestAttributesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_tpu.GetGuestAttributesResponse) + + +def test_get_guest_attributes_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_guest_attributes), + '__call__') as call: + client.get_guest_attributes() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetGuestAttributesRequest() + +@pytest.mark.asyncio +async def test_get_guest_attributes_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.GetGuestAttributesRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_guest_attributes), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.GetGuestAttributesResponse( + )) + response = await client.get_guest_attributes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.GetGuestAttributesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_tpu.GetGuestAttributesResponse) + + +@pytest.mark.asyncio +async def test_get_guest_attributes_async_from_dict(): + await test_get_guest_attributes_async(request_type=dict) + + +def test_get_guest_attributes_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.GetGuestAttributesRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_guest_attributes), + '__call__') as call: + call.return_value = cloud_tpu.GetGuestAttributesResponse() + client.get_guest_attributes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_get_guest_attributes_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.GetGuestAttributesRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_guest_attributes), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_tpu.GetGuestAttributesResponse()) + await client.get_guest_attributes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.parametrize("request_type", [ + cloud_tpu.SimulateMaintenanceEventRequest, + dict, +]) +def test_simulate_maintenance_event(request_type, transport: str = 'grpc'): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.simulate_maintenance_event), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.simulate_maintenance_event(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.SimulateMaintenanceEventRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_simulate_maintenance_event_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.simulate_maintenance_event), + '__call__') as call: + client.simulate_maintenance_event() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.SimulateMaintenanceEventRequest() + +@pytest.mark.asyncio +async def test_simulate_maintenance_event_async(transport: str = 'grpc_asyncio', request_type=cloud_tpu.SimulateMaintenanceEventRequest): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.simulate_maintenance_event), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name='operations/spam') + ) + response = await client.simulate_maintenance_event(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_tpu.SimulateMaintenanceEventRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_simulate_maintenance_event_async_from_dict(): + await test_simulate_maintenance_event_async(request_type=dict) + + +def test_simulate_maintenance_event_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.SimulateMaintenanceEventRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.simulate_maintenance_event), + '__call__') as call: + call.return_value = operations_pb2.Operation(name='operations/op') + client.simulate_maintenance_event(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_simulate_maintenance_event_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_tpu.SimulateMaintenanceEventRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.simulate_maintenance_event), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) + await client.simulate_maintenance_event(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'name=name_value', + ) in kw['metadata'] + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.TpuGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.TpuGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = TpuClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.TpuGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = TpuClient( + client_options=options, + transport=transport, + ) + + # It is an error to provide an api_key and a credential. + options = mock.Mock() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = TpuClient( + client_options=options, + credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.TpuGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = TpuClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.TpuGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = TpuClient(transport=transport) + assert client.transport is transport + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.TpuGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.TpuGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.TpuGrpcTransport, + transports.TpuGrpcAsyncIOTransport, +]) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + +@pytest.mark.parametrize("transport_name", [ + "grpc", +]) +def test_transport_kind(transport_name): + transport = TpuClient.get_transport_class(transport_name)( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert transport.kind == transport_name + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.TpuGrpcTransport, + ) + +def test_tpu_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.TpuTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json" + ) + + +def test_tpu_base_transport(): + # Instantiate the base transport. + with mock.patch('google.cloud.tpu_v2alpha1.services.tpu.transports.TpuTransport.__init__') as Transport: + Transport.return_value = None + transport = transports.TpuTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + 'list_nodes', + 'get_node', + 'create_node', + 'delete_node', + 'stop_node', + 'start_node', + 'update_node', + 'list_queued_resources', + 'get_queued_resource', + 'create_queued_resource', + 'delete_queued_resource', + 'generate_service_identity', + 'list_accelerator_types', + 'get_accelerator_type', + 'list_runtime_versions', + 'get_runtime_version', + 'get_guest_attributes', + 'simulate_maintenance_event', + 'get_location', + 'list_locations', + 'get_operation', + 'cancel_operation', + 'delete_operation', + 'list_operations', + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + with pytest.raises(NotImplementedError): + transport.close() + + # Additionally, the LRO client (a property) should + # also raise NotImplementedError + with pytest.raises(NotImplementedError): + transport.operations_client + + # Catch all for all remaining methods and properties + remainder = [ + 'kind', + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +def test_tpu_base_transport_with_credentials_file(): + # Instantiate the base transport with a credentials file + with mock.patch.object(google.auth, 'load_credentials_from_file', autospec=True) as load_creds, mock.patch('google.cloud.tpu_v2alpha1.services.tpu.transports.TpuTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.TpuTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with("credentials.json", + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id="octopus", + ) + + +def test_tpu_base_transport_with_adc(): + # Test the default credentials are used if credentials and credentials_file are None. + with mock.patch.object(google.auth, 'default', autospec=True) as adc, mock.patch('google.cloud.tpu_v2alpha1.services.tpu.transports.TpuTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.TpuTransport() + adc.assert_called_once() + + +def test_tpu_auth_adc(): + # If no credentials are provided, we should use ADC credentials. + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + TpuClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.TpuGrpcTransport, + transports.TpuGrpcAsyncIOTransport, + ], +) +def test_tpu_transport_auth_adc(transport_class): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + adc.assert_called_once_with( + scopes=["1", "2"], + default_scopes=( 'https://www.googleapis.com/auth/cloud-platform',), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.TpuGrpcTransport, + transports.TpuGrpcAsyncIOTransport, + ], +) +def test_tpu_transport_auth_gdch_credentials(transport_class): + host = 'https://language.com' + api_audience_tests = [None, 'https://language2.com'] + api_audience_expect = [host, 'https://language2.com'] + for t, e in zip(api_audience_tests, api_audience_expect): + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + gdch_mock = mock.MagicMock() + type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) + adc.return_value = (gdch_mock, None) + transport_class(host=host, api_audience=t) + gdch_mock.with_gdch_audience.assert_called_once_with( + e + ) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.TpuGrpcTransport, grpc_helpers), + (transports.TpuGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +def test_tpu_transport_create_channel(transport_class, grpc_helpers): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch.object( + grpc_helpers, "create_channel", autospec=True + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + adc.return_value = (creds, None) + transport_class( + quota_project_id="octopus", + scopes=["1", "2"] + ) + + create_channel.assert_called_with( + "tpu.googleapis.com:443", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + scopes=["1", "2"], + default_host="tpu.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("transport_class", [transports.TpuGrpcTransport, transports.TpuGrpcAsyncIOTransport]) +def test_tpu_grpc_transport_client_cert_source_for_mtls( + transport_class +): + cred = ga_credentials.AnonymousCredentials() + + # Check ssl_channel_credentials is used if provided. + with mock.patch.object(transport_class, "create_channel") as mock_create_channel: + mock_ssl_channel_creds = mock.Mock() + transport_class( + host="squid.clam.whelk", + credentials=cred, + ssl_channel_credentials=mock_ssl_channel_creds + ) + mock_create_channel.assert_called_once_with( + "squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_channel_creds, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls + # is used. + with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): + with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: + transport_class( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + expected_cert, expected_key = client_cert_source_callback() + mock_ssl_cred.assert_called_once_with( + certificate_chain=expected_cert, + private_key=expected_key + ) + + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", +]) +def test_tpu_host_no_port(transport_name): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='tpu.googleapis.com'), + transport=transport_name, + ) + assert client.transport._host == ( + 'tpu.googleapis.com:443' + ) + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", +]) +def test_tpu_host_with_port(transport_name): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='tpu.googleapis.com:8000'), + transport=transport_name, + ) + assert client.transport._host == ( + 'tpu.googleapis.com:8000' + ) + +def test_tpu_grpc_transport_channel(): + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.TpuGrpcTransport( + host="squid.clam.whelk", + channel=channel, + ) + assert transport.grpc_channel == channel + assert transport._host == "squid.clam.whelk:443" + assert transport._ssl_channel_credentials == None + + +def test_tpu_grpc_asyncio_transport_channel(): + channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.TpuGrpcAsyncIOTransport( + host="squid.clam.whelk", + channel=channel, + ) + assert transport.grpc_channel == channel + assert transport._host == "squid.clam.whelk:443" + assert transport._ssl_channel_credentials == None + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize("transport_class", [transports.TpuGrpcTransport, transports.TpuGrpcAsyncIOTransport]) +def test_tpu_transport_channel_mtls_with_client_cert_source( + transport_class +): + with mock.patch("grpc.ssl_channel_credentials", autospec=True) as grpc_ssl_channel_cred: + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_ssl_cred = mock.Mock() + grpc_ssl_channel_cred.return_value = mock_ssl_cred + + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + + cred = ga_credentials.AnonymousCredentials() + with pytest.warns(DeprecationWarning): + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (cred, None) + transport = transport_class( + host="squid.clam.whelk", + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=client_cert_source_callback, + ) + adc.assert_called_once() + + grpc_ssl_channel_cred.assert_called_once_with( + certificate_chain=b"cert bytes", private_key=b"key bytes" + ) + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + assert transport._ssl_channel_credentials == mock_ssl_cred + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize("transport_class", [transports.TpuGrpcTransport, transports.TpuGrpcAsyncIOTransport]) +def test_tpu_transport_channel_mtls_with_adc( + transport_class +): + mock_ssl_cred = mock.Mock() + with mock.patch.multiple( + "google.auth.transport.grpc.SslCredentials", + __init__=mock.Mock(return_value=None), + ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), + ): + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + mock_cred = mock.Mock() + + with pytest.warns(DeprecationWarning): + transport = transport_class( + host="squid.clam.whelk", + credentials=mock_cred, + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=None, + ) + + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=mock_cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + + +def test_tpu_grpc_lro_client(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.OperationsClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + +def test_tpu_grpc_lro_async_client(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc_asyncio', + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.OperationsAsyncClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + +def test_accelerator_type_path(): + project = "squid" + location = "clam" + accelerator_type = "whelk" + expected = "projects/{project}/locations/{location}/acceleratorTypes/{accelerator_type}".format(project=project, location=location, accelerator_type=accelerator_type, ) + actual = TpuClient.accelerator_type_path(project, location, accelerator_type) + assert expected == actual + + +def test_parse_accelerator_type_path(): + expected = { + "project": "octopus", + "location": "oyster", + "accelerator_type": "nudibranch", + } + path = TpuClient.accelerator_type_path(**expected) + + # Check that the path construction is reversible. + actual = TpuClient.parse_accelerator_type_path(path) + assert expected == actual + +def test_node_path(): + project = "cuttlefish" + location = "mussel" + node = "winkle" + expected = "projects/{project}/locations/{location}/nodes/{node}".format(project=project, location=location, node=node, ) + actual = TpuClient.node_path(project, location, node) + assert expected == actual + + +def test_parse_node_path(): + expected = { + "project": "nautilus", + "location": "scallop", + "node": "abalone", + } + path = TpuClient.node_path(**expected) + + # Check that the path construction is reversible. + actual = TpuClient.parse_node_path(path) + assert expected == actual + +def test_queued_resource_path(): + project = "squid" + location = "clam" + queued_resource = "whelk" + expected = "projects/{project}/locations/{location}/queuedResources/{queued_resource}".format(project=project, location=location, queued_resource=queued_resource, ) + actual = TpuClient.queued_resource_path(project, location, queued_resource) + assert expected == actual + + +def test_parse_queued_resource_path(): + expected = { + "project": "octopus", + "location": "oyster", + "queued_resource": "nudibranch", + } + path = TpuClient.queued_resource_path(**expected) + + # Check that the path construction is reversible. + actual = TpuClient.parse_queued_resource_path(path) + assert expected == actual + +def test_runtime_version_path(): + project = "cuttlefish" + location = "mussel" + runtime_version = "winkle" + expected = "projects/{project}/locations/{location}/runtimeVersions/{runtime_version}".format(project=project, location=location, runtime_version=runtime_version, ) + actual = TpuClient.runtime_version_path(project, location, runtime_version) + assert expected == actual + + +def test_parse_runtime_version_path(): + expected = { + "project": "nautilus", + "location": "scallop", + "runtime_version": "abalone", + } + path = TpuClient.runtime_version_path(**expected) + + # Check that the path construction is reversible. + actual = TpuClient.parse_runtime_version_path(path) + assert expected == actual + +def test_common_billing_account_path(): + billing_account = "squid" + expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + actual = TpuClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "clam", + } + path = TpuClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = TpuClient.parse_common_billing_account_path(path) + assert expected == actual + +def test_common_folder_path(): + folder = "whelk" + expected = "folders/{folder}".format(folder=folder, ) + actual = TpuClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "octopus", + } + path = TpuClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = TpuClient.parse_common_folder_path(path) + assert expected == actual + +def test_common_organization_path(): + organization = "oyster" + expected = "organizations/{organization}".format(organization=organization, ) + actual = TpuClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "nudibranch", + } + path = TpuClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = TpuClient.parse_common_organization_path(path) + assert expected == actual + +def test_common_project_path(): + project = "cuttlefish" + expected = "projects/{project}".format(project=project, ) + actual = TpuClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "mussel", + } + path = TpuClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = TpuClient.parse_common_project_path(path) + assert expected == actual + +def test_common_location_path(): + project = "winkle" + location = "nautilus" + expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) + actual = TpuClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "scallop", + "location": "abalone", + } + path = TpuClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = TpuClient.parse_common_location_path(path) + assert expected == actual + + +def test_client_with_default_client_info(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object(transports.TpuTransport, '_prep_wrapped_messages') as prep: + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object(transports.TpuTransport, '_prep_wrapped_messages') as prep: + transport_class = TpuClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + +@pytest.mark.asyncio +async def test_transport_close_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc_asyncio", + ) + with mock.patch.object(type(getattr(client.transport, "grpc_channel")), "close") as close: + async with client: + close.assert_not_called() + close.assert_called_once() + + +def test_delete_operation(transport: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = operations_pb2.DeleteOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.delete_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert response is None +@pytest.mark.asyncio +async def test_delete_operation_async(transport: str = "grpc"): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = operations_pb2.DeleteOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + None + ) + response = await client.delete_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert response is None + +def test_delete_operation_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = operations_pb2.DeleteOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + call.return_value = None + + client.delete_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations",) in kw["metadata"] +@pytest.mark.asyncio +async def test_delete_operation_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = operations_pb2.DeleteOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + None + ) + await client.delete_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations",) in kw["metadata"] + +def test_delete_operation_from_dict(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = None + + response = client.delete_operation( + request={ + "name": "locations", + } + ) + call.assert_called() +@pytest.mark.asyncio +async def test_delete_operation_from_dict_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + None + ) + response = await client.delete_operation( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_cancel_operation(transport: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = operations_pb2.CancelOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.cancel_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert response is None +@pytest.mark.asyncio +async def test_cancel_operation_async(transport: str = "grpc"): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = operations_pb2.CancelOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + None + ) + response = await client.cancel_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert response is None + +def test_cancel_operation_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = operations_pb2.CancelOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + call.return_value = None + + client.cancel_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations",) in kw["metadata"] +@pytest.mark.asyncio +async def test_cancel_operation_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = operations_pb2.CancelOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + None + ) + await client.cancel_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations",) in kw["metadata"] + +def test_cancel_operation_from_dict(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = None + + response = client.cancel_operation( + request={ + "name": "locations", + } + ) + call.assert_called() +@pytest.mark.asyncio +async def test_cancel_operation_from_dict_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + None + ) + response = await client.cancel_operation( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_get_operation(transport: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = operations_pb2.GetOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation() + response = client.get_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, operations_pb2.Operation) +@pytest.mark.asyncio +async def test_get_operation_async(transport: str = "grpc"): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = operations_pb2.GetOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation() + ) + response = await client.get_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, operations_pb2.Operation) + +def test_get_operation_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = operations_pb2.GetOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + call.return_value = operations_pb2.Operation() + + client.get_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations",) in kw["metadata"] +@pytest.mark.asyncio +async def test_get_operation_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = operations_pb2.GetOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation() + ) + await client.get_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations",) in kw["metadata"] + +def test_get_operation_from_dict(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation() + + response = client.get_operation( + request={ + "name": "locations", + } + ) + call.assert_called() +@pytest.mark.asyncio +async def test_get_operation_from_dict_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation() + ) + response = await client.get_operation( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_list_operations(transport: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = operations_pb2.ListOperationsRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.ListOperationsResponse() + response = client.list_operations(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, operations_pb2.ListOperationsResponse) +@pytest.mark.asyncio +async def test_list_operations_async(transport: str = "grpc"): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = operations_pb2.ListOperationsRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.ListOperationsResponse() + ) + response = await client.list_operations(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, operations_pb2.ListOperationsResponse) + +def test_list_operations_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = operations_pb2.ListOperationsRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + call.return_value = operations_pb2.ListOperationsResponse() + + client.list_operations(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations",) in kw["metadata"] +@pytest.mark.asyncio +async def test_list_operations_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = operations_pb2.ListOperationsRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.ListOperationsResponse() + ) + await client.list_operations(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations",) in kw["metadata"] + +def test_list_operations_from_dict(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.ListOperationsResponse() + + response = client.list_operations( + request={ + "name": "locations", + } + ) + call.assert_called() +@pytest.mark.asyncio +async def test_list_operations_from_dict_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.ListOperationsResponse() + ) + response = await client.list_operations( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_list_locations(transport: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = locations_pb2.ListLocationsRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = locations_pb2.ListLocationsResponse() + response = client.list_locations(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, locations_pb2.ListLocationsResponse) +@pytest.mark.asyncio +async def test_list_locations_async(transport: str = "grpc"): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = locations_pb2.ListLocationsRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + locations_pb2.ListLocationsResponse() + ) + response = await client.list_locations(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, locations_pb2.ListLocationsResponse) + +def test_list_locations_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = locations_pb2.ListLocationsRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + call.return_value = locations_pb2.ListLocationsResponse() + + client.list_locations(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations",) in kw["metadata"] +@pytest.mark.asyncio +async def test_list_locations_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = locations_pb2.ListLocationsRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + locations_pb2.ListLocationsResponse() + ) + await client.list_locations(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations",) in kw["metadata"] + +def test_list_locations_from_dict(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = locations_pb2.ListLocationsResponse() + + response = client.list_locations( + request={ + "name": "locations", + } + ) + call.assert_called() +@pytest.mark.asyncio +async def test_list_locations_from_dict_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + locations_pb2.ListLocationsResponse() + ) + response = await client.list_locations( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_get_location(transport: str = "grpc"): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = locations_pb2.GetLocationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_location), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = locations_pb2.Location() + response = client.get_location(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, locations_pb2.Location) +@pytest.mark.asyncio +async def test_get_location_async(transport: str = "grpc_asyncio"): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = locations_pb2.GetLocationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_location), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + locations_pb2.Location() + ) + response = await client.get_location(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, locations_pb2.Location) + +def test_get_location_field_headers(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials()) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = locations_pb2.GetLocationRequest() + request.name = "locations/abc" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_location), "__call__") as call: + call.return_value = locations_pb2.Location() + + client.get_location(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations/abc",) in kw["metadata"] +@pytest.mark.asyncio +async def test_get_location_field_headers_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials() + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = locations_pb2.GetLocationRequest() + request.name = "locations/abc" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_location), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + locations_pb2.Location() + ) + await client.get_location(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=locations/abc",) in kw["metadata"] + +def test_get_location_from_dict(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = locations_pb2.Location() + + response = client.get_location( + request={ + "name": "locations/abc", + } + ) + call.assert_called() +@pytest.mark.asyncio +async def test_get_location_from_dict_async(): + client = TpuAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + locations_pb2.Location() + ) + response = await client.get_location( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_transport_close(): + transports = { + "grpc": "_grpc_channel", + } + + for transport, close_name in transports.items(): + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport + ) + with mock.patch.object(type(getattr(client.transport, close_name)), "close") as close: + with client: + close.assert_not_called() + close.assert_called_once() + +def test_client_ctx(): + transports = [ + 'grpc', + ] + for transport in transports: + client = TpuClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport + ) + # Test client calls underlying transport. + with mock.patch.object(type(client.transport), "close") as close: + close.assert_not_called() + with client: + pass + close.assert_called() + +@pytest.mark.parametrize("client_class,transport_class", [ + (TpuClient, transports.TpuGrpcTransport), + (TpuAsyncClient, transports.TpuGrpcAsyncIOTransport), +]) +def test_api_key_credentials(client_class, transport_class): + with mock.patch.object( + google.auth._default, "get_api_key_credentials", create=True + ) as get_api_key_credentials: + mock_cred = mock.Mock() + get_api_key_credentials.return_value = mock_cred + options = client_options.ClientOptions() + options.api_key = "api_key" + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=mock_cred, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + )