From 511a6a6b87b2c99184252104e7e9a560bdf3e0a9 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Fri, 3 Oct 2025 23:01:44 +0000 Subject: [PATCH 1/2] feat: Add new `BACKGROUND_CHANGE_DATA_CAPTURE`, `BACKGROUND_COLUMN_METADATA_INDEX`, and `BACKGROUND_SEARCH_INDEX_REFRESH` reservation assignment types feat: Add support for creation and modification of new reservation groups feat: Add new reservation IAM policy get/set/test methods PiperOrigin-RevId: 814816863 Source-Link: https://github.com/googleapis/googleapis/commit/2193a2bfcecb92b92aad7a4d81baa428cafd7dfd Source-Link: https://github.com/googleapis/googleapis-gen/commit/b0cf5f4c4051c9ddd7990be93ae8d008789d7286 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWJpZ3F1ZXJ5LXJlc2VydmF0aW9uLy5Pd2xCb3QueWFtbCIsImgiOiJiMGNmNWY0YzQwNTFjOWRkZDc5OTBiZTkzYWU4ZDAwODc4OWQ3Mjg2In0= --- .../v1/.coveragerc | 13 + .../v1/.flake8 | 34 + .../v1/LICENSE | 202 + .../v1/MANIFEST.in | 20 + .../v1/README.rst | 143 + .../v1/docs/_static/custom.css | 20 + .../v1/docs/_templates/layout.html | 50 + .../reservation_service.rst | 10 + .../bigquery_reservation_v1/services_.rst | 6 + .../docs/bigquery_reservation_v1/types_.rst | 6 + .../v1/docs/conf.py | 385 + .../v1/docs/index.rst | 10 + .../v1/docs/multiprocessing.rst | 7 + .../cloud/bigquery_reservation/__init__.py | 111 + .../bigquery_reservation/gapic_version.py | 16 + .../cloud/bigquery_reservation/py.typed | 2 + .../cloud/bigquery_reservation_v1/__init__.py | 112 + .../gapic_metadata.json | 463 + .../bigquery_reservation_v1/gapic_version.py | 16 + .../cloud/bigquery_reservation_v1/py.typed | 2 + .../services/__init__.py | 15 + .../services/reservation_service/__init__.py | 22 + .../reservation_service/async_client.py | 3824 +++ .../services/reservation_service/client.py | 4203 +++ .../services/reservation_service/pagers.py | 861 + .../reservation_service/transports/README.rst | 9 + .../transports/__init__.py | 38 + .../reservation_service/transports/base.py | 656 + .../reservation_service/transports/grpc.py | 1299 + .../transports/grpc_asyncio.py | 1560 ++ .../reservation_service/transports/rest.py | 5221 ++++ .../transports/rest_base.py | 1282 + .../bigquery_reservation_v1/types/__init__.py | 104 + .../types/reservation.py | 1937 ++ .../v1/mypy.ini | 3 + .../v1/noxfile.py | 591 + ...rvation_service_create_assignment_async.py | 52 + ...ervation_service_create_assignment_sync.py | 52 + ...ervice_create_capacity_commitment_async.py | 52 + ...service_create_capacity_commitment_sync.py | 52 + ...vation_service_create_reservation_async.py | 52 + ..._service_create_reservation_group_async.py | 53 + ...n_service_create_reservation_group_sync.py | 53 + ...rvation_service_create_reservation_sync.py | 52 + ...rvation_service_delete_assignment_async.py | 50 + ...ervation_service_delete_assignment_sync.py | 50 + ...ervice_delete_capacity_commitment_async.py | 50 + ...service_delete_capacity_commitment_sync.py | 50 + ...vation_service_delete_reservation_async.py | 50 + ..._service_delete_reservation_group_async.py | 50 + ...n_service_delete_reservation_group_sync.py | 50 + ...rvation_service_delete_reservation_sync.py | 50 + ...tion_service_failover_reservation_async.py | 52 + ...ation_service_failover_reservation_sync.py | 52 + ...vation_service_get_bi_reservation_async.py | 52 + ...rvation_service_get_bi_reservation_sync.py | 52 + ...n_service_get_capacity_commitment_async.py | 52 + ...on_service_get_capacity_commitment_sync.py | 52 + ...eservation_service_get_iam_policy_async.py | 53 + ...reservation_service_get_iam_policy_sync.py | 53 + ...servation_service_get_reservation_async.py | 52 + ...ion_service_get_reservation_group_async.py | 52 + ...tion_service_get_reservation_group_sync.py | 52 + ...eservation_service_get_reservation_sync.py | 52 + ...ervation_service_list_assignments_async.py | 53 + ...servation_service_list_assignments_sync.py | 53 + ...service_list_capacity_commitments_async.py | 53 + ..._service_list_capacity_commitments_sync.py | 53 + ...n_service_list_reservation_groups_async.py | 53 + ...on_service_list_reservation_groups_sync.py | 53 + ...rvation_service_list_reservations_async.py | 53 + ...ervation_service_list_reservations_sync.py | 53 + ...ervice_merge_capacity_commitments_async.py | 51 + ...service_merge_capacity_commitments_sync.py | 51 + ...servation_service_move_assignment_async.py | 52 + ...eservation_service_move_assignment_sync.py | 52 + ...on_service_search_all_assignments_async.py | 53 + ...ion_service_search_all_assignments_sync.py | 53 + ...vation_service_search_assignments_async.py | 53 + ...rvation_service_search_assignments_sync.py | 53 + ...eservation_service_set_iam_policy_async.py | 53 + ...reservation_service_set_iam_policy_sync.py | 53 + ...service_split_capacity_commitment_async.py | 52 + ..._service_split_capacity_commitment_sync.py | 52 + ...tion_service_test_iam_permissions_async.py | 54 + ...ation_service_test_iam_permissions_sync.py | 54 + ...rvation_service_update_assignment_async.py | 51 + ...ervation_service_update_assignment_sync.py | 51 + ...ion_service_update_bi_reservation_async.py | 51 + ...tion_service_update_bi_reservation_sync.py | 51 + ...ervice_update_capacity_commitment_async.py | 51 + ...service_update_capacity_commitment_sync.py | 51 + ...vation_service_update_reservation_async.py | 51 + ...rvation_service_update_reservation_sync.py | 51 + ..._google.cloud.bigquery.reservation.v1.json | 4740 ++++ .../fixup_bigquery_reservation_v1_keywords.py | 204 + .../v1/setup.py | 99 + .../v1/testing/constraints-3.10.txt | 7 + .../v1/testing/constraints-3.11.txt | 7 + .../v1/testing/constraints-3.12.txt | 7 + .../v1/testing/constraints-3.13.txt | 12 + .../v1/testing/constraints-3.7.txt | 11 + .../v1/testing/constraints-3.8.txt | 7 + .../v1/testing/constraints-3.9.txt | 7 + .../v1/tests/__init__.py | 16 + .../v1/tests/unit/__init__.py | 16 + .../v1/tests/unit/gapic/__init__.py | 16 + .../gapic/bigquery_reservation_v1/__init__.py | 16 + .../test_reservation_service.py | 22667 ++++++++++++++++ 109 files changed, 54097 insertions(+) create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/.coveragerc create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/.flake8 create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/LICENSE create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/MANIFEST.in create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/README.rst create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/_static/custom.css create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/_templates/layout.html create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/bigquery_reservation_v1/reservation_service.rst create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/bigquery_reservation_v1/services_.rst create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/bigquery_reservation_v1/types_.rst create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/conf.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/index.rst create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/multiprocessing.rst create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation/__init__.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation/gapic_version.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation/py.typed create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/__init__.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/gapic_metadata.json create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/gapic_version.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/py.typed create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/__init__.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/__init__.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/async_client.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/client.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/pagers.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/README.rst create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/__init__.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/base.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc_asyncio.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/rest.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/rest_base.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/types/__init__.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/types/reservation.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/mypy.ini create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/noxfile.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_assignment_async.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_assignment_sync.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_capacity_commitment_async.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_capacity_commitment_sync.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_reservation_async.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_reservation_group_async.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_reservation_group_sync.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_reservation_sync.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_assignment_async.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_assignment_sync.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_capacity_commitment_async.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_capacity_commitment_sync.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_reservation_async.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_reservation_group_async.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_reservation_group_sync.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_reservation_sync.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_failover_reservation_async.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_failover_reservation_sync.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_bi_reservation_async.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_bi_reservation_sync.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_capacity_commitment_async.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_capacity_commitment_sync.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_iam_policy_async.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_iam_policy_sync.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_reservation_async.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_reservation_group_async.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_reservation_group_sync.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_reservation_sync.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_assignments_async.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_assignments_sync.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_capacity_commitments_async.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_capacity_commitments_sync.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_reservation_groups_async.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_reservation_groups_sync.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_reservations_async.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_reservations_sync.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_merge_capacity_commitments_async.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_merge_capacity_commitments_sync.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_move_assignment_async.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_move_assignment_sync.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_search_all_assignments_async.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_search_all_assignments_sync.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_search_assignments_async.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_search_assignments_sync.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_set_iam_policy_async.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_set_iam_policy_sync.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_split_capacity_commitment_async.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_split_capacity_commitment_sync.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_test_iam_permissions_async.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_test_iam_permissions_sync.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_assignment_async.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_assignment_sync.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_bi_reservation_async.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_bi_reservation_sync.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_capacity_commitment_async.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_capacity_commitment_sync.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_reservation_async.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_reservation_sync.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/snippet_metadata_google.cloud.bigquery.reservation.v1.json create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/scripts/fixup_bigquery_reservation_v1_keywords.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/setup.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.10.txt create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.11.txt create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.12.txt create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.13.txt create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.7.txt create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.8.txt create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.9.txt create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/tests/__init__.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/tests/unit/__init__.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/tests/unit/gapic/__init__.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/tests/unit/gapic/bigquery_reservation_v1/__init__.py create mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/tests/unit/gapic/bigquery_reservation_v1/test_reservation_service.py diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/.coveragerc b/owl-bot-staging/google-cloud-bigquery-reservation/v1/.coveragerc new file mode 100644 index 000000000000..24e124ab08de --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/.coveragerc @@ -0,0 +1,13 @@ +[run] +branch = True + +[report] +show_missing = True +omit = + google/cloud/bigquery_reservation/__init__.py + google/cloud/bigquery_reservation/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/google-cloud-bigquery-reservation/v1/.flake8 b/owl-bot-staging/google-cloud-bigquery-reservation/v1/.flake8 new file mode 100644 index 000000000000..90316de21489 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/.flake8 @@ -0,0 +1,34 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +[flake8] +# TODO(https://github.com/googleapis/gapic-generator-python/issues/2333): +# Resolve flake8 lint issues +ignore = E203, E231, E266, E501, W503 +exclude = + # TODO(https://github.com/googleapis/gapic-generator-python/issues/2333): + # Ensure that generated code passes flake8 lint + **/gapic/** + **/services/** + **/types/** + # Exclude Protobuf gencode + *_pb2.py + + # Standard linting exemptions. + **/.nox/** + __pycache__, + .git, + *.pyc, + conf.py diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/LICENSE b/owl-bot-staging/google-cloud-bigquery-reservation/v1/LICENSE new file mode 100644 index 000000000000..d64569567334 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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/google-cloud-bigquery-reservation/v1/MANIFEST.in b/owl-bot-staging/google-cloud-bigquery-reservation/v1/MANIFEST.in new file mode 100644 index 000000000000..dae249ec8976 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/MANIFEST.in @@ -0,0 +1,20 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +include README.rst LICENSE +recursive-include google *.py *.pyi *.json *.proto py.typed +recursive-include tests * +global-exclude *.py[co] +global-exclude __pycache__ diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/README.rst b/owl-bot-staging/google-cloud-bigquery-reservation/v1/README.rst new file mode 100644 index 000000000000..1cfbfbc32063 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/README.rst @@ -0,0 +1,143 @@ +Python Client for Google Cloud Bigquery Reservation 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 Bigquery Reservation 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 + + +Logging +------- + +This library uses the standard Python :code:`logging` functionality to log some RPC events that could be of interest for debugging and monitoring purposes. +Note the following: + +#. Logs may contain sensitive information. Take care to **restrict access to the logs** if they are saved, whether it be on local storage or on Google Cloud Logging. +#. Google may refine the occurrence, level, and content of various log messages in this library without flagging such changes as breaking. **Do not depend on immutability of the logging events**. +#. By default, the logging events from this library are not handled. You must **explicitly configure log handling** using one of the mechanisms below. + + +Simple, environment-based configuration +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To enable logging for this library without any changes in your code, set the :code:`GOOGLE_SDK_PYTHON_LOGGING_SCOPE` environment variable to a valid Google +logging scope. This configures handling of logging events (at level :code:`logging.DEBUG` or higher) from this library in a default manner, emitting the logged +messages in a structured format. It does not currently allow customizing the logging levels captured nor the handlers, formatters, etc. used for any logging +event. + +A logging scope is a period-separated namespace that begins with :code:`google`, identifying the Python module or package to log. + +- Valid logging scopes: :code:`google`, :code:`google.cloud.asset.v1`, :code:`google.api`, :code:`google.auth`, etc. +- Invalid logging scopes: :code:`foo`, :code:`123`, etc. + +**NOTE**: If the logging scope is invalid, the library does not set up any logging handlers. + + +Examples +^^^^^^^^ + +- Enabling the default handler for all Google-based loggers + +.. code-block:: console + + export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google + +- Enabling the default handler for a specific Google module (for a client library called :code:`library_v1`): + +.. code-block:: console + + export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google.cloud.library_v1 + + +Advanced, code-based configuration +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +You can also configure a valid logging scope using Python's standard `logging` mechanism. + + +Examples +^^^^^^^^ + +- Configuring a handler for all Google-based loggers + +.. code-block:: python + + import logging + + from google.cloud.translate_v3 import translate + + base_logger = logging.getLogger("google") + base_logger.addHandler(logging.StreamHandler()) + base_logger.setLevel(logging.DEBUG) + +- Configuring a handler for a specific Google module (for a client library called :code:`library_v1`): + +.. code-block:: python + + import logging + + from google.cloud.translate_v3 import translate + + base_logger = logging.getLogger("google.cloud.library_v1") + base_logger.addHandler(logging.StreamHandler()) + base_logger.setLevel(logging.DEBUG) + + +Logging details +~~~~~~~~~~~~~~~ + +#. Regardless of which of the mechanisms above you use to configure logging for this library, by default logging events are not propagated up to the root + logger from the `google`-level logger. If you need the events to be propagated to the root logger, you must explicitly set + :code:`logging.getLogger("google").propagate = True` in your code. +#. You can mix the different logging configurations above for different Google modules. For example, you may want use a code-based logging configuration for + one library, but decide you need to also set up environment-based logging configuration for another library. + + #. If you attempt to use both code-based and environment-based configuration for the same module, the environment-based configuration will be ineffectual + if the code -based configuration gets applied first. + +#. The Google-specific logging configurations (default handlers for environment-based configuration; not propagating logging events to the root logger) get + executed the first time *any* client library is instantiated in your application, and only if the affected loggers have not been previously configured. + (This is the reason for 2.i. above.) diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/_static/custom.css b/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/_static/custom.css new file mode 100644 index 000000000000..b0a295464b23 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/_static/custom.css @@ -0,0 +1,20 @@ +div#python2-eol { + border-color: red; + border-width: medium; +} + +/* Ensure minimum width for 'Parameters' / 'Returns' column */ +dl.field-list > dt { + min-width: 100px +} + +/* Insert space between methods for readability */ +dl.method { + padding-top: 10px; + padding-bottom: 10px +} + +/* Insert empty space between classes */ +dl.class { + padding-bottom: 50px +} diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/_templates/layout.html b/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/_templates/layout.html new file mode 100644 index 000000000000..95e9c77fcfe1 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/_templates/layout.html @@ -0,0 +1,50 @@ + +{% extends "!layout.html" %} +{%- block content %} +{%- if theme_fixed_sidebar|lower == 'true' %} +
+ {{ sidebar() }} + {%- block document %} +
+ {%- if render_sidebar %} +
+ {%- endif %} + + {%- block relbar_top %} + {%- if theme_show_relbar_top|tobool %} +
+   + {{- rellink_markup () }} +
+ {%- endif %} + {% endblock %} + +
+
+ As of January 1, 2020 this library no longer supports Python 2 on the latest released version. + Library versions released prior to that date will continue to be available. For more information please + visit Python 2 support on Google Cloud. +
+ {% block body %} {% endblock %} +
+ + {%- block relbar_bottom %} + {%- if theme_show_relbar_bottom|tobool %} +
+   + {{- rellink_markup () }} +
+ {%- endif %} + {% endblock %} + + {%- if render_sidebar %} +
+ {%- endif %} +
+ {%- endblock %} +
+
+{%- else %} +{{ super() }} +{%- endif %} +{%- endblock %} diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/bigquery_reservation_v1/reservation_service.rst b/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/bigquery_reservation_v1/reservation_service.rst new file mode 100644 index 000000000000..35e6b3cfd676 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/bigquery_reservation_v1/reservation_service.rst @@ -0,0 +1,10 @@ +ReservationService +------------------------------------ + +.. automodule:: google.cloud.bigquery_reservation_v1.services.reservation_service + :members: + :inherited-members: + +.. automodule:: google.cloud.bigquery_reservation_v1.services.reservation_service.pagers + :members: + :inherited-members: diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/bigquery_reservation_v1/services_.rst b/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/bigquery_reservation_v1/services_.rst new file mode 100644 index 000000000000..3f9e9577f53c --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/bigquery_reservation_v1/services_.rst @@ -0,0 +1,6 @@ +Services for Google Cloud Bigquery Reservation v1 API +===================================================== +.. toctree:: + :maxdepth: 2 + + reservation_service diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/bigquery_reservation_v1/types_.rst b/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/bigquery_reservation_v1/types_.rst new file mode 100644 index 000000000000..96a1583d3f20 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/bigquery_reservation_v1/types_.rst @@ -0,0 +1,6 @@ +Types for Google Cloud Bigquery Reservation v1 API +================================================== + +.. automodule:: google.cloud.bigquery_reservation_v1.types + :members: + :show-inheritance: diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/conf.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/conf.py new file mode 100644 index 000000000000..06008b76447b --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/conf.py @@ -0,0 +1,385 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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-bigquery-reservation 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("..")) + +# For plugins that can not read conf.py. +# See also: https://github.com/docascode/sphinx-docfx-yaml/issues/85 +sys.path.insert(0, os.path.abspath(".")) + +__version__ = "" + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +needs_sphinx = "4.5.0" + +# 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.doctest", + "sphinx.ext.napoleon", + "sphinx.ext.todo", + "sphinx.ext.viewcode", + "recommonmark", +] + +# autodoc/autosummary flags +autoclass_content = "both" +autodoc_default_options = {"members": True} +autosummary_generate = True + + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# source_suffix = ['.rst', '.md'] +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-bigquery-reservation" +copyright = u"2025, Google, LLC" +author = u"Google APIs" + +# 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", + "**/.nox/**/*", + "samples/AUTHORING_GUIDE.md", + "samples/CONTRIBUTING.md", + "samples/snippets/README.rst", +] + +# 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 google-cloud-bigquery-reservation", + "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-bigquery-reservation-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-bigquery-reservation.tex", + u"google-cloud-bigquery-reservation 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-bigquery-reservation", + "google-cloud-bigquery-reservation 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-bigquery-reservation", + "google-cloud-bigquery-reservation Documentation", + author, + "google-cloud-bigquery-reservation", + "google-cloud-bigquery-reservation Library", + "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": ("https://python.readthedocs.org/en/latest/", None), + "google-auth": ("https://googleapis.dev/python/google-auth/latest/", None), + "google.api_core": ( + "https://googleapis.dev/python/google-api-core/latest/", + None, + ), + "grpc": ("https://grpc.github.io/grpc/python/", None), + "proto-plus": ("https://proto-plus-python.readthedocs.io/en/latest/", 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/google-cloud-bigquery-reservation/v1/docs/index.rst b/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/index.rst new file mode 100644 index 000000000000..848c6ec2f825 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/index.rst @@ -0,0 +1,10 @@ +.. include:: multiprocessing.rst + + +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + bigquery_reservation_v1/services_ + bigquery_reservation_v1/types_ diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/multiprocessing.rst b/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/multiprocessing.rst new file mode 100644 index 000000000000..536d17b2ea65 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/multiprocessing.rst @@ -0,0 +1,7 @@ +.. note:: + + Because this client uses :mod:`grpc` library, it is safe to + share instances across threads. In multiprocessing scenarios, the best + practice is to create client instances *after* the invocation of + :func:`os.fork` by :class:`multiprocessing.pool.Pool` or + :class:`multiprocessing.Process`. diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation/__init__.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation/__init__.py new file mode 100644 index 000000000000..04af02e9ea29 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation/__init__.py @@ -0,0 +1,111 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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.bigquery_reservation import gapic_version as package_version + +__version__ = package_version.__version__ + + +from google.cloud.bigquery_reservation_v1.services.reservation_service.client import ReservationServiceClient +from google.cloud.bigquery_reservation_v1.services.reservation_service.async_client import ReservationServiceAsyncClient + +from google.cloud.bigquery_reservation_v1.types.reservation import Assignment +from google.cloud.bigquery_reservation_v1.types.reservation import BiReservation +from google.cloud.bigquery_reservation_v1.types.reservation import CapacityCommitment +from google.cloud.bigquery_reservation_v1.types.reservation import CreateAssignmentRequest +from google.cloud.bigquery_reservation_v1.types.reservation import CreateCapacityCommitmentRequest +from google.cloud.bigquery_reservation_v1.types.reservation import CreateReservationGroupRequest +from google.cloud.bigquery_reservation_v1.types.reservation import CreateReservationRequest +from google.cloud.bigquery_reservation_v1.types.reservation import DeleteAssignmentRequest +from google.cloud.bigquery_reservation_v1.types.reservation import DeleteCapacityCommitmentRequest +from google.cloud.bigquery_reservation_v1.types.reservation import DeleteReservationGroupRequest +from google.cloud.bigquery_reservation_v1.types.reservation import DeleteReservationRequest +from google.cloud.bigquery_reservation_v1.types.reservation import FailoverReservationRequest +from google.cloud.bigquery_reservation_v1.types.reservation import GetBiReservationRequest +from google.cloud.bigquery_reservation_v1.types.reservation import GetCapacityCommitmentRequest +from google.cloud.bigquery_reservation_v1.types.reservation import GetReservationGroupRequest +from google.cloud.bigquery_reservation_v1.types.reservation import GetReservationRequest +from google.cloud.bigquery_reservation_v1.types.reservation import ListAssignmentsRequest +from google.cloud.bigquery_reservation_v1.types.reservation import ListAssignmentsResponse +from google.cloud.bigquery_reservation_v1.types.reservation import ListCapacityCommitmentsRequest +from google.cloud.bigquery_reservation_v1.types.reservation import ListCapacityCommitmentsResponse +from google.cloud.bigquery_reservation_v1.types.reservation import ListReservationGroupsRequest +from google.cloud.bigquery_reservation_v1.types.reservation import ListReservationGroupsResponse +from google.cloud.bigquery_reservation_v1.types.reservation import ListReservationsRequest +from google.cloud.bigquery_reservation_v1.types.reservation import ListReservationsResponse +from google.cloud.bigquery_reservation_v1.types.reservation import MergeCapacityCommitmentsRequest +from google.cloud.bigquery_reservation_v1.types.reservation import MoveAssignmentRequest +from google.cloud.bigquery_reservation_v1.types.reservation import Reservation +from google.cloud.bigquery_reservation_v1.types.reservation import ReservationGroup +from google.cloud.bigquery_reservation_v1.types.reservation import SchedulingPolicy +from google.cloud.bigquery_reservation_v1.types.reservation import SearchAllAssignmentsRequest +from google.cloud.bigquery_reservation_v1.types.reservation import SearchAllAssignmentsResponse +from google.cloud.bigquery_reservation_v1.types.reservation import SearchAssignmentsRequest +from google.cloud.bigquery_reservation_v1.types.reservation import SearchAssignmentsResponse +from google.cloud.bigquery_reservation_v1.types.reservation import SplitCapacityCommitmentRequest +from google.cloud.bigquery_reservation_v1.types.reservation import SplitCapacityCommitmentResponse +from google.cloud.bigquery_reservation_v1.types.reservation import TableReference +from google.cloud.bigquery_reservation_v1.types.reservation import UpdateAssignmentRequest +from google.cloud.bigquery_reservation_v1.types.reservation import UpdateBiReservationRequest +from google.cloud.bigquery_reservation_v1.types.reservation import UpdateCapacityCommitmentRequest +from google.cloud.bigquery_reservation_v1.types.reservation import UpdateReservationRequest +from google.cloud.bigquery_reservation_v1.types.reservation import Edition +from google.cloud.bigquery_reservation_v1.types.reservation import FailoverMode + +__all__ = ('ReservationServiceClient', + 'ReservationServiceAsyncClient', + 'Assignment', + 'BiReservation', + 'CapacityCommitment', + 'CreateAssignmentRequest', + 'CreateCapacityCommitmentRequest', + 'CreateReservationGroupRequest', + 'CreateReservationRequest', + 'DeleteAssignmentRequest', + 'DeleteCapacityCommitmentRequest', + 'DeleteReservationGroupRequest', + 'DeleteReservationRequest', + 'FailoverReservationRequest', + 'GetBiReservationRequest', + 'GetCapacityCommitmentRequest', + 'GetReservationGroupRequest', + 'GetReservationRequest', + 'ListAssignmentsRequest', + 'ListAssignmentsResponse', + 'ListCapacityCommitmentsRequest', + 'ListCapacityCommitmentsResponse', + 'ListReservationGroupsRequest', + 'ListReservationGroupsResponse', + 'ListReservationsRequest', + 'ListReservationsResponse', + 'MergeCapacityCommitmentsRequest', + 'MoveAssignmentRequest', + 'Reservation', + 'ReservationGroup', + 'SchedulingPolicy', + 'SearchAllAssignmentsRequest', + 'SearchAllAssignmentsResponse', + 'SearchAssignmentsRequest', + 'SearchAssignmentsResponse', + 'SplitCapacityCommitmentRequest', + 'SplitCapacityCommitmentResponse', + 'TableReference', + 'UpdateAssignmentRequest', + 'UpdateBiReservationRequest', + 'UpdateCapacityCommitmentRequest', + 'UpdateReservationRequest', + 'Edition', + 'FailoverMode', +) diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation/gapic_version.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation/gapic_version.py new file mode 100644 index 000000000000..20a9cd975b02 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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.0.0" # {x-release-please-version} diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation/py.typed b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation/py.typed new file mode 100644 index 000000000000..ff261ee1d848 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-bigquery-reservation package uses inline types. diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/__init__.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/__init__.py new file mode 100644 index 000000000000..05ff40e1cca9 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/__init__.py @@ -0,0 +1,112 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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.bigquery_reservation_v1 import gapic_version as package_version + +__version__ = package_version.__version__ + + +from .services.reservation_service import ReservationServiceClient +from .services.reservation_service import ReservationServiceAsyncClient + +from .types.reservation import Assignment +from .types.reservation import BiReservation +from .types.reservation import CapacityCommitment +from .types.reservation import CreateAssignmentRequest +from .types.reservation import CreateCapacityCommitmentRequest +from .types.reservation import CreateReservationGroupRequest +from .types.reservation import CreateReservationRequest +from .types.reservation import DeleteAssignmentRequest +from .types.reservation import DeleteCapacityCommitmentRequest +from .types.reservation import DeleteReservationGroupRequest +from .types.reservation import DeleteReservationRequest +from .types.reservation import FailoverReservationRequest +from .types.reservation import GetBiReservationRequest +from .types.reservation import GetCapacityCommitmentRequest +from .types.reservation import GetReservationGroupRequest +from .types.reservation import GetReservationRequest +from .types.reservation import ListAssignmentsRequest +from .types.reservation import ListAssignmentsResponse +from .types.reservation import ListCapacityCommitmentsRequest +from .types.reservation import ListCapacityCommitmentsResponse +from .types.reservation import ListReservationGroupsRequest +from .types.reservation import ListReservationGroupsResponse +from .types.reservation import ListReservationsRequest +from .types.reservation import ListReservationsResponse +from .types.reservation import MergeCapacityCommitmentsRequest +from .types.reservation import MoveAssignmentRequest +from .types.reservation import Reservation +from .types.reservation import ReservationGroup +from .types.reservation import SchedulingPolicy +from .types.reservation import SearchAllAssignmentsRequest +from .types.reservation import SearchAllAssignmentsResponse +from .types.reservation import SearchAssignmentsRequest +from .types.reservation import SearchAssignmentsResponse +from .types.reservation import SplitCapacityCommitmentRequest +from .types.reservation import SplitCapacityCommitmentResponse +from .types.reservation import TableReference +from .types.reservation import UpdateAssignmentRequest +from .types.reservation import UpdateBiReservationRequest +from .types.reservation import UpdateCapacityCommitmentRequest +from .types.reservation import UpdateReservationRequest +from .types.reservation import Edition +from .types.reservation import FailoverMode + +__all__ = ( + 'ReservationServiceAsyncClient', +'Assignment', +'BiReservation', +'CapacityCommitment', +'CreateAssignmentRequest', +'CreateCapacityCommitmentRequest', +'CreateReservationGroupRequest', +'CreateReservationRequest', +'DeleteAssignmentRequest', +'DeleteCapacityCommitmentRequest', +'DeleteReservationGroupRequest', +'DeleteReservationRequest', +'Edition', +'FailoverMode', +'FailoverReservationRequest', +'GetBiReservationRequest', +'GetCapacityCommitmentRequest', +'GetReservationGroupRequest', +'GetReservationRequest', +'ListAssignmentsRequest', +'ListAssignmentsResponse', +'ListCapacityCommitmentsRequest', +'ListCapacityCommitmentsResponse', +'ListReservationGroupsRequest', +'ListReservationGroupsResponse', +'ListReservationsRequest', +'ListReservationsResponse', +'MergeCapacityCommitmentsRequest', +'MoveAssignmentRequest', +'Reservation', +'ReservationGroup', +'ReservationServiceClient', +'SchedulingPolicy', +'SearchAllAssignmentsRequest', +'SearchAllAssignmentsResponse', +'SearchAssignmentsRequest', +'SearchAssignmentsResponse', +'SplitCapacityCommitmentRequest', +'SplitCapacityCommitmentResponse', +'TableReference', +'UpdateAssignmentRequest', +'UpdateBiReservationRequest', +'UpdateCapacityCommitmentRequest', +'UpdateReservationRequest', +) diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/gapic_metadata.json b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/gapic_metadata.json new file mode 100644 index 000000000000..7216bd76bb22 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/gapic_metadata.json @@ -0,0 +1,463 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.cloud.bigquery_reservation_v1", + "protoPackage": "google.cloud.bigquery.reservation.v1", + "schema": "1.0", + "services": { + "ReservationService": { + "clients": { + "grpc": { + "libraryClient": "ReservationServiceClient", + "rpcs": { + "CreateAssignment": { + "methods": [ + "create_assignment" + ] + }, + "CreateCapacityCommitment": { + "methods": [ + "create_capacity_commitment" + ] + }, + "CreateReservation": { + "methods": [ + "create_reservation" + ] + }, + "CreateReservationGroup": { + "methods": [ + "create_reservation_group" + ] + }, + "DeleteAssignment": { + "methods": [ + "delete_assignment" + ] + }, + "DeleteCapacityCommitment": { + "methods": [ + "delete_capacity_commitment" + ] + }, + "DeleteReservation": { + "methods": [ + "delete_reservation" + ] + }, + "DeleteReservationGroup": { + "methods": [ + "delete_reservation_group" + ] + }, + "FailoverReservation": { + "methods": [ + "failover_reservation" + ] + }, + "GetBiReservation": { + "methods": [ + "get_bi_reservation" + ] + }, + "GetCapacityCommitment": { + "methods": [ + "get_capacity_commitment" + ] + }, + "GetIamPolicy": { + "methods": [ + "get_iam_policy" + ] + }, + "GetReservation": { + "methods": [ + "get_reservation" + ] + }, + "GetReservationGroup": { + "methods": [ + "get_reservation_group" + ] + }, + "ListAssignments": { + "methods": [ + "list_assignments" + ] + }, + "ListCapacityCommitments": { + "methods": [ + "list_capacity_commitments" + ] + }, + "ListReservationGroups": { + "methods": [ + "list_reservation_groups" + ] + }, + "ListReservations": { + "methods": [ + "list_reservations" + ] + }, + "MergeCapacityCommitments": { + "methods": [ + "merge_capacity_commitments" + ] + }, + "MoveAssignment": { + "methods": [ + "move_assignment" + ] + }, + "SearchAllAssignments": { + "methods": [ + "search_all_assignments" + ] + }, + "SearchAssignments": { + "methods": [ + "search_assignments" + ] + }, + "SetIamPolicy": { + "methods": [ + "set_iam_policy" + ] + }, + "SplitCapacityCommitment": { + "methods": [ + "split_capacity_commitment" + ] + }, + "TestIamPermissions": { + "methods": [ + "test_iam_permissions" + ] + }, + "UpdateAssignment": { + "methods": [ + "update_assignment" + ] + }, + "UpdateBiReservation": { + "methods": [ + "update_bi_reservation" + ] + }, + "UpdateCapacityCommitment": { + "methods": [ + "update_capacity_commitment" + ] + }, + "UpdateReservation": { + "methods": [ + "update_reservation" + ] + } + } + }, + "grpc-async": { + "libraryClient": "ReservationServiceAsyncClient", + "rpcs": { + "CreateAssignment": { + "methods": [ + "create_assignment" + ] + }, + "CreateCapacityCommitment": { + "methods": [ + "create_capacity_commitment" + ] + }, + "CreateReservation": { + "methods": [ + "create_reservation" + ] + }, + "CreateReservationGroup": { + "methods": [ + "create_reservation_group" + ] + }, + "DeleteAssignment": { + "methods": [ + "delete_assignment" + ] + }, + "DeleteCapacityCommitment": { + "methods": [ + "delete_capacity_commitment" + ] + }, + "DeleteReservation": { + "methods": [ + "delete_reservation" + ] + }, + "DeleteReservationGroup": { + "methods": [ + "delete_reservation_group" + ] + }, + "FailoverReservation": { + "methods": [ + "failover_reservation" + ] + }, + "GetBiReservation": { + "methods": [ + "get_bi_reservation" + ] + }, + "GetCapacityCommitment": { + "methods": [ + "get_capacity_commitment" + ] + }, + "GetIamPolicy": { + "methods": [ + "get_iam_policy" + ] + }, + "GetReservation": { + "methods": [ + "get_reservation" + ] + }, + "GetReservationGroup": { + "methods": [ + "get_reservation_group" + ] + }, + "ListAssignments": { + "methods": [ + "list_assignments" + ] + }, + "ListCapacityCommitments": { + "methods": [ + "list_capacity_commitments" + ] + }, + "ListReservationGroups": { + "methods": [ + "list_reservation_groups" + ] + }, + "ListReservations": { + "methods": [ + "list_reservations" + ] + }, + "MergeCapacityCommitments": { + "methods": [ + "merge_capacity_commitments" + ] + }, + "MoveAssignment": { + "methods": [ + "move_assignment" + ] + }, + "SearchAllAssignments": { + "methods": [ + "search_all_assignments" + ] + }, + "SearchAssignments": { + "methods": [ + "search_assignments" + ] + }, + "SetIamPolicy": { + "methods": [ + "set_iam_policy" + ] + }, + "SplitCapacityCommitment": { + "methods": [ + "split_capacity_commitment" + ] + }, + "TestIamPermissions": { + "methods": [ + "test_iam_permissions" + ] + }, + "UpdateAssignment": { + "methods": [ + "update_assignment" + ] + }, + "UpdateBiReservation": { + "methods": [ + "update_bi_reservation" + ] + }, + "UpdateCapacityCommitment": { + "methods": [ + "update_capacity_commitment" + ] + }, + "UpdateReservation": { + "methods": [ + "update_reservation" + ] + } + } + }, + "rest": { + "libraryClient": "ReservationServiceClient", + "rpcs": { + "CreateAssignment": { + "methods": [ + "create_assignment" + ] + }, + "CreateCapacityCommitment": { + "methods": [ + "create_capacity_commitment" + ] + }, + "CreateReservation": { + "methods": [ + "create_reservation" + ] + }, + "CreateReservationGroup": { + "methods": [ + "create_reservation_group" + ] + }, + "DeleteAssignment": { + "methods": [ + "delete_assignment" + ] + }, + "DeleteCapacityCommitment": { + "methods": [ + "delete_capacity_commitment" + ] + }, + "DeleteReservation": { + "methods": [ + "delete_reservation" + ] + }, + "DeleteReservationGroup": { + "methods": [ + "delete_reservation_group" + ] + }, + "FailoverReservation": { + "methods": [ + "failover_reservation" + ] + }, + "GetBiReservation": { + "methods": [ + "get_bi_reservation" + ] + }, + "GetCapacityCommitment": { + "methods": [ + "get_capacity_commitment" + ] + }, + "GetIamPolicy": { + "methods": [ + "get_iam_policy" + ] + }, + "GetReservation": { + "methods": [ + "get_reservation" + ] + }, + "GetReservationGroup": { + "methods": [ + "get_reservation_group" + ] + }, + "ListAssignments": { + "methods": [ + "list_assignments" + ] + }, + "ListCapacityCommitments": { + "methods": [ + "list_capacity_commitments" + ] + }, + "ListReservationGroups": { + "methods": [ + "list_reservation_groups" + ] + }, + "ListReservations": { + "methods": [ + "list_reservations" + ] + }, + "MergeCapacityCommitments": { + "methods": [ + "merge_capacity_commitments" + ] + }, + "MoveAssignment": { + "methods": [ + "move_assignment" + ] + }, + "SearchAllAssignments": { + "methods": [ + "search_all_assignments" + ] + }, + "SearchAssignments": { + "methods": [ + "search_assignments" + ] + }, + "SetIamPolicy": { + "methods": [ + "set_iam_policy" + ] + }, + "SplitCapacityCommitment": { + "methods": [ + "split_capacity_commitment" + ] + }, + "TestIamPermissions": { + "methods": [ + "test_iam_permissions" + ] + }, + "UpdateAssignment": { + "methods": [ + "update_assignment" + ] + }, + "UpdateBiReservation": { + "methods": [ + "update_bi_reservation" + ] + }, + "UpdateCapacityCommitment": { + "methods": [ + "update_capacity_commitment" + ] + }, + "UpdateReservation": { + "methods": [ + "update_reservation" + ] + } + } + } + } + } + } +} diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/gapic_version.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/gapic_version.py new file mode 100644 index 000000000000..20a9cd975b02 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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.0.0" # {x-release-please-version} diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/py.typed b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/py.typed new file mode 100644 index 000000000000..ff261ee1d848 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-bigquery-reservation package uses inline types. diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/__init__.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/__init__.py new file mode 100644 index 000000000000..cbf94b283c70 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/__init__.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/__init__.py new file mode 100644 index 000000000000..58f7130ab0b3 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 ReservationServiceClient +from .async_client import ReservationServiceAsyncClient + +__all__ = ( + 'ReservationServiceClient', + 'ReservationServiceAsyncClient', +) diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/async_client.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/async_client.py new file mode 100644 index 000000000000..2d47de243606 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/async_client.py @@ -0,0 +1,3824 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 logging as std_logging +from collections import OrderedDict +import re +from typing import Dict, Callable, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union +import warnings + +from google.cloud.bigquery_reservation_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_async as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore +import google.protobuf + + +try: + OptionalRetry = Union[retries.AsyncRetry, gapic_v1.method._MethodDefault, None] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.AsyncRetry, object, None] # type: ignore + +from google.cloud.bigquery_reservation_v1.services.reservation_service import pagers +from google.cloud.bigquery_reservation_v1.types import reservation +from google.cloud.bigquery_reservation_v1.types import reservation as gcbr_reservation +from google.iam.v1 import iam_policy_pb2 # type: ignore +from google.iam.v1 import policy_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 .transports.base import ReservationServiceTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import ReservationServiceGrpcAsyncIOTransport +from .client import ReservationServiceClient + +try: + from google.api_core import client_logging # type: ignore + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER +except ImportError: # pragma: NO COVER + CLIENT_LOGGING_SUPPORTED = False + +_LOGGER = std_logging.getLogger(__name__) + +class ReservationServiceAsyncClient: + """This API allows users to manage their BigQuery reservations. + + A reservation provides computational resource guarantees, in the + form of `slots `__, to + users. A slot is a unit of computational power in BigQuery, and + serves as the basic unit of parallelism. In a scan of a + multi-partitioned table, a single slot operates on a single + partition of the table. A reservation resource exists as a child + resource of the admin project and location, e.g.: + ``projects/myproject/locations/US/reservations/reservationName``. + + A capacity commitment is a way to purchase compute capacity for + BigQuery jobs (in the form of slots) with some committed period of + usage. A capacity commitment resource exists as a child resource of + the admin project and location, e.g.: + ``projects/myproject/locations/US/capacityCommitments/id``. + """ + + _client: ReservationServiceClient + + # Copy defaults from the synchronous client for use here. + # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. + DEFAULT_ENDPOINT = ReservationServiceClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = ReservationServiceClient.DEFAULT_MTLS_ENDPOINT + _DEFAULT_ENDPOINT_TEMPLATE = ReservationServiceClient._DEFAULT_ENDPOINT_TEMPLATE + _DEFAULT_UNIVERSE = ReservationServiceClient._DEFAULT_UNIVERSE + + assignment_path = staticmethod(ReservationServiceClient.assignment_path) + parse_assignment_path = staticmethod(ReservationServiceClient.parse_assignment_path) + bi_reservation_path = staticmethod(ReservationServiceClient.bi_reservation_path) + parse_bi_reservation_path = staticmethod(ReservationServiceClient.parse_bi_reservation_path) + capacity_commitment_path = staticmethod(ReservationServiceClient.capacity_commitment_path) + parse_capacity_commitment_path = staticmethod(ReservationServiceClient.parse_capacity_commitment_path) + reservation_path = staticmethod(ReservationServiceClient.reservation_path) + parse_reservation_path = staticmethod(ReservationServiceClient.parse_reservation_path) + reservation_group_path = staticmethod(ReservationServiceClient.reservation_group_path) + parse_reservation_group_path = staticmethod(ReservationServiceClient.parse_reservation_group_path) + common_billing_account_path = staticmethod(ReservationServiceClient.common_billing_account_path) + parse_common_billing_account_path = staticmethod(ReservationServiceClient.parse_common_billing_account_path) + common_folder_path = staticmethod(ReservationServiceClient.common_folder_path) + parse_common_folder_path = staticmethod(ReservationServiceClient.parse_common_folder_path) + common_organization_path = staticmethod(ReservationServiceClient.common_organization_path) + parse_common_organization_path = staticmethod(ReservationServiceClient.parse_common_organization_path) + common_project_path = staticmethod(ReservationServiceClient.common_project_path) + parse_common_project_path = staticmethod(ReservationServiceClient.parse_common_project_path) + common_location_path = staticmethod(ReservationServiceClient.common_location_path) + parse_common_location_path = staticmethod(ReservationServiceClient.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: + ReservationServiceAsyncClient: The constructed client. + """ + return ReservationServiceClient.from_service_account_info.__func__(ReservationServiceAsyncClient, 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: + ReservationServiceAsyncClient: The constructed client. + """ + return ReservationServiceClient.from_service_account_file.__func__(ReservationServiceAsyncClient, 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 ReservationServiceClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore + + @property + def transport(self) -> ReservationServiceTransport: + """Returns the transport used by the client instance. + + Returns: + ReservationServiceTransport: The transport used by the client instance. + """ + return self._client.transport + + @property + def api_endpoint(self): + """Return the API endpoint used by the client instance. + + Returns: + str: The API endpoint used by the client instance. + """ + return self._client._api_endpoint + + @property + def universe_domain(self) -> str: + """Return the universe domain used by the client instance. + + Returns: + str: The universe domain used + by the client instance. + """ + return self._client._universe_domain + + get_transport_class = ReservationServiceClient.get_transport_class + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[Union[str, ReservationServiceTransport, Callable[..., ReservationServiceTransport]]] = "grpc_asyncio", + client_options: Optional[ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the reservation service async 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 (Optional[Union[str,ReservationServiceTransport,Callable[..., ReservationServiceTransport]]]): + The transport to use, or a Callable that constructs and returns a new transport to use. + If a Callable is given, it will be called with the same set of initialization + arguments as used in the ReservationServiceTransport constructor. + 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. + + 1. The ``api_endpoint`` property can be used to override the + default endpoint provided by the client when ``transport`` is + not explicitly provided. Only if this property is not set and + ``transport`` was not explicitly provided, the endpoint is + determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment + variable, which have one of the following values: + "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). + + 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide a client certificate for mTLS 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. + + 3. The ``universe_domain`` property can be used to override the + default "googleapis.com" universe. Note that ``api_endpoint`` + property still takes precedence; and ``universe_domain`` is + currently not supported for mTLS. + + 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. + """ + self._client = ReservationServiceClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + + ) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(std_logging.DEBUG): # pragma: NO COVER + _LOGGER.debug( + "Created client `google.cloud.bigquery.reservation_v1.ReservationServiceAsyncClient`.", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "universeDomain": getattr(self._client._transport._credentials, "universe_domain", ""), + "credentialsType": f"{type(self._client._transport._credentials).__module__}.{type(self._client._transport._credentials).__qualname__}", + "credentialsInfo": getattr(self.transport._credentials, "get_cred_info", lambda: None)(), + } if hasattr(self._client._transport, "_credentials") else { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "credentialsType": None, + } + ) + + async def create_reservation(self, + request: Optional[Union[gcbr_reservation.CreateReservationRequest, dict]] = None, + *, + parent: Optional[str] = None, + reservation: Optional[gcbr_reservation.Reservation] = None, + reservation_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> gcbr_reservation.Reservation: + r"""Creates a new reservation 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 bigquery_reservation_v1 + + async def sample_create_reservation(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.CreateReservationRequest( + parent="parent_value", + ) + + # Make the request + response = await client.create_reservation(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.bigquery_reservation_v1.types.CreateReservationRequest, dict]]): + The request object. The request for + [ReservationService.CreateReservation][google.cloud.bigquery.reservation.v1.ReservationService.CreateReservation]. + parent (:class:`str`): + Required. Project, location. E.g., + ``projects/myproject/locations/US`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + reservation (:class:`google.cloud.bigquery_reservation_v1.types.Reservation`): + Definition of the new reservation to + create. + + This corresponds to the ``reservation`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + reservation_id (:class:`str`): + The reservation ID. It must only + contain lower case alphanumeric + characters or dashes. It must start with + a letter and must not end with a dash. + Its maximum length is 64 characters. + + This corresponds to the ``reservation_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.Reservation: + A reservation is a mechanism used to + guarantee slots to users. + + """ + # 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. + flattened_params = [parent, reservation, reservation_id] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.") + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, gcbr_reservation.CreateReservationRequest): + request = gcbr_reservation.CreateReservationRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if reservation is not None: + request.reservation = reservation + if reservation_id is not None: + request.reservation_id = reservation_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[self._client._transport.create_reservation] + + # 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), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def list_reservations(self, + request: Optional[Union[reservation.ListReservationsRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> pagers.ListReservationsAsyncPager: + r"""Lists all the reservations for the project in the + specified location. + + .. 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 bigquery_reservation_v1 + + async def sample_list_reservations(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.ListReservationsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_reservations(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.bigquery_reservation_v1.types.ListReservationsRequest, dict]]): + The request object. The request for + [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations]. + parent (:class:`str`): + Required. The parent resource name containing project + and location, e.g.: ``projects/myproject/locations/US`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListReservationsAsyncPager: + The response for + [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations]. + + 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. + flattened_params = [parent] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.") + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.ListReservationsRequest): + request = reservation.ListReservationsRequest(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._client._transport._wrapped_methods[self._client._transport.list_reservations] + + # 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), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # 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.ListReservationsAsyncPager( + method=rpc, + request=request, + response=response, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_reservation(self, + request: Optional[Union[reservation.GetReservationRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> reservation.Reservation: + r"""Returns information about the reservation. + + .. 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 bigquery_reservation_v1 + + async def sample_get_reservation(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.GetReservationRequest( + name="name_value", + ) + + # Make the request + response = await client.get_reservation(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.bigquery_reservation_v1.types.GetReservationRequest, dict]]): + The request object. The request for + [ReservationService.GetReservation][google.cloud.bigquery.reservation.v1.ReservationService.GetReservation]. + name (:class:`str`): + Required. Resource name of the reservation to retrieve. + E.g., + ``projects/myproject/locations/US/reservations/team1-prod`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.Reservation: + A reservation is a mechanism used to + guarantee slots to users. + + """ + # 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. + flattened_params = [name] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.") + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.GetReservationRequest): + request = reservation.GetReservationRequest(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._client._transport._wrapped_methods[self._client._transport.get_reservation] + + # 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), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def delete_reservation(self, + request: Optional[Union[reservation.DeleteReservationRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> None: + r"""Deletes a reservation. Returns + ``google.rpc.Code.FAILED_PRECONDITION`` when reservation has + assignments. + + .. 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 bigquery_reservation_v1 + + async def sample_delete_reservation(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.DeleteReservationRequest( + name="name_value", + ) + + # Make the request + await client.delete_reservation(request=request) + + Args: + request (Optional[Union[google.cloud.bigquery_reservation_v1.types.DeleteReservationRequest, dict]]): + The request object. The request for + [ReservationService.DeleteReservation][google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservation]. + name (:class:`str`): + Required. Resource name of the reservation to retrieve. + E.g., + ``projects/myproject/locations/US/reservations/team1-prod`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + """ + # 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. + flattened_params = [name] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.") + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.DeleteReservationRequest): + request = reservation.DeleteReservationRequest(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._client._transport._wrapped_methods[self._client._transport.delete_reservation] + + # 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), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + async def update_reservation(self, + request: Optional[Union[gcbr_reservation.UpdateReservationRequest, dict]] = None, + *, + reservation: Optional[gcbr_reservation.Reservation] = 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, Union[str, bytes]]] = (), + ) -> gcbr_reservation.Reservation: + r"""Updates an existing reservation 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 bigquery_reservation_v1 + + async def sample_update_reservation(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.UpdateReservationRequest( + ) + + # Make the request + response = await client.update_reservation(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.bigquery_reservation_v1.types.UpdateReservationRequest, dict]]): + The request object. The request for + [ReservationService.UpdateReservation][google.cloud.bigquery.reservation.v1.ReservationService.UpdateReservation]. + reservation (:class:`google.cloud.bigquery_reservation_v1.types.Reservation`): + Content of the reservation to update. + This corresponds to the ``reservation`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): + Standard field mask for the set of + fields to be updated. + + 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_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.Reservation: + A reservation is a mechanism used to + guarantee slots to users. + + """ + # 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. + flattened_params = [reservation, update_mask] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.") + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, gcbr_reservation.UpdateReservationRequest): + request = gcbr_reservation.UpdateReservationRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if reservation is not None: + request.reservation = reservation + 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._client._transport._wrapped_methods[self._client._transport.update_reservation] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("reservation.name", request.reservation.name), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def failover_reservation(self, + request: Optional[Union[reservation.FailoverReservationRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> reservation.Reservation: + r"""Fail over a reservation to the secondary location. The operation + should be done in the current secondary location, which will be + promoted to the new primary location for the reservation. + Attempting to failover a reservation in the current primary + location will fail with the error code + ``google.rpc.Code.FAILED_PRECONDITION``. + + .. 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 bigquery_reservation_v1 + + async def sample_failover_reservation(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.FailoverReservationRequest( + name="name_value", + ) + + # Make the request + response = await client.failover_reservation(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.bigquery_reservation_v1.types.FailoverReservationRequest, dict]]): + The request object. The request for + ReservationService.FailoverReservation. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.Reservation: + A reservation is a mechanism used to + guarantee slots to users. + + """ + # Create or coerce a protobuf request object. + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.FailoverReservationRequest): + request = reservation.FailoverReservationRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[self._client._transport.failover_reservation] + + # 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), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def create_capacity_commitment(self, + request: Optional[Union[reservation.CreateCapacityCommitmentRequest, dict]] = None, + *, + parent: Optional[str] = None, + capacity_commitment: Optional[reservation.CapacityCommitment] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> reservation.CapacityCommitment: + r"""Creates a new capacity commitment 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 bigquery_reservation_v1 + + async def sample_create_capacity_commitment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.CreateCapacityCommitmentRequest( + parent="parent_value", + ) + + # Make the request + response = await client.create_capacity_commitment(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.bigquery_reservation_v1.types.CreateCapacityCommitmentRequest, dict]]): + The request object. The request for + [ReservationService.CreateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.CreateCapacityCommitment]. + parent (:class:`str`): + Required. Resource name of the parent reservation. E.g., + ``projects/myproject/locations/US`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + capacity_commitment (:class:`google.cloud.bigquery_reservation_v1.types.CapacityCommitment`): + Content of the capacity commitment to + create. + + This corresponds to the ``capacity_commitment`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.CapacityCommitment: + Capacity commitment is a way to + purchase compute capacity for BigQuery + jobs (in the form of slots) with some + committed period of usage. Annual + commitments renew by default. + Commitments can be removed after their + commitment end time passes. + + In order to remove annual commitment, + its plan needs to be changed to monthly + or flex first. + + A capacity commitment resource exists as + a child resource of the admin project. + + """ + # 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. + flattened_params = [parent, capacity_commitment] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.") + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.CreateCapacityCommitmentRequest): + request = reservation.CreateCapacityCommitmentRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if capacity_commitment is not None: + request.capacity_commitment = capacity_commitment + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[self._client._transport.create_capacity_commitment] + + # 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), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def list_capacity_commitments(self, + request: Optional[Union[reservation.ListCapacityCommitmentsRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> pagers.ListCapacityCommitmentsAsyncPager: + r"""Lists all the capacity commitments for the admin + 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 bigquery_reservation_v1 + + async def sample_list_capacity_commitments(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.ListCapacityCommitmentsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_capacity_commitments(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsRequest, dict]]): + The request object. The request for + [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments]. + parent (:class:`str`): + Required. Resource name of the parent reservation. E.g., + ``projects/myproject/locations/US`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListCapacityCommitmentsAsyncPager: + The response for + [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments]. + + 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. + flattened_params = [parent] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.") + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.ListCapacityCommitmentsRequest): + request = reservation.ListCapacityCommitmentsRequest(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._client._transport._wrapped_methods[self._client._transport.list_capacity_commitments] + + # 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), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # 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.ListCapacityCommitmentsAsyncPager( + method=rpc, + request=request, + response=response, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_capacity_commitment(self, + request: Optional[Union[reservation.GetCapacityCommitmentRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> reservation.CapacityCommitment: + r"""Returns information about the capacity commitment. + + .. 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 bigquery_reservation_v1 + + async def sample_get_capacity_commitment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.GetCapacityCommitmentRequest( + name="name_value", + ) + + # Make the request + response = await client.get_capacity_commitment(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.bigquery_reservation_v1.types.GetCapacityCommitmentRequest, dict]]): + The request object. The request for + [ReservationService.GetCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitment]. + name (:class:`str`): + Required. Resource name of the capacity commitment to + retrieve. E.g., + ``projects/myproject/locations/US/capacityCommitments/123`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.CapacityCommitment: + Capacity commitment is a way to + purchase compute capacity for BigQuery + jobs (in the form of slots) with some + committed period of usage. Annual + commitments renew by default. + Commitments can be removed after their + commitment end time passes. + + In order to remove annual commitment, + its plan needs to be changed to monthly + or flex first. + + A capacity commitment resource exists as + a child resource of the admin project. + + """ + # 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. + flattened_params = [name] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.") + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.GetCapacityCommitmentRequest): + request = reservation.GetCapacityCommitmentRequest(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._client._transport._wrapped_methods[self._client._transport.get_capacity_commitment] + + # 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), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def delete_capacity_commitment(self, + request: Optional[Union[reservation.DeleteCapacityCommitmentRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> None: + r"""Deletes a capacity commitment. Attempting to delete capacity + commitment before its commitment_end_time will fail with the + error code ``google.rpc.Code.FAILED_PRECONDITION``. + + .. 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 bigquery_reservation_v1 + + async def sample_delete_capacity_commitment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.DeleteCapacityCommitmentRequest( + name="name_value", + ) + + # Make the request + await client.delete_capacity_commitment(request=request) + + Args: + request (Optional[Union[google.cloud.bigquery_reservation_v1.types.DeleteCapacityCommitmentRequest, dict]]): + The request object. The request for + [ReservationService.DeleteCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteCapacityCommitment]. + name (:class:`str`): + Required. Resource name of the capacity commitment to + delete. E.g., + ``projects/myproject/locations/US/capacityCommitments/123`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + """ + # 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. + flattened_params = [name] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.") + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.DeleteCapacityCommitmentRequest): + request = reservation.DeleteCapacityCommitmentRequest(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._client._transport._wrapped_methods[self._client._transport.delete_capacity_commitment] + + # 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), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + async def update_capacity_commitment(self, + request: Optional[Union[reservation.UpdateCapacityCommitmentRequest, dict]] = None, + *, + capacity_commitment: Optional[reservation.CapacityCommitment] = 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, Union[str, bytes]]] = (), + ) -> reservation.CapacityCommitment: + r"""Updates an existing capacity commitment. + + Only ``plan`` and ``renewal_plan`` fields can be updated. + + Plan can only be changed to a plan of a longer commitment + period. Attempting to change to a plan with shorter commitment + period will fail with the error code + ``google.rpc.Code.FAILED_PRECONDITION``. + + .. 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 bigquery_reservation_v1 + + async def sample_update_capacity_commitment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.UpdateCapacityCommitmentRequest( + ) + + # Make the request + response = await client.update_capacity_commitment(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.bigquery_reservation_v1.types.UpdateCapacityCommitmentRequest, dict]]): + The request object. The request for + [ReservationService.UpdateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateCapacityCommitment]. + capacity_commitment (:class:`google.cloud.bigquery_reservation_v1.types.CapacityCommitment`): + Content of the capacity commitment to + update. + + This corresponds to the ``capacity_commitment`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): + Standard field mask for the set of + fields to be updated. + + 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_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.CapacityCommitment: + Capacity commitment is a way to + purchase compute capacity for BigQuery + jobs (in the form of slots) with some + committed period of usage. Annual + commitments renew by default. + Commitments can be removed after their + commitment end time passes. + + In order to remove annual commitment, + its plan needs to be changed to monthly + or flex first. + + A capacity commitment resource exists as + a child resource of the admin project. + + """ + # 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. + flattened_params = [capacity_commitment, update_mask] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.") + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.UpdateCapacityCommitmentRequest): + request = reservation.UpdateCapacityCommitmentRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if capacity_commitment is not None: + request.capacity_commitment = capacity_commitment + 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._client._transport._wrapped_methods[self._client._transport.update_capacity_commitment] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("capacity_commitment.name", request.capacity_commitment.name), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def split_capacity_commitment(self, + request: Optional[Union[reservation.SplitCapacityCommitmentRequest, dict]] = None, + *, + name: Optional[str] = None, + slot_count: Optional[int] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> reservation.SplitCapacityCommitmentResponse: + r"""Splits capacity commitment to two commitments of the same plan + and ``commitment_end_time``. + + A common use case is to enable downgrading commitments. + + For example, in order to downgrade from 10000 slots to 8000, you + might split a 10000 capacity commitment into commitments of 2000 + and 8000. Then, you delete the first one after the commitment + end time passes. + + .. 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 bigquery_reservation_v1 + + async def sample_split_capacity_commitment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.SplitCapacityCommitmentRequest( + name="name_value", + ) + + # Make the request + response = await client.split_capacity_commitment(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.bigquery_reservation_v1.types.SplitCapacityCommitmentRequest, dict]]): + The request object. The request for + [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment]. + name (:class:`str`): + Required. The resource name e.g.,: + ``projects/myproject/locations/US/capacityCommitments/123`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + slot_count (:class:`int`): + Number of slots in the capacity + commitment after the split. + + This corresponds to the ``slot_count`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.SplitCapacityCommitmentResponse: + The response for + [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment]. + + """ + # 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. + flattened_params = [name, slot_count] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.") + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.SplitCapacityCommitmentRequest): + request = reservation.SplitCapacityCommitmentRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if slot_count is not None: + request.slot_count = slot_count + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[self._client._transport.split_capacity_commitment] + + # 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), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def merge_capacity_commitments(self, + request: Optional[Union[reservation.MergeCapacityCommitmentsRequest, dict]] = None, + *, + parent: Optional[str] = None, + capacity_commitment_ids: Optional[MutableSequence[str]] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> reservation.CapacityCommitment: + r"""Merges capacity commitments of the same plan into a single + commitment. + + The resulting capacity commitment has the greater + commitment_end_time out of the to-be-merged capacity + commitments. + + Attempting to merge capacity commitments of different plan will + fail with the error code + ``google.rpc.Code.FAILED_PRECONDITION``. + + .. 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 bigquery_reservation_v1 + + async def sample_merge_capacity_commitments(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.MergeCapacityCommitmentsRequest( + ) + + # Make the request + response = await client.merge_capacity_commitments(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.bigquery_reservation_v1.types.MergeCapacityCommitmentsRequest, dict]]): + The request object. The request for + [ReservationService.MergeCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.MergeCapacityCommitments]. + parent (:class:`str`): + Parent resource that identifies admin project and + location e.g., ``projects/myproject/locations/us`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + capacity_commitment_ids (:class:`MutableSequence[str]`): + Ids of capacity commitments to merge. + These capacity commitments must exist + under admin project and location + specified in the parent. + ID is the last portion of capacity + commitment name e.g., 'abc' for + projects/myproject/locations/US/capacityCommitments/abc + + This corresponds to the ``capacity_commitment_ids`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.CapacityCommitment: + Capacity commitment is a way to + purchase compute capacity for BigQuery + jobs (in the form of slots) with some + committed period of usage. Annual + commitments renew by default. + Commitments can be removed after their + commitment end time passes. + + In order to remove annual commitment, + its plan needs to be changed to monthly + or flex first. + + A capacity commitment resource exists as + a child resource of the admin project. + + """ + # 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. + flattened_params = [parent, capacity_commitment_ids] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.") + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.MergeCapacityCommitmentsRequest): + request = reservation.MergeCapacityCommitmentsRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if capacity_commitment_ids: + request.capacity_commitment_ids.extend(capacity_commitment_ids) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[self._client._transport.merge_capacity_commitments] + + # 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), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def create_assignment(self, + request: Optional[Union[reservation.CreateAssignmentRequest, dict]] = None, + *, + parent: Optional[str] = None, + assignment: Optional[reservation.Assignment] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> reservation.Assignment: + r"""Creates an assignment object which allows the given project to + submit jobs of a certain type using slots from the specified + reservation. + + Currently a resource (project, folder, organization) can only + have one assignment per each (job_type, location) combination, + and that reservation will be used for all jobs of the matching + type. + + Different assignments can be created on different levels of the + projects, folders or organization hierarchy. During query + execution, the assignment is looked up at the project, folder + and organization levels in that order. The first assignment + found is applied to the query. + + When creating assignments, it does not matter if other + assignments exist at higher levels. + + Example: + + - The organization ``organizationA`` contains two projects, + ``project1`` and ``project2``. + - Assignments for all three entities (``organizationA``, + ``project1``, and ``project2``) could all be created and + mapped to the same or different reservations. + + "None" assignments represent an absence of the assignment. + Projects assigned to None use on-demand pricing. To create a + "None" assignment, use "none" as a reservation_id in the parent. + Example parent: + ``projects/myproject/locations/US/reservations/none``. + + Returns ``google.rpc.Code.PERMISSION_DENIED`` if user does not + have 'bigquery.admin' permissions on the project using the + reservation and the project that owns this reservation. + + Returns ``google.rpc.Code.INVALID_ARGUMENT`` when location of + the assignment does not match location of the reservation. + + .. 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 bigquery_reservation_v1 + + async def sample_create_assignment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.CreateAssignmentRequest( + parent="parent_value", + ) + + # Make the request + response = await client.create_assignment(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.bigquery_reservation_v1.types.CreateAssignmentRequest, dict]]): + The request object. The request for + [ReservationService.CreateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.CreateAssignment]. + Note: "bigquery.reservationAssignments.create" + permission is required on the related assignee. + parent (:class:`str`): + Required. The parent resource name of the assignment + E.g. + ``projects/myproject/locations/US/reservations/team1-prod`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + assignment (:class:`google.cloud.bigquery_reservation_v1.types.Assignment`): + Assignment resource to create. + This corresponds to the ``assignment`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.Assignment: + An assignment allows a project to + submit jobs of a certain type using + slots from the specified reservation. + + """ + # 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. + flattened_params = [parent, assignment] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.") + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.CreateAssignmentRequest): + request = reservation.CreateAssignmentRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if assignment is not None: + request.assignment = assignment + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[self._client._transport.create_assignment] + + # 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), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def list_assignments(self, + request: Optional[Union[reservation.ListAssignmentsRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> pagers.ListAssignmentsAsyncPager: + r"""Lists assignments. + + Only explicitly created assignments will be returned. + + Example: + + - Organization ``organizationA`` contains two projects, + ``project1`` and ``project2``. + - Reservation ``res1`` exists and was created previously. + - CreateAssignment was used previously to define the following + associations between entities and reservations: + ```` and ```` + + In this example, ListAssignments will just return the above two + assignments for reservation ``res1``, and no expansion/merge + will happen. + + The wildcard "-" can be used for reservations in the request. In + that case all assignments belongs to the specified project and + location will be listed. + + **Note** "-" cannot be used for projects nor locations. + + .. 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 bigquery_reservation_v1 + + async def sample_list_assignments(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.ListAssignmentsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_assignments(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.bigquery_reservation_v1.types.ListAssignmentsRequest, dict]]): + The request object. The request for + [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments]. + parent (:class:`str`): + Required. The parent resource name e.g.: + + ``projects/myproject/locations/US/reservations/team1-prod`` + + Or: + + ``projects/myproject/locations/US/reservations/-`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListAssignmentsAsyncPager: + The response for + [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments]. + + 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. + flattened_params = [parent] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.") + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.ListAssignmentsRequest): + request = reservation.ListAssignmentsRequest(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._client._transport._wrapped_methods[self._client._transport.list_assignments] + + # 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), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # 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.ListAssignmentsAsyncPager( + method=rpc, + request=request, + response=response, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def delete_assignment(self, + request: Optional[Union[reservation.DeleteAssignmentRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> None: + r"""Deletes a assignment. No expansion will happen. + + Example: + + - Organization ``organizationA`` contains two projects, + ``project1`` and ``project2``. + - Reservation ``res1`` exists and was created previously. + - CreateAssignment was used previously to define the following + associations between entities and reservations: + ```` and ```` + + In this example, deletion of the ```` + assignment won't affect the other assignment + ````. After said deletion, queries from + ``project1`` will still use ``res1`` while queries from + ``project2`` will switch to use on-demand mode. + + .. 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 bigquery_reservation_v1 + + async def sample_delete_assignment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.DeleteAssignmentRequest( + name="name_value", + ) + + # Make the request + await client.delete_assignment(request=request) + + Args: + request (Optional[Union[google.cloud.bigquery_reservation_v1.types.DeleteAssignmentRequest, dict]]): + The request object. The request for + [ReservationService.DeleteAssignment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteAssignment]. + Note: "bigquery.reservationAssignments.delete" + permission is required on the related assignee. + name (:class:`str`): + Required. Name of the resource, e.g. + ``projects/myproject/locations/US/reservations/team1-prod/assignments/123`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + """ + # 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. + flattened_params = [name] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.") + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.DeleteAssignmentRequest): + request = reservation.DeleteAssignmentRequest(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._client._transport._wrapped_methods[self._client._transport.delete_assignment] + + # 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), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + async def search_assignments(self, + request: Optional[Union[reservation.SearchAssignmentsRequest, dict]] = None, + *, + parent: Optional[str] = None, + query: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> pagers.SearchAssignmentsAsyncPager: + r"""Deprecated: Looks up assignments for a specified resource for a + particular region. If the request is about a project: + + 1. Assignments created on the project will be returned if they + exist. + 2. Otherwise assignments created on the closest ancestor will be + returned. + 3. Assignments for different JobTypes will all be returned. + + The same logic applies if the request is about a folder. + + If the request is about an organization, then assignments + created on the organization will be returned (organization + doesn't have ancestors). + + Comparing to ListAssignments, there are some behavior + differences: + + 1. permission on the assignee will be verified in this API. + 2. Hierarchy lookup (project->folder->organization) happens in + this API. + 3. Parent here is ``projects/*/locations/*``, instead of + ``projects/*/locations/*reservations/*``. + + **Note** "-" cannot be used for projects nor locations. + + .. 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 bigquery_reservation_v1 + + async def sample_search_assignments(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.SearchAssignmentsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.search_assignments(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.bigquery_reservation_v1.types.SearchAssignmentsRequest, dict]]): + The request object. The request for + [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. + Note: "bigquery.reservationAssignments.search" + permission is required on the related assignee. + parent (:class:`str`): + Required. The resource name of the admin + project(containing project and location), e.g.: + ``projects/myproject/locations/US``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + query (:class:`str`): + Please specify resource name as assignee in the query. + + Examples: + + - ``assignee=projects/myproject`` + - ``assignee=folders/123`` + - ``assignee=organizations/456`` + + This corresponds to the ``query`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.SearchAssignmentsAsyncPager: + The response for + [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + warnings.warn("ReservationServiceAsyncClient.search_assignments is deprecated", + DeprecationWarning) + + # 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. + flattened_params = [parent, query] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.") + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.SearchAssignmentsRequest): + request = reservation.SearchAssignmentsRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if query is not None: + request.query = query + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[self._client._transport.search_assignments] + + # 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), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # 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.SearchAssignmentsAsyncPager( + method=rpc, + request=request, + response=response, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def search_all_assignments(self, + request: Optional[Union[reservation.SearchAllAssignmentsRequest, dict]] = None, + *, + parent: Optional[str] = None, + query: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> pagers.SearchAllAssignmentsAsyncPager: + r"""Looks up assignments for a specified resource for a particular + region. If the request is about a project: + + 1. Assignments created on the project will be returned if they + exist. + 2. Otherwise assignments created on the closest ancestor will be + returned. + 3. Assignments for different JobTypes will all be returned. + + The same logic applies if the request is about a folder. + + If the request is about an organization, then assignments + created on the organization will be returned (organization + doesn't have ancestors). + + Comparing to ListAssignments, there are some behavior + differences: + + 1. permission on the assignee will be verified in this API. + 2. Hierarchy lookup (project->folder->organization) happens in + this API. + 3. Parent here is ``projects/*/locations/*``, instead of + ``projects/*/locations/*reservations/*``. + + .. 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 bigquery_reservation_v1 + + async def sample_search_all_assignments(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.SearchAllAssignmentsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.search_all_assignments(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsRequest, dict]]): + The request object. The request for + [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. + Note: "bigquery.reservationAssignments.search" + permission is required on the related assignee. + parent (:class:`str`): + Required. The resource name with location (project name + could be the wildcard '-'), e.g.: + ``projects/-/locations/US``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + query (:class:`str`): + Please specify resource name as assignee in the query. + + Examples: + + - ``assignee=projects/myproject`` + - ``assignee=folders/123`` + - ``assignee=organizations/456`` + + This corresponds to the ``query`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.SearchAllAssignmentsAsyncPager: + The response for + [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. + + 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. + flattened_params = [parent, query] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.") + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.SearchAllAssignmentsRequest): + request = reservation.SearchAllAssignmentsRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if query is not None: + request.query = query + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[self._client._transport.search_all_assignments] + + # 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), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # 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.SearchAllAssignmentsAsyncPager( + method=rpc, + request=request, + response=response, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def move_assignment(self, + request: Optional[Union[reservation.MoveAssignmentRequest, dict]] = None, + *, + name: Optional[str] = None, + destination_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> reservation.Assignment: + r"""Moves an assignment under a new reservation. + + This differs from removing an existing assignment and + recreating a new one by providing a transactional change + that ensures an assignee always has an associated + reservation. + + .. 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 bigquery_reservation_v1 + + async def sample_move_assignment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.MoveAssignmentRequest( + name="name_value", + ) + + # Make the request + response = await client.move_assignment(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.bigquery_reservation_v1.types.MoveAssignmentRequest, dict]]): + The request object. The request for + [ReservationService.MoveAssignment][google.cloud.bigquery.reservation.v1.ReservationService.MoveAssignment]. + + **Note**: "bigquery.reservationAssignments.create" + permission is required on the destination_id. + + **Note**: "bigquery.reservationAssignments.create" and + "bigquery.reservationAssignments.delete" permission are + required on the related assignee. + name (:class:`str`): + Required. The resource name of the assignment, e.g. + ``projects/myproject/locations/US/reservations/team1-prod/assignments/123`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + destination_id (:class:`str`): + The new reservation ID, e.g.: + ``projects/myotherproject/locations/US/reservations/team2-prod`` + + This corresponds to the ``destination_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.Assignment: + An assignment allows a project to + submit jobs of a certain type using + slots from the specified reservation. + + """ + # 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. + flattened_params = [name, destination_id] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.") + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.MoveAssignmentRequest): + request = reservation.MoveAssignmentRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if destination_id is not None: + request.destination_id = destination_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[self._client._transport.move_assignment] + + # 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), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def update_assignment(self, + request: Optional[Union[reservation.UpdateAssignmentRequest, dict]] = None, + *, + assignment: Optional[reservation.Assignment] = 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, Union[str, bytes]]] = (), + ) -> reservation.Assignment: + r"""Updates an existing assignment. + + Only the ``priority`` field can be updated. + + .. 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 bigquery_reservation_v1 + + async def sample_update_assignment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.UpdateAssignmentRequest( + ) + + # Make the request + response = await client.update_assignment(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.bigquery_reservation_v1.types.UpdateAssignmentRequest, dict]]): + The request object. The request for + [ReservationService.UpdateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateAssignment]. + assignment (:class:`google.cloud.bigquery_reservation_v1.types.Assignment`): + Content of the assignment to update. + This corresponds to the ``assignment`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): + Standard field mask for the set of + fields to be updated. + + 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_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.Assignment: + An assignment allows a project to + submit jobs of a certain type using + slots from the specified reservation. + + """ + # 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. + flattened_params = [assignment, update_mask] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.") + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.UpdateAssignmentRequest): + request = reservation.UpdateAssignmentRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if assignment is not None: + request.assignment = assignment + 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._client._transport._wrapped_methods[self._client._transport.update_assignment] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("assignment.name", request.assignment.name), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_bi_reservation(self, + request: Optional[Union[reservation.GetBiReservationRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> reservation.BiReservation: + r"""Retrieves a BI reservation. + + .. 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 bigquery_reservation_v1 + + async def sample_get_bi_reservation(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.GetBiReservationRequest( + name="name_value", + ) + + # Make the request + response = await client.get_bi_reservation(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.bigquery_reservation_v1.types.GetBiReservationRequest, dict]]): + The request object. A request to get a singleton BI + reservation. + name (:class:`str`): + Required. Name of the requested reservation, for + example: + ``projects/{project_id}/locations/{location_id}/biReservation`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.BiReservation: + Represents a BI Reservation. + """ + # 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. + flattened_params = [name] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.") + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.GetBiReservationRequest): + request = reservation.GetBiReservationRequest(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._client._transport._wrapped_methods[self._client._transport.get_bi_reservation] + + # 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), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def update_bi_reservation(self, + request: Optional[Union[reservation.UpdateBiReservationRequest, dict]] = None, + *, + bi_reservation: Optional[reservation.BiReservation] = 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, Union[str, bytes]]] = (), + ) -> reservation.BiReservation: + r"""Updates a BI reservation. + + Only fields specified in the ``field_mask`` are updated. + + A singleton BI reservation always exists with default size 0. In + order to reserve BI capacity it needs to be updated to an amount + greater than 0. In order to release BI capacity reservation size + must be set to 0. + + .. 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 bigquery_reservation_v1 + + async def sample_update_bi_reservation(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.UpdateBiReservationRequest( + ) + + # Make the request + response = await client.update_bi_reservation(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.bigquery_reservation_v1.types.UpdateBiReservationRequest, dict]]): + The request object. A request to update a BI reservation. + bi_reservation (:class:`google.cloud.bigquery_reservation_v1.types.BiReservation`): + A reservation to update. + This corresponds to the ``bi_reservation`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): + A list of fields to be updated in + this request. + + 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_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.BiReservation: + Represents a BI Reservation. + """ + # 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. + flattened_params = [bi_reservation, update_mask] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.") + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.UpdateBiReservationRequest): + request = reservation.UpdateBiReservationRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if bi_reservation is not None: + request.bi_reservation = bi_reservation + 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._client._transport._wrapped_methods[self._client._transport.update_bi_reservation] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("bi_reservation.name", request.bi_reservation.name), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_iam_policy(self, + request: Optional[Union[iam_policy_pb2.GetIamPolicyRequest, dict]] = None, + *, + resource: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> policy_pb2.Policy: + r"""Gets the access control policy for a resource. May return: + + - A\ ``NOT_FOUND`` error if the resource doesn't exist or you + don't have the permission to view it. + - An empty policy if the resource exists but doesn't have a set + policy. + + Supported resources are: + + - Reservations + - ReservationAssignments + + To call this method, you must have the following Google IAM + permissions: + + - ``bigqueryreservation.reservations.getIamPolicy`` to get + policies on reservations. + + .. 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 bigquery_reservation_v1 + from google.iam.v1 import iam_policy_pb2 # type: ignore + + async def sample_get_iam_policy(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = iam_policy_pb2.GetIamPolicyRequest( + resource="resource_value", + ) + + # Make the request + response = await client.get_iam_policy(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]]): + The request object. Request message for ``GetIamPolicy`` method. + resource (:class:`str`): + REQUIRED: The resource for which the + policy is being requested. See the + operation documentation for the + appropriate value for this field. + + This corresponds to the ``resource`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.iam.v1.policy_pb2.Policy: + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. + + A Policy is a collection of bindings. A binding binds + one or more members, or principals, to a single role. + Principals can be user accounts, service accounts, + Google groups, and domains (such as G Suite). A role + is a named list of permissions; each role can be an + IAM predefined role or a user-created custom role. + + For some types of Google Cloud resources, a binding + can also specify a condition, which is a logical + expression that allows access to a resource only if + the expression evaluates to true. A condition can add + constraints based on attributes of the request, the + resource, or both. To learn which resources support + conditions in their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + + **JSON example:** + + :literal:`` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }`\ \` + + **YAML example:** + + :literal:`` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3`\ \` + + For a description of IAM and its features, see the + [IAM + documentation](https://cloud.google.com/iam/docs/). + + """ + # 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. + flattened_params = [resource] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.") + + # - The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = iam_policy_pb2.GetIamPolicyRequest(**request) + elif not request: + request = iam_policy_pb2.GetIamPolicyRequest(resource=resource) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[self._client._transport.get_iam_policy] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("resource", request.resource), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def set_iam_policy(self, + request: Optional[Union[iam_policy_pb2.SetIamPolicyRequest, dict]] = None, + *, + resource: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> policy_pb2.Policy: + r"""Sets an access control policy for a resource. Replaces any + existing policy. + + Supported resources are: + + - Reservations + + To call this method, you must have the following Google IAM + permissions: + + - ``bigqueryreservation.reservations.setIamPolicy`` to set + policies on reservations. + + .. 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 bigquery_reservation_v1 + from google.iam.v1 import iam_policy_pb2 # type: ignore + + async def sample_set_iam_policy(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = iam_policy_pb2.SetIamPolicyRequest( + resource="resource_value", + ) + + # Make the request + response = await client.set_iam_policy(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]]): + The request object. Request message for ``SetIamPolicy`` method. + resource (:class:`str`): + REQUIRED: The resource for which the + policy is being specified. See the + operation documentation for the + appropriate value for this field. + + This corresponds to the ``resource`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.iam.v1.policy_pb2.Policy: + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. + + A Policy is a collection of bindings. A binding binds + one or more members, or principals, to a single role. + Principals can be user accounts, service accounts, + Google groups, and domains (such as G Suite). A role + is a named list of permissions; each role can be an + IAM predefined role or a user-created custom role. + + For some types of Google Cloud resources, a binding + can also specify a condition, which is a logical + expression that allows access to a resource only if + the expression evaluates to true. A condition can add + constraints based on attributes of the request, the + resource, or both. To learn which resources support + conditions in their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + + **JSON example:** + + :literal:`` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }`\ \` + + **YAML example:** + + :literal:`` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3`\ \` + + For a description of IAM and its features, see the + [IAM + documentation](https://cloud.google.com/iam/docs/). + + """ + # 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. + flattened_params = [resource] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.") + + # - The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = iam_policy_pb2.SetIamPolicyRequest(**request) + elif not request: + request = iam_policy_pb2.SetIamPolicyRequest(resource=resource) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[self._client._transport.set_iam_policy] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("resource", request.resource), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def test_iam_permissions(self, + request: Optional[Union[iam_policy_pb2.TestIamPermissionsRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> iam_policy_pb2.TestIamPermissionsResponse: + r"""Gets your permissions on a resource. Returns an empty + set of permissions if the resource doesn't exist. + + Supported resources are: + + - Reservations + + No Google IAM permissions are required to call this + method. + + .. 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 bigquery_reservation_v1 + from google.iam.v1 import iam_policy_pb2 # type: ignore + + async def sample_test_iam_permissions(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = iam_policy_pb2.TestIamPermissionsRequest( + resource="resource_value", + permissions=['permissions_value1', 'permissions_value2'], + ) + + # Make the request + response = await client.test_iam_permissions(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]]): + The request object. Request message for ``TestIamPermissions`` method. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse: + Response message for TestIamPermissions 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 = iam_policy_pb2.TestIamPermissionsRequest(**request) + elif not request: + request = iam_policy_pb2.TestIamPermissionsRequest() + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[self._client._transport.test_iam_permissions] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("resource", request.resource), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def create_reservation_group(self, + request: Optional[Union[reservation.CreateReservationGroupRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> reservation.ReservationGroup: + r"""Creates a new reservation group. + + .. 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 bigquery_reservation_v1 + + async def sample_create_reservation_group(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.CreateReservationGroupRequest( + parent="parent_value", + reservation_group_id="reservation_group_id_value", + ) + + # Make the request + response = await client.create_reservation_group(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.bigquery_reservation_v1.types.CreateReservationGroupRequest, dict]]): + The request object. The request for + [ReservationService.CreateReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.CreateReservationGroup]. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.ReservationGroup: + A reservation group is a container + for reservations. + + """ + # Create or coerce a protobuf request object. + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.CreateReservationGroupRequest): + request = reservation.CreateReservationGroupRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[self._client._transport.create_reservation_group] + + # 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), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_reservation_group(self, + request: Optional[Union[reservation.GetReservationGroupRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> reservation.ReservationGroup: + r"""Returns information about the reservation group. + + .. 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 bigquery_reservation_v1 + + async def sample_get_reservation_group(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.GetReservationGroupRequest( + name="name_value", + ) + + # Make the request + response = await client.get_reservation_group(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.bigquery_reservation_v1.types.GetReservationGroupRequest, dict]]): + The request object. The request for + [ReservationService.GetReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.GetReservationGroup]. + name (:class:`str`): + Required. Resource name of the reservation group to + retrieve. E.g., + ``projects/myproject/locations/US/reservationGroups/team1-prod`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.ReservationGroup: + A reservation group is a container + for reservations. + + """ + # 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. + flattened_params = [name] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.") + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.GetReservationGroupRequest): + request = reservation.GetReservationGroupRequest(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._client._transport._wrapped_methods[self._client._transport.get_reservation_group] + + # 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), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def delete_reservation_group(self, + request: Optional[Union[reservation.DeleteReservationGroupRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> None: + r"""Deletes a reservation. Returns + ``google.rpc.Code.FAILED_PRECONDITION`` when reservation has + assignments. + + .. 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 bigquery_reservation_v1 + + async def sample_delete_reservation_group(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.DeleteReservationGroupRequest( + name="name_value", + ) + + # Make the request + await client.delete_reservation_group(request=request) + + Args: + request (Optional[Union[google.cloud.bigquery_reservation_v1.types.DeleteReservationGroupRequest, dict]]): + The request object. The request for + [ReservationService.DeleteReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservationGroup]. + name (:class:`str`): + Required. Resource name of the reservation group to + retrieve. E.g., + ``projects/myproject/locations/US/reservationGroups/team1-prod`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + """ + # 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. + flattened_params = [name] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.") + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.DeleteReservationGroupRequest): + request = reservation.DeleteReservationGroupRequest(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._client._transport._wrapped_methods[self._client._transport.delete_reservation_group] + + # 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), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + async def list_reservation_groups(self, + request: Optional[Union[reservation.ListReservationGroupsRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> pagers.ListReservationGroupsAsyncPager: + r"""Lists all the reservation groups for the project in + the specified location. + + .. 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 bigquery_reservation_v1 + + async def sample_list_reservation_groups(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.ListReservationGroupsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_reservation_groups(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.bigquery_reservation_v1.types.ListReservationGroupsRequest, dict]]): + The request object. The request for + [ReservationService.ListReservationGroups][google.cloud.bigquery.reservation.v1.ReservationService.ListReservationGroups]. + parent (:class:`str`): + Required. The parent resource name containing project + and location, e.g.: ``projects/myproject/locations/US`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListReservationGroupsAsyncPager: + The response for + [ReservationService.ListReservationGroups][google.cloud.bigquery.reservation.v1.ReservationService.ListReservationGroups]. + + 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. + flattened_params = [parent] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.") + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.ListReservationGroupsRequest): + request = reservation.ListReservationGroupsRequest(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._client._transport._wrapped_methods[self._client._transport.list_reservation_groups] + + # 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), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # 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.ListReservationGroupsAsyncPager( + method=rpc, + request=request, + response=response, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def __aenter__(self) -> "ReservationServiceAsyncClient": + 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__) + +if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER + DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ + + +__all__ = ( + "ReservationServiceAsyncClient", +) diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/client.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/client.py new file mode 100644 index 000000000000..19e7a6d485e6 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/client.py @@ -0,0 +1,4203 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 http import HTTPStatus +import json +import logging as std_logging +import os +import re +from typing import Dict, Callable, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast +import warnings + +from google.cloud.bigquery_reservation_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 +import google.protobuf + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object, None] # type: ignore + +try: + from google.api_core import client_logging # type: ignore + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER +except ImportError: # pragma: NO COVER + CLIENT_LOGGING_SUPPORTED = False + +_LOGGER = std_logging.getLogger(__name__) + +from google.cloud.bigquery_reservation_v1.services.reservation_service import pagers +from google.cloud.bigquery_reservation_v1.types import reservation +from google.cloud.bigquery_reservation_v1.types import reservation as gcbr_reservation +from google.iam.v1 import iam_policy_pb2 # type: ignore +from google.iam.v1 import policy_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 .transports.base import ReservationServiceTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import ReservationServiceGrpcTransport +from .transports.grpc_asyncio import ReservationServiceGrpcAsyncIOTransport +from .transports.rest import ReservationServiceRestTransport + + +class ReservationServiceClientMeta(type): + """Metaclass for the ReservationService 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[ReservationServiceTransport]] + _transport_registry["grpc"] = ReservationServiceGrpcTransport + _transport_registry["grpc_asyncio"] = ReservationServiceGrpcAsyncIOTransport + _transport_registry["rest"] = ReservationServiceRestTransport + + def get_transport_class(cls, + label: Optional[str] = None, + ) -> Type[ReservationServiceTransport]: + """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 ReservationServiceClient(metaclass=ReservationServiceClientMeta): + """This API allows users to manage their BigQuery reservations. + + A reservation provides computational resource guarantees, in the + form of `slots `__, to + users. A slot is a unit of computational power in BigQuery, and + serves as the basic unit of parallelism. In a scan of a + multi-partitioned table, a single slot operates on a single + partition of the table. A reservation resource exists as a child + resource of the admin project and location, e.g.: + ``projects/myproject/locations/US/reservations/reservationName``. + + A capacity commitment is a way to purchase compute capacity for + BigQuery jobs (in the form of slots) with some committed period of + usage. A capacity commitment resource exists as a child resource of + the admin project and location, e.g.: + ``projects/myproject/locations/US/capacityCommitments/id``. + """ + + @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") + + # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. + DEFAULT_ENDPOINT = "bigqueryreservation.googleapis.com" + DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore + DEFAULT_ENDPOINT + ) + + _DEFAULT_ENDPOINT_TEMPLATE = "bigqueryreservation.{UNIVERSE_DOMAIN}" + _DEFAULT_UNIVERSE = "googleapis.com" + + @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: + ReservationServiceClient: 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: + ReservationServiceClient: 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) -> ReservationServiceTransport: + """Returns the transport used by the client instance. + + Returns: + ReservationServiceTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def assignment_path(project: str,location: str,reservation: str,assignment: str,) -> str: + """Returns a fully-qualified assignment string.""" + return "projects/{project}/locations/{location}/reservations/{reservation}/assignments/{assignment}".format(project=project, location=location, reservation=reservation, assignment=assignment, ) + + @staticmethod + def parse_assignment_path(path: str) -> Dict[str,str]: + """Parses a assignment path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/reservations/(?P.+?)/assignments/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def bi_reservation_path(project: str,location: str,) -> str: + """Returns a fully-qualified bi_reservation string.""" + return "projects/{project}/locations/{location}/biReservation".format(project=project, location=location, ) + + @staticmethod + def parse_bi_reservation_path(path: str) -> Dict[str,str]: + """Parses a bi_reservation path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/biReservation$", path) + return m.groupdict() if m else {} + + @staticmethod + def capacity_commitment_path(project: str,location: str,capacity_commitment: str,) -> str: + """Returns a fully-qualified capacity_commitment string.""" + return "projects/{project}/locations/{location}/capacityCommitments/{capacity_commitment}".format(project=project, location=location, capacity_commitment=capacity_commitment, ) + + @staticmethod + def parse_capacity_commitment_path(path: str) -> Dict[str,str]: + """Parses a capacity_commitment path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/capacityCommitments/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def reservation_path(project: str,location: str,reservation: str,) -> str: + """Returns a fully-qualified reservation string.""" + return "projects/{project}/locations/{location}/reservations/{reservation}".format(project=project, location=location, reservation=reservation, ) + + @staticmethod + def parse_reservation_path(path: str) -> Dict[str,str]: + """Parses a reservation path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/reservations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def reservation_group_path(project: str,location: str,reservation_group: str,) -> str: + """Returns a fully-qualified reservation_group string.""" + return "projects/{project}/locations/{location}/reservationGroups/{reservation_group}".format(project=project, location=location, reservation_group=reservation_group, ) + + @staticmethod + def parse_reservation_group_path(path: str) -> Dict[str,str]: + """Parses a reservation_group path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/reservationGroups/(?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): + """Deprecated. 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. + """ + + warnings.warn("get_mtls_endpoint_and_cert_source is deprecated. Use the api_endpoint property instead.", + DeprecationWarning) + 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 + + @staticmethod + def _read_environment_variables(): + """Returns the environment variables used by the client. + + Returns: + Tuple[bool, str, str]: returns the GOOGLE_API_USE_CLIENT_CERTIFICATE, + GOOGLE_API_USE_MTLS_ENDPOINT, and GOOGLE_CLOUD_UNIVERSE_DOMAIN environment variables. + + Raises: + ValueError: If GOOGLE_API_USE_CLIENT_CERTIFICATE is not + any of ["true", "false"]. + google.auth.exceptions.MutualTLSChannelError: If GOOGLE_API_USE_MTLS_ENDPOINT + is not any of ["auto", "never", "always"]. + """ + use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false").lower() + use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto").lower() + universe_domain_env = os.getenv("GOOGLE_CLOUD_UNIVERSE_DOMAIN") + 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`") + return use_client_cert == "true", use_mtls_endpoint, universe_domain_env + + @staticmethod + def _get_client_cert_source(provided_cert_source, use_cert_flag): + """Return the client cert source to be used by the client. + + Args: + provided_cert_source (bytes): The client certificate source provided. + use_cert_flag (bool): A flag indicating whether to use the client certificate. + + Returns: + bytes or None: The client cert source to be used by the client. + """ + client_cert_source = None + if use_cert_flag: + if provided_cert_source: + client_cert_source = provided_cert_source + elif mtls.has_default_client_cert_source(): + client_cert_source = mtls.default_client_cert_source() + return client_cert_source + + @staticmethod + def _get_api_endpoint(api_override, client_cert_source, universe_domain, use_mtls_endpoint): + """Return the API endpoint used by the client. + + Args: + api_override (str): The API endpoint override. If specified, this is always + the return value of this function and the other arguments are not used. + client_cert_source (bytes): The client certificate source used by the client. + universe_domain (str): The universe domain used by the client. + use_mtls_endpoint (str): How to use the mTLS endpoint, which depends also on the other parameters. + Possible values are "always", "auto", or "never". + + Returns: + str: The API endpoint to be used by the client. + """ + if api_override is not None: + api_endpoint = api_override + elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): + _default_universe = ReservationServiceClient._DEFAULT_UNIVERSE + if universe_domain != _default_universe: + raise MutualTLSChannelError(f"mTLS is not supported in any universe other than {_default_universe}.") + api_endpoint = ReservationServiceClient.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = ReservationServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=universe_domain) + return api_endpoint + + @staticmethod + def _get_universe_domain(client_universe_domain: Optional[str], universe_domain_env: Optional[str]) -> str: + """Return the universe domain used by the client. + + Args: + client_universe_domain (Optional[str]): The universe domain configured via the client options. + universe_domain_env (Optional[str]): The universe domain configured via the "GOOGLE_CLOUD_UNIVERSE_DOMAIN" environment variable. + + Returns: + str: The universe domain to be used by the client. + + Raises: + ValueError: If the universe domain is an empty string. + """ + universe_domain = ReservationServiceClient._DEFAULT_UNIVERSE + if client_universe_domain is not None: + universe_domain = client_universe_domain + elif universe_domain_env is not None: + universe_domain = universe_domain_env + if len(universe_domain.strip()) == 0: + raise ValueError("Universe Domain cannot be an empty string.") + return universe_domain + + def _validate_universe_domain(self): + """Validates client's and credentials' universe domains are consistent. + + Returns: + bool: True iff the configured universe domain is valid. + + Raises: + ValueError: If the configured universe domain is not valid. + """ + + # NOTE (b/349488459): universe validation is disabled until further notice. + return True + + def _add_cred_info_for_auth_errors( + self, + error: core_exceptions.GoogleAPICallError + ) -> None: + """Adds credential info string to error details for 401/403/404 errors. + + Args: + error (google.api_core.exceptions.GoogleAPICallError): The error to add the cred info. + """ + if error.code not in [HTTPStatus.UNAUTHORIZED, HTTPStatus.FORBIDDEN, HTTPStatus.NOT_FOUND]: + return + + cred = self._transport._credentials + + # get_cred_info is only available in google-auth>=2.35.0 + if not hasattr(cred, "get_cred_info"): + return + + # ignore the type check since pypy test fails when get_cred_info + # is not available + cred_info = cred.get_cred_info() # type: ignore + if cred_info and hasattr(error._details, "append"): + error._details.append(json.dumps(cred_info)) + + @property + def api_endpoint(self): + """Return the API endpoint used by the client instance. + + Returns: + str: The API endpoint used by the client instance. + """ + return self._api_endpoint + + @property + def universe_domain(self) -> str: + """Return the universe domain used by the client instance. + + Returns: + str: The universe domain used by the client instance. + """ + return self._universe_domain + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[Union[str, ReservationServiceTransport, Callable[..., ReservationServiceTransport]]] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the reservation service 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 (Optional[Union[str,ReservationServiceTransport,Callable[..., ReservationServiceTransport]]]): + The transport to use, or a Callable that constructs and returns a new transport. + If a Callable is given, it will be called with the same set of initialization + arguments as used in the ReservationServiceTransport constructor. + 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. + + 1. The ``api_endpoint`` property can be used to override the + default endpoint provided by the client when ``transport`` is + not explicitly provided. Only if this property is not set and + ``transport`` was not explicitly provided, the endpoint is + determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment + variable, which have one of the following values: + "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). + + 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide a client certificate for mTLS 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. + + 3. The ``universe_domain`` property can be used to override the + default "googleapis.com" universe. Note that the ``api_endpoint`` + property still takes precedence; and ``universe_domain`` is + currently not supported for mTLS. + + 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. + """ + self._client_options = client_options + if isinstance(self._client_options, dict): + self._client_options = client_options_lib.from_dict(self._client_options) + if self._client_options is None: + self._client_options = client_options_lib.ClientOptions() + self._client_options = cast(client_options_lib.ClientOptions, self._client_options) + + universe_domain_opt = getattr(self._client_options, 'universe_domain', None) + + self._use_client_cert, self._use_mtls_endpoint, self._universe_domain_env = ReservationServiceClient._read_environment_variables() + self._client_cert_source = ReservationServiceClient._get_client_cert_source(self._client_options.client_cert_source, self._use_client_cert) + self._universe_domain = ReservationServiceClient._get_universe_domain(universe_domain_opt, self._universe_domain_env) + self._api_endpoint = None # updated below, depending on `transport` + + # Initialize the universe domain validation. + self._is_universe_domain_valid = False + + if CLIENT_LOGGING_SUPPORTED: # pragma: NO COVER + # Setup logging. + client_logging.initialize_logging() + + api_key_value = getattr(self._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. + transport_provided = isinstance(transport, ReservationServiceTransport) + if transport_provided: + # transport is a ReservationServiceTransport instance. + if credentials or self._client_options.credentials_file or api_key_value: + raise ValueError("When providing a transport instance, " + "provide its credentials directly.") + if self._client_options.scopes: + raise ValueError( + "When providing a transport instance, provide its scopes " + "directly." + ) + self._transport = cast(ReservationServiceTransport, transport) + self._api_endpoint = self._transport.host + + self._api_endpoint = (self._api_endpoint or + ReservationServiceClient._get_api_endpoint( + self._client_options.api_endpoint, + self._client_cert_source, + self._universe_domain, + self._use_mtls_endpoint)) + + if not transport_provided: + 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_init: Union[Type[ReservationServiceTransport], Callable[..., ReservationServiceTransport]] = ( + ReservationServiceClient.get_transport_class(transport) + if isinstance(transport, str) or transport is None + else cast(Callable[..., ReservationServiceTransport], transport) + ) + # initialize with the provided callable or the passed in class + self._transport = transport_init( + credentials=credentials, + credentials_file=self._client_options.credentials_file, + host=self._api_endpoint, + scopes=self._client_options.scopes, + client_cert_source_for_mtls=self._client_cert_source, + quota_project_id=self._client_options.quota_project_id, + client_info=client_info, + always_use_jwt_access=True, + api_audience=self._client_options.api_audience, + ) + + if "async" not in str(self._transport): + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(std_logging.DEBUG): # pragma: NO COVER + _LOGGER.debug( + "Created client `google.cloud.bigquery.reservation_v1.ReservationServiceClient`.", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "universeDomain": getattr(self._transport._credentials, "universe_domain", ""), + "credentialsType": f"{type(self._transport._credentials).__module__}.{type(self._transport._credentials).__qualname__}", + "credentialsInfo": getattr(self.transport._credentials, "get_cred_info", lambda: None)(), + } if hasattr(self._transport, "_credentials") else { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "credentialsType": None, + } + ) + + def create_reservation(self, + request: Optional[Union[gcbr_reservation.CreateReservationRequest, dict]] = None, + *, + parent: Optional[str] = None, + reservation: Optional[gcbr_reservation.Reservation] = None, + reservation_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> gcbr_reservation.Reservation: + r"""Creates a new reservation 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 bigquery_reservation_v1 + + def sample_create_reservation(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.CreateReservationRequest( + parent="parent_value", + ) + + # Make the request + response = client.create_reservation(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.CreateReservationRequest, dict]): + The request object. The request for + [ReservationService.CreateReservation][google.cloud.bigquery.reservation.v1.ReservationService.CreateReservation]. + parent (str): + Required. Project, location. E.g., + ``projects/myproject/locations/US`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + reservation (google.cloud.bigquery_reservation_v1.types.Reservation): + Definition of the new reservation to + create. + + This corresponds to the ``reservation`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + reservation_id (str): + The reservation ID. It must only + contain lower case alphanumeric + characters or dashes. It must start with + a letter and must not end with a dash. + Its maximum length is 64 characters. + + This corresponds to the ``reservation_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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.Reservation: + A reservation is a mechanism used to + guarantee slots to users. + + """ + # 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. + flattened_params = [parent, reservation, reservation_id] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.') + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, gcbr_reservation.CreateReservationRequest): + request = gcbr_reservation.CreateReservationRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if reservation is not None: + request.reservation = reservation + if reservation_id is not None: + request.reservation_id = reservation_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_reservation] + + # 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), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def list_reservations(self, + request: Optional[Union[reservation.ListReservationsRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> pagers.ListReservationsPager: + r"""Lists all the reservations for the project in the + specified location. + + .. 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 bigquery_reservation_v1 + + def sample_list_reservations(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.ListReservationsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_reservations(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.ListReservationsRequest, dict]): + The request object. The request for + [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations]. + parent (str): + Required. The parent resource name containing project + and location, e.g.: ``projects/myproject/locations/US`` + + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListReservationsPager: + The response for + [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations]. + + 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. + flattened_params = [parent] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.') + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.ListReservationsRequest): + request = reservation.ListReservationsRequest(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_reservations] + + # 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), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # 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.ListReservationsPager( + method=rpc, + request=request, + response=response, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_reservation(self, + request: Optional[Union[reservation.GetReservationRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> reservation.Reservation: + r"""Returns information about the reservation. + + .. 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 bigquery_reservation_v1 + + def sample_get_reservation(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.GetReservationRequest( + name="name_value", + ) + + # Make the request + response = client.get_reservation(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.GetReservationRequest, dict]): + The request object. The request for + [ReservationService.GetReservation][google.cloud.bigquery.reservation.v1.ReservationService.GetReservation]. + name (str): + Required. Resource name of the reservation to retrieve. + E.g., + ``projects/myproject/locations/US/reservations/team1-prod`` + + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.Reservation: + A reservation is a mechanism used to + guarantee slots to users. + + """ + # 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. + flattened_params = [name] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.') + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.GetReservationRequest): + request = reservation.GetReservationRequest(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_reservation] + + # 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), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def delete_reservation(self, + request: Optional[Union[reservation.DeleteReservationRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> None: + r"""Deletes a reservation. Returns + ``google.rpc.Code.FAILED_PRECONDITION`` when reservation has + assignments. + + .. 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 bigquery_reservation_v1 + + def sample_delete_reservation(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.DeleteReservationRequest( + name="name_value", + ) + + # Make the request + client.delete_reservation(request=request) + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.DeleteReservationRequest, dict]): + The request object. The request for + [ReservationService.DeleteReservation][google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservation]. + name (str): + Required. Resource name of the reservation to retrieve. + E.g., + ``projects/myproject/locations/US/reservations/team1-prod`` + + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + """ + # 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. + flattened_params = [name] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.') + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.DeleteReservationRequest): + request = reservation.DeleteReservationRequest(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_reservation] + + # 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), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + def update_reservation(self, + request: Optional[Union[gcbr_reservation.UpdateReservationRequest, dict]] = None, + *, + reservation: Optional[gcbr_reservation.Reservation] = 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, Union[str, bytes]]] = (), + ) -> gcbr_reservation.Reservation: + r"""Updates an existing reservation 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 bigquery_reservation_v1 + + def sample_update_reservation(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.UpdateReservationRequest( + ) + + # Make the request + response = client.update_reservation(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.UpdateReservationRequest, dict]): + The request object. The request for + [ReservationService.UpdateReservation][google.cloud.bigquery.reservation.v1.ReservationService.UpdateReservation]. + reservation (google.cloud.bigquery_reservation_v1.types.Reservation): + Content of the reservation to update. + This corresponds to the ``reservation`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Standard field mask for the set of + fields to be updated. + + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.Reservation: + A reservation is a mechanism used to + guarantee slots to users. + + """ + # 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. + flattened_params = [reservation, update_mask] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.') + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, gcbr_reservation.UpdateReservationRequest): + request = gcbr_reservation.UpdateReservationRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if reservation is not None: + request.reservation = reservation + 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_reservation] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("reservation.name", request.reservation.name), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def failover_reservation(self, + request: Optional[Union[reservation.FailoverReservationRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> reservation.Reservation: + r"""Fail over a reservation to the secondary location. The operation + should be done in the current secondary location, which will be + promoted to the new primary location for the reservation. + Attempting to failover a reservation in the current primary + location will fail with the error code + ``google.rpc.Code.FAILED_PRECONDITION``. + + .. 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 bigquery_reservation_v1 + + def sample_failover_reservation(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.FailoverReservationRequest( + name="name_value", + ) + + # Make the request + response = client.failover_reservation(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.FailoverReservationRequest, dict]): + The request object. The request for + ReservationService.FailoverReservation. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.Reservation: + A reservation is a mechanism used to + guarantee slots to users. + + """ + # Create or coerce a protobuf request object. + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.FailoverReservationRequest): + request = reservation.FailoverReservationRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.failover_reservation] + + # 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), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def create_capacity_commitment(self, + request: Optional[Union[reservation.CreateCapacityCommitmentRequest, dict]] = None, + *, + parent: Optional[str] = None, + capacity_commitment: Optional[reservation.CapacityCommitment] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> reservation.CapacityCommitment: + r"""Creates a new capacity commitment 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 bigquery_reservation_v1 + + def sample_create_capacity_commitment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.CreateCapacityCommitmentRequest( + parent="parent_value", + ) + + # Make the request + response = client.create_capacity_commitment(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.CreateCapacityCommitmentRequest, dict]): + The request object. The request for + [ReservationService.CreateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.CreateCapacityCommitment]. + parent (str): + Required. Resource name of the parent reservation. E.g., + ``projects/myproject/locations/US`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + capacity_commitment (google.cloud.bigquery_reservation_v1.types.CapacityCommitment): + Content of the capacity commitment to + create. + + This corresponds to the ``capacity_commitment`` 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.CapacityCommitment: + Capacity commitment is a way to + purchase compute capacity for BigQuery + jobs (in the form of slots) with some + committed period of usage. Annual + commitments renew by default. + Commitments can be removed after their + commitment end time passes. + + In order to remove annual commitment, + its plan needs to be changed to monthly + or flex first. + + A capacity commitment resource exists as + a child resource of the admin project. + + """ + # 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. + flattened_params = [parent, capacity_commitment] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.') + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.CreateCapacityCommitmentRequest): + request = reservation.CreateCapacityCommitmentRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if capacity_commitment is not None: + request.capacity_commitment = capacity_commitment + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_capacity_commitment] + + # 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), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def list_capacity_commitments(self, + request: Optional[Union[reservation.ListCapacityCommitmentsRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> pagers.ListCapacityCommitmentsPager: + r"""Lists all the capacity commitments for the admin + 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 bigquery_reservation_v1 + + def sample_list_capacity_commitments(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.ListCapacityCommitmentsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_capacity_commitments(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsRequest, dict]): + The request object. The request for + [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments]. + parent (str): + Required. Resource name of the parent reservation. E.g., + ``projects/myproject/locations/US`` + + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListCapacityCommitmentsPager: + The response for + [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments]. + + 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. + flattened_params = [parent] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.') + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.ListCapacityCommitmentsRequest): + request = reservation.ListCapacityCommitmentsRequest(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_capacity_commitments] + + # 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), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # 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.ListCapacityCommitmentsPager( + method=rpc, + request=request, + response=response, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_capacity_commitment(self, + request: Optional[Union[reservation.GetCapacityCommitmentRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> reservation.CapacityCommitment: + r"""Returns information about the capacity commitment. + + .. 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 bigquery_reservation_v1 + + def sample_get_capacity_commitment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.GetCapacityCommitmentRequest( + name="name_value", + ) + + # Make the request + response = client.get_capacity_commitment(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.GetCapacityCommitmentRequest, dict]): + The request object. The request for + [ReservationService.GetCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitment]. + name (str): + Required. Resource name of the capacity commitment to + retrieve. E.g., + ``projects/myproject/locations/US/capacityCommitments/123`` + + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.CapacityCommitment: + Capacity commitment is a way to + purchase compute capacity for BigQuery + jobs (in the form of slots) with some + committed period of usage. Annual + commitments renew by default. + Commitments can be removed after their + commitment end time passes. + + In order to remove annual commitment, + its plan needs to be changed to monthly + or flex first. + + A capacity commitment resource exists as + a child resource of the admin project. + + """ + # 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. + flattened_params = [name] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.') + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.GetCapacityCommitmentRequest): + request = reservation.GetCapacityCommitmentRequest(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_capacity_commitment] + + # 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), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def delete_capacity_commitment(self, + request: Optional[Union[reservation.DeleteCapacityCommitmentRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> None: + r"""Deletes a capacity commitment. Attempting to delete capacity + commitment before its commitment_end_time will fail with the + error code ``google.rpc.Code.FAILED_PRECONDITION``. + + .. 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 bigquery_reservation_v1 + + def sample_delete_capacity_commitment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.DeleteCapacityCommitmentRequest( + name="name_value", + ) + + # Make the request + client.delete_capacity_commitment(request=request) + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.DeleteCapacityCommitmentRequest, dict]): + The request object. The request for + [ReservationService.DeleteCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteCapacityCommitment]. + name (str): + Required. Resource name of the capacity commitment to + delete. E.g., + ``projects/myproject/locations/US/capacityCommitments/123`` + + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + """ + # 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. + flattened_params = [name] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.') + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.DeleteCapacityCommitmentRequest): + request = reservation.DeleteCapacityCommitmentRequest(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_capacity_commitment] + + # 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), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + def update_capacity_commitment(self, + request: Optional[Union[reservation.UpdateCapacityCommitmentRequest, dict]] = None, + *, + capacity_commitment: Optional[reservation.CapacityCommitment] = 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, Union[str, bytes]]] = (), + ) -> reservation.CapacityCommitment: + r"""Updates an existing capacity commitment. + + Only ``plan`` and ``renewal_plan`` fields can be updated. + + Plan can only be changed to a plan of a longer commitment + period. Attempting to change to a plan with shorter commitment + period will fail with the error code + ``google.rpc.Code.FAILED_PRECONDITION``. + + .. 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 bigquery_reservation_v1 + + def sample_update_capacity_commitment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.UpdateCapacityCommitmentRequest( + ) + + # Make the request + response = client.update_capacity_commitment(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.UpdateCapacityCommitmentRequest, dict]): + The request object. The request for + [ReservationService.UpdateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateCapacityCommitment]. + capacity_commitment (google.cloud.bigquery_reservation_v1.types.CapacityCommitment): + Content of the capacity commitment to + update. + + This corresponds to the ``capacity_commitment`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Standard field mask for the set of + fields to be updated. + + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.CapacityCommitment: + Capacity commitment is a way to + purchase compute capacity for BigQuery + jobs (in the form of slots) with some + committed period of usage. Annual + commitments renew by default. + Commitments can be removed after their + commitment end time passes. + + In order to remove annual commitment, + its plan needs to be changed to monthly + or flex first. + + A capacity commitment resource exists as + a child resource of the admin project. + + """ + # 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. + flattened_params = [capacity_commitment, update_mask] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.') + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.UpdateCapacityCommitmentRequest): + request = reservation.UpdateCapacityCommitmentRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if capacity_commitment is not None: + request.capacity_commitment = capacity_commitment + 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_capacity_commitment] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("capacity_commitment.name", request.capacity_commitment.name), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def split_capacity_commitment(self, + request: Optional[Union[reservation.SplitCapacityCommitmentRequest, dict]] = None, + *, + name: Optional[str] = None, + slot_count: Optional[int] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> reservation.SplitCapacityCommitmentResponse: + r"""Splits capacity commitment to two commitments of the same plan + and ``commitment_end_time``. + + A common use case is to enable downgrading commitments. + + For example, in order to downgrade from 10000 slots to 8000, you + might split a 10000 capacity commitment into commitments of 2000 + and 8000. Then, you delete the first one after the commitment + end time passes. + + .. 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 bigquery_reservation_v1 + + def sample_split_capacity_commitment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.SplitCapacityCommitmentRequest( + name="name_value", + ) + + # Make the request + response = client.split_capacity_commitment(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.SplitCapacityCommitmentRequest, dict]): + The request object. The request for + [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment]. + name (str): + Required. The resource name e.g.,: + ``projects/myproject/locations/US/capacityCommitments/123`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + slot_count (int): + Number of slots in the capacity + commitment after the split. + + This corresponds to the ``slot_count`` 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.SplitCapacityCommitmentResponse: + The response for + [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment]. + + """ + # 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. + flattened_params = [name, slot_count] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.') + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.SplitCapacityCommitmentRequest): + request = reservation.SplitCapacityCommitmentRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if slot_count is not None: + request.slot_count = slot_count + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.split_capacity_commitment] + + # 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), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def merge_capacity_commitments(self, + request: Optional[Union[reservation.MergeCapacityCommitmentsRequest, dict]] = None, + *, + parent: Optional[str] = None, + capacity_commitment_ids: Optional[MutableSequence[str]] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> reservation.CapacityCommitment: + r"""Merges capacity commitments of the same plan into a single + commitment. + + The resulting capacity commitment has the greater + commitment_end_time out of the to-be-merged capacity + commitments. + + Attempting to merge capacity commitments of different plan will + fail with the error code + ``google.rpc.Code.FAILED_PRECONDITION``. + + .. 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 bigquery_reservation_v1 + + def sample_merge_capacity_commitments(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.MergeCapacityCommitmentsRequest( + ) + + # Make the request + response = client.merge_capacity_commitments(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.MergeCapacityCommitmentsRequest, dict]): + The request object. The request for + [ReservationService.MergeCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.MergeCapacityCommitments]. + parent (str): + Parent resource that identifies admin project and + location e.g., ``projects/myproject/locations/us`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + capacity_commitment_ids (MutableSequence[str]): + Ids of capacity commitments to merge. + These capacity commitments must exist + under admin project and location + specified in the parent. + ID is the last portion of capacity + commitment name e.g., 'abc' for + projects/myproject/locations/US/capacityCommitments/abc + + This corresponds to the ``capacity_commitment_ids`` 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.CapacityCommitment: + Capacity commitment is a way to + purchase compute capacity for BigQuery + jobs (in the form of slots) with some + committed period of usage. Annual + commitments renew by default. + Commitments can be removed after their + commitment end time passes. + + In order to remove annual commitment, + its plan needs to be changed to monthly + or flex first. + + A capacity commitment resource exists as + a child resource of the admin project. + + """ + # 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. + flattened_params = [parent, capacity_commitment_ids] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.') + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.MergeCapacityCommitmentsRequest): + request = reservation.MergeCapacityCommitmentsRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if capacity_commitment_ids is not None: + request.capacity_commitment_ids = capacity_commitment_ids + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.merge_capacity_commitments] + + # 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), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def create_assignment(self, + request: Optional[Union[reservation.CreateAssignmentRequest, dict]] = None, + *, + parent: Optional[str] = None, + assignment: Optional[reservation.Assignment] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> reservation.Assignment: + r"""Creates an assignment object which allows the given project to + submit jobs of a certain type using slots from the specified + reservation. + + Currently a resource (project, folder, organization) can only + have one assignment per each (job_type, location) combination, + and that reservation will be used for all jobs of the matching + type. + + Different assignments can be created on different levels of the + projects, folders or organization hierarchy. During query + execution, the assignment is looked up at the project, folder + and organization levels in that order. The first assignment + found is applied to the query. + + When creating assignments, it does not matter if other + assignments exist at higher levels. + + Example: + + - The organization ``organizationA`` contains two projects, + ``project1`` and ``project2``. + - Assignments for all three entities (``organizationA``, + ``project1``, and ``project2``) could all be created and + mapped to the same or different reservations. + + "None" assignments represent an absence of the assignment. + Projects assigned to None use on-demand pricing. To create a + "None" assignment, use "none" as a reservation_id in the parent. + Example parent: + ``projects/myproject/locations/US/reservations/none``. + + Returns ``google.rpc.Code.PERMISSION_DENIED`` if user does not + have 'bigquery.admin' permissions on the project using the + reservation and the project that owns this reservation. + + Returns ``google.rpc.Code.INVALID_ARGUMENT`` when location of + the assignment does not match location of the reservation. + + .. 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 bigquery_reservation_v1 + + def sample_create_assignment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.CreateAssignmentRequest( + parent="parent_value", + ) + + # Make the request + response = client.create_assignment(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.CreateAssignmentRequest, dict]): + The request object. The request for + [ReservationService.CreateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.CreateAssignment]. + Note: "bigquery.reservationAssignments.create" + permission is required on the related assignee. + parent (str): + Required. The parent resource name of the assignment + E.g. + ``projects/myproject/locations/US/reservations/team1-prod`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + assignment (google.cloud.bigquery_reservation_v1.types.Assignment): + Assignment resource to create. + This corresponds to the ``assignment`` 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.Assignment: + An assignment allows a project to + submit jobs of a certain type using + slots from the specified reservation. + + """ + # 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. + flattened_params = [parent, assignment] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.') + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.CreateAssignmentRequest): + request = reservation.CreateAssignmentRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if assignment is not None: + request.assignment = assignment + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_assignment] + + # 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), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def list_assignments(self, + request: Optional[Union[reservation.ListAssignmentsRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> pagers.ListAssignmentsPager: + r"""Lists assignments. + + Only explicitly created assignments will be returned. + + Example: + + - Organization ``organizationA`` contains two projects, + ``project1`` and ``project2``. + - Reservation ``res1`` exists and was created previously. + - CreateAssignment was used previously to define the following + associations between entities and reservations: + ```` and ```` + + In this example, ListAssignments will just return the above two + assignments for reservation ``res1``, and no expansion/merge + will happen. + + The wildcard "-" can be used for reservations in the request. In + that case all assignments belongs to the specified project and + location will be listed. + + **Note** "-" cannot be used for projects nor locations. + + .. 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 bigquery_reservation_v1 + + def sample_list_assignments(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.ListAssignmentsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_assignments(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.ListAssignmentsRequest, dict]): + The request object. The request for + [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments]. + parent (str): + Required. The parent resource name e.g.: + + ``projects/myproject/locations/US/reservations/team1-prod`` + + Or: + + ``projects/myproject/locations/US/reservations/-`` + + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListAssignmentsPager: + The response for + [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments]. + + 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. + flattened_params = [parent] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.') + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.ListAssignmentsRequest): + request = reservation.ListAssignmentsRequest(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_assignments] + + # 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), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # 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.ListAssignmentsPager( + method=rpc, + request=request, + response=response, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def delete_assignment(self, + request: Optional[Union[reservation.DeleteAssignmentRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> None: + r"""Deletes a assignment. No expansion will happen. + + Example: + + - Organization ``organizationA`` contains two projects, + ``project1`` and ``project2``. + - Reservation ``res1`` exists and was created previously. + - CreateAssignment was used previously to define the following + associations between entities and reservations: + ```` and ```` + + In this example, deletion of the ```` + assignment won't affect the other assignment + ````. After said deletion, queries from + ``project1`` will still use ``res1`` while queries from + ``project2`` will switch to use on-demand mode. + + .. 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 bigquery_reservation_v1 + + def sample_delete_assignment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.DeleteAssignmentRequest( + name="name_value", + ) + + # Make the request + client.delete_assignment(request=request) + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.DeleteAssignmentRequest, dict]): + The request object. The request for + [ReservationService.DeleteAssignment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteAssignment]. + Note: "bigquery.reservationAssignments.delete" + permission is required on the related assignee. + name (str): + Required. Name of the resource, e.g. + ``projects/myproject/locations/US/reservations/team1-prod/assignments/123`` + + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + """ + # 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. + flattened_params = [name] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.') + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.DeleteAssignmentRequest): + request = reservation.DeleteAssignmentRequest(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_assignment] + + # 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), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + def search_assignments(self, + request: Optional[Union[reservation.SearchAssignmentsRequest, dict]] = None, + *, + parent: Optional[str] = None, + query: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> pagers.SearchAssignmentsPager: + r"""Deprecated: Looks up assignments for a specified resource for a + particular region. If the request is about a project: + + 1. Assignments created on the project will be returned if they + exist. + 2. Otherwise assignments created on the closest ancestor will be + returned. + 3. Assignments for different JobTypes will all be returned. + + The same logic applies if the request is about a folder. + + If the request is about an organization, then assignments + created on the organization will be returned (organization + doesn't have ancestors). + + Comparing to ListAssignments, there are some behavior + differences: + + 1. permission on the assignee will be verified in this API. + 2. Hierarchy lookup (project->folder->organization) happens in + this API. + 3. Parent here is ``projects/*/locations/*``, instead of + ``projects/*/locations/*reservations/*``. + + **Note** "-" cannot be used for projects nor locations. + + .. 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 bigquery_reservation_v1 + + def sample_search_assignments(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.SearchAssignmentsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.search_assignments(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.SearchAssignmentsRequest, dict]): + The request object. The request for + [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. + Note: "bigquery.reservationAssignments.search" + permission is required on the related assignee. + parent (str): + Required. The resource name of the admin + project(containing project and location), e.g.: + ``projects/myproject/locations/US``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + query (str): + Please specify resource name as assignee in the query. + + Examples: + + - ``assignee=projects/myproject`` + - ``assignee=folders/123`` + - ``assignee=organizations/456`` + + This corresponds to the ``query`` 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.SearchAssignmentsPager: + The response for + [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + warnings.warn("ReservationServiceClient.search_assignments is deprecated", + DeprecationWarning) + + # 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. + flattened_params = [parent, query] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.') + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.SearchAssignmentsRequest): + request = reservation.SearchAssignmentsRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if query is not None: + request.query = query + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.search_assignments] + + # 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), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # 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.SearchAssignmentsPager( + method=rpc, + request=request, + response=response, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def search_all_assignments(self, + request: Optional[Union[reservation.SearchAllAssignmentsRequest, dict]] = None, + *, + parent: Optional[str] = None, + query: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> pagers.SearchAllAssignmentsPager: + r"""Looks up assignments for a specified resource for a particular + region. If the request is about a project: + + 1. Assignments created on the project will be returned if they + exist. + 2. Otherwise assignments created on the closest ancestor will be + returned. + 3. Assignments for different JobTypes will all be returned. + + The same logic applies if the request is about a folder. + + If the request is about an organization, then assignments + created on the organization will be returned (organization + doesn't have ancestors). + + Comparing to ListAssignments, there are some behavior + differences: + + 1. permission on the assignee will be verified in this API. + 2. Hierarchy lookup (project->folder->organization) happens in + this API. + 3. Parent here is ``projects/*/locations/*``, instead of + ``projects/*/locations/*reservations/*``. + + .. 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 bigquery_reservation_v1 + + def sample_search_all_assignments(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.SearchAllAssignmentsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.search_all_assignments(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsRequest, dict]): + The request object. The request for + [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. + Note: "bigquery.reservationAssignments.search" + permission is required on the related assignee. + parent (str): + Required. The resource name with location (project name + could be the wildcard '-'), e.g.: + ``projects/-/locations/US``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + query (str): + Please specify resource name as assignee in the query. + + Examples: + + - ``assignee=projects/myproject`` + - ``assignee=folders/123`` + - ``assignee=organizations/456`` + + This corresponds to the ``query`` 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.SearchAllAssignmentsPager: + The response for + [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. + + 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. + flattened_params = [parent, query] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.') + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.SearchAllAssignmentsRequest): + request = reservation.SearchAllAssignmentsRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if query is not None: + request.query = query + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.search_all_assignments] + + # 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), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # 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.SearchAllAssignmentsPager( + method=rpc, + request=request, + response=response, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def move_assignment(self, + request: Optional[Union[reservation.MoveAssignmentRequest, dict]] = None, + *, + name: Optional[str] = None, + destination_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> reservation.Assignment: + r"""Moves an assignment under a new reservation. + + This differs from removing an existing assignment and + recreating a new one by providing a transactional change + that ensures an assignee always has an associated + reservation. + + .. 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 bigquery_reservation_v1 + + def sample_move_assignment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.MoveAssignmentRequest( + name="name_value", + ) + + # Make the request + response = client.move_assignment(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.MoveAssignmentRequest, dict]): + The request object. The request for + [ReservationService.MoveAssignment][google.cloud.bigquery.reservation.v1.ReservationService.MoveAssignment]. + + **Note**: "bigquery.reservationAssignments.create" + permission is required on the destination_id. + + **Note**: "bigquery.reservationAssignments.create" and + "bigquery.reservationAssignments.delete" permission are + required on the related assignee. + name (str): + Required. The resource name of the assignment, e.g. + ``projects/myproject/locations/US/reservations/team1-prod/assignments/123`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + destination_id (str): + The new reservation ID, e.g.: + ``projects/myotherproject/locations/US/reservations/team2-prod`` + + This corresponds to the ``destination_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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.Assignment: + An assignment allows a project to + submit jobs of a certain type using + slots from the specified reservation. + + """ + # 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. + flattened_params = [name, destination_id] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.') + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.MoveAssignmentRequest): + request = reservation.MoveAssignmentRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if destination_id is not None: + request.destination_id = destination_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.move_assignment] + + # 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), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def update_assignment(self, + request: Optional[Union[reservation.UpdateAssignmentRequest, dict]] = None, + *, + assignment: Optional[reservation.Assignment] = 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, Union[str, bytes]]] = (), + ) -> reservation.Assignment: + r"""Updates an existing assignment. + + Only the ``priority`` field can be updated. + + .. 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 bigquery_reservation_v1 + + def sample_update_assignment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.UpdateAssignmentRequest( + ) + + # Make the request + response = client.update_assignment(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.UpdateAssignmentRequest, dict]): + The request object. The request for + [ReservationService.UpdateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateAssignment]. + assignment (google.cloud.bigquery_reservation_v1.types.Assignment): + Content of the assignment to update. + This corresponds to the ``assignment`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Standard field mask for the set of + fields to be updated. + + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.Assignment: + An assignment allows a project to + submit jobs of a certain type using + slots from the specified reservation. + + """ + # 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. + flattened_params = [assignment, update_mask] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.') + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.UpdateAssignmentRequest): + request = reservation.UpdateAssignmentRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if assignment is not None: + request.assignment = assignment + 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_assignment] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("assignment.name", request.assignment.name), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_bi_reservation(self, + request: Optional[Union[reservation.GetBiReservationRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> reservation.BiReservation: + r"""Retrieves a BI reservation. + + .. 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 bigquery_reservation_v1 + + def sample_get_bi_reservation(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.GetBiReservationRequest( + name="name_value", + ) + + # Make the request + response = client.get_bi_reservation(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.GetBiReservationRequest, dict]): + The request object. A request to get a singleton BI + reservation. + name (str): + Required. Name of the requested reservation, for + example: + ``projects/{project_id}/locations/{location_id}/biReservation`` + + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.BiReservation: + Represents a BI Reservation. + """ + # 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. + flattened_params = [name] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.') + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.GetBiReservationRequest): + request = reservation.GetBiReservationRequest(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_bi_reservation] + + # 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), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def update_bi_reservation(self, + request: Optional[Union[reservation.UpdateBiReservationRequest, dict]] = None, + *, + bi_reservation: Optional[reservation.BiReservation] = 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, Union[str, bytes]]] = (), + ) -> reservation.BiReservation: + r"""Updates a BI reservation. + + Only fields specified in the ``field_mask`` are updated. + + A singleton BI reservation always exists with default size 0. In + order to reserve BI capacity it needs to be updated to an amount + greater than 0. In order to release BI capacity reservation size + must be set to 0. + + .. 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 bigquery_reservation_v1 + + def sample_update_bi_reservation(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.UpdateBiReservationRequest( + ) + + # Make the request + response = client.update_bi_reservation(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.UpdateBiReservationRequest, dict]): + The request object. A request to update a BI reservation. + bi_reservation (google.cloud.bigquery_reservation_v1.types.BiReservation): + A reservation to update. + This corresponds to the ``bi_reservation`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + A list of fields to be updated in + this request. + + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.BiReservation: + Represents a BI Reservation. + """ + # 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. + flattened_params = [bi_reservation, update_mask] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.') + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.UpdateBiReservationRequest): + request = reservation.UpdateBiReservationRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if bi_reservation is not None: + request.bi_reservation = bi_reservation + 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_bi_reservation] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("bi_reservation.name", request.bi_reservation.name), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_iam_policy(self, + request: Optional[Union[iam_policy_pb2.GetIamPolicyRequest, dict]] = None, + *, + resource: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> policy_pb2.Policy: + r"""Gets the access control policy for a resource. May return: + + - A\ ``NOT_FOUND`` error if the resource doesn't exist or you + don't have the permission to view it. + - An empty policy if the resource exists but doesn't have a set + policy. + + Supported resources are: + + - Reservations + - ReservationAssignments + + To call this method, you must have the following Google IAM + permissions: + + - ``bigqueryreservation.reservations.getIamPolicy`` to get + policies on reservations. + + .. 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 bigquery_reservation_v1 + from google.iam.v1 import iam_policy_pb2 # type: ignore + + def sample_get_iam_policy(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = iam_policy_pb2.GetIamPolicyRequest( + resource="resource_value", + ) + + # Make the request + response = client.get_iam_policy(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]): + The request object. Request message for ``GetIamPolicy`` method. + resource (str): + REQUIRED: The resource for which the + policy is being requested. See the + operation documentation for the + appropriate value for this field. + + This corresponds to the ``resource`` 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.iam.v1.policy_pb2.Policy: + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. + + A Policy is a collection of bindings. A binding binds + one or more members, or principals, to a single role. + Principals can be user accounts, service accounts, + Google groups, and domains (such as G Suite). A role + is a named list of permissions; each role can be an + IAM predefined role or a user-created custom role. + + For some types of Google Cloud resources, a binding + can also specify a condition, which is a logical + expression that allows access to a resource only if + the expression evaluates to true. A condition can add + constraints based on attributes of the request, the + resource, or both. To learn which resources support + conditions in their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + + **JSON example:** + + :literal:`` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }`\ \` + + **YAML example:** + + :literal:`` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3`\ \` + + For a description of IAM and its features, see the + [IAM + documentation](https://cloud.google.com/iam/docs/). + + """ + # 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. + flattened_params = [resource] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.') + + if isinstance(request, dict): + # - The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + request = iam_policy_pb2.GetIamPolicyRequest(**request) + elif not request: + # Null request, just make one. + request = iam_policy_pb2.GetIamPolicyRequest() + if resource is not None: + request.resource = resource + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_iam_policy] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("resource", request.resource), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def set_iam_policy(self, + request: Optional[Union[iam_policy_pb2.SetIamPolicyRequest, dict]] = None, + *, + resource: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> policy_pb2.Policy: + r"""Sets an access control policy for a resource. Replaces any + existing policy. + + Supported resources are: + + - Reservations + + To call this method, you must have the following Google IAM + permissions: + + - ``bigqueryreservation.reservations.setIamPolicy`` to set + policies on reservations. + + .. 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 bigquery_reservation_v1 + from google.iam.v1 import iam_policy_pb2 # type: ignore + + def sample_set_iam_policy(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = iam_policy_pb2.SetIamPolicyRequest( + resource="resource_value", + ) + + # Make the request + response = client.set_iam_policy(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]): + The request object. Request message for ``SetIamPolicy`` method. + resource (str): + REQUIRED: The resource for which the + policy is being specified. See the + operation documentation for the + appropriate value for this field. + + This corresponds to the ``resource`` 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.iam.v1.policy_pb2.Policy: + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. + + A Policy is a collection of bindings. A binding binds + one or more members, or principals, to a single role. + Principals can be user accounts, service accounts, + Google groups, and domains (such as G Suite). A role + is a named list of permissions; each role can be an + IAM predefined role or a user-created custom role. + + For some types of Google Cloud resources, a binding + can also specify a condition, which is a logical + expression that allows access to a resource only if + the expression evaluates to true. A condition can add + constraints based on attributes of the request, the + resource, or both. To learn which resources support + conditions in their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + + **JSON example:** + + :literal:`` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }`\ \` + + **YAML example:** + + :literal:`` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3`\ \` + + For a description of IAM and its features, see the + [IAM + documentation](https://cloud.google.com/iam/docs/). + + """ + # 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. + flattened_params = [resource] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.') + + if isinstance(request, dict): + # - The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + request = iam_policy_pb2.SetIamPolicyRequest(**request) + elif not request: + # Null request, just make one. + request = iam_policy_pb2.SetIamPolicyRequest() + if resource is not None: + request.resource = resource + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.set_iam_policy] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("resource", request.resource), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def test_iam_permissions(self, + request: Optional[Union[iam_policy_pb2.TestIamPermissionsRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> iam_policy_pb2.TestIamPermissionsResponse: + r"""Gets your permissions on a resource. Returns an empty + set of permissions if the resource doesn't exist. + + Supported resources are: + + - Reservations + + No Google IAM permissions are required to call this + method. + + .. 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 bigquery_reservation_v1 + from google.iam.v1 import iam_policy_pb2 # type: ignore + + def sample_test_iam_permissions(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = iam_policy_pb2.TestIamPermissionsRequest( + resource="resource_value", + permissions=['permissions_value1', 'permissions_value2'], + ) + + # Make the request + response = client.test_iam_permissions(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]): + The request object. Request message for ``TestIamPermissions`` 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse: + Response message for TestIamPermissions method. + """ + # Create or coerce a protobuf request object. + if isinstance(request, dict): + # - The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + request = iam_policy_pb2.TestIamPermissionsRequest(**request) + elif not request: + # Null request, just make one. + request = iam_policy_pb2.TestIamPermissionsRequest() + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.test_iam_permissions] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("resource", request.resource), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def create_reservation_group(self, + request: Optional[Union[reservation.CreateReservationGroupRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> reservation.ReservationGroup: + r"""Creates a new reservation group. + + .. 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 bigquery_reservation_v1 + + def sample_create_reservation_group(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.CreateReservationGroupRequest( + parent="parent_value", + reservation_group_id="reservation_group_id_value", + ) + + # Make the request + response = client.create_reservation_group(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.CreateReservationGroupRequest, dict]): + The request object. The request for + [ReservationService.CreateReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.CreateReservationGroup]. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.ReservationGroup: + A reservation group is a container + for reservations. + + """ + # Create or coerce a protobuf request object. + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.CreateReservationGroupRequest): + request = reservation.CreateReservationGroupRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_reservation_group] + + # 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), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_reservation_group(self, + request: Optional[Union[reservation.GetReservationGroupRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> reservation.ReservationGroup: + r"""Returns information about the reservation group. + + .. 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 bigquery_reservation_v1 + + def sample_get_reservation_group(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.GetReservationGroupRequest( + name="name_value", + ) + + # Make the request + response = client.get_reservation_group(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.GetReservationGroupRequest, dict]): + The request object. The request for + [ReservationService.GetReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.GetReservationGroup]. + name (str): + Required. Resource name of the reservation group to + retrieve. E.g., + ``projects/myproject/locations/US/reservationGroups/team1-prod`` + + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.ReservationGroup: + A reservation group is a container + for reservations. + + """ + # 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. + flattened_params = [name] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.') + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.GetReservationGroupRequest): + request = reservation.GetReservationGroupRequest(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_reservation_group] + + # 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), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def delete_reservation_group(self, + request: Optional[Union[reservation.DeleteReservationGroupRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> None: + r"""Deletes a reservation. Returns + ``google.rpc.Code.FAILED_PRECONDITION`` when reservation has + assignments. + + .. 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 bigquery_reservation_v1 + + def sample_delete_reservation_group(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.DeleteReservationGroupRequest( + name="name_value", + ) + + # Make the request + client.delete_reservation_group(request=request) + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.DeleteReservationGroupRequest, dict]): + The request object. The request for + [ReservationService.DeleteReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservationGroup]. + name (str): + Required. Resource name of the reservation group to + retrieve. E.g., + ``projects/myproject/locations/US/reservationGroups/team1-prod`` + + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + """ + # 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. + flattened_params = [name] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.') + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.DeleteReservationGroupRequest): + request = reservation.DeleteReservationGroupRequest(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_reservation_group] + + # 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), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + def list_reservation_groups(self, + request: Optional[Union[reservation.ListReservationGroupsRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> pagers.ListReservationGroupsPager: + r"""Lists all the reservation groups for the project in + the specified location. + + .. 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 bigquery_reservation_v1 + + def sample_list_reservation_groups(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.ListReservationGroupsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_reservation_groups(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.ListReservationGroupsRequest, dict]): + The request object. The request for + [ReservationService.ListReservationGroups][google.cloud.bigquery.reservation.v1.ReservationService.ListReservationGroups]. + parent (str): + Required. The parent resource name containing project + and location, e.g.: ``projects/myproject/locations/US`` + + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListReservationGroupsPager: + The response for + [ReservationService.ListReservationGroups][google.cloud.bigquery.reservation.v1.ReservationService.ListReservationGroups]. + + 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. + flattened_params = [parent] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + 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.') + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.ListReservationGroupsRequest): + request = reservation.ListReservationGroupsRequest(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_reservation_groups] + + # 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), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # 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.ListReservationGroupsPager( + method=rpc, + request=request, + response=response, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def __enter__(self) -> "ReservationServiceClient": + 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() + + + + + + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + +if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER + DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ + +__all__ = ( + "ReservationServiceClient", +) diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/pagers.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/pagers.py new file mode 100644 index 000000000000..62a3e9a5acb7 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/pagers.py @@ -0,0 +1,861 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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.api_core import gapic_v1 +from google.api_core import retry as retries +from google.api_core import retry_async as retries_async +from typing import Any, AsyncIterator, Awaitable, Callable, Sequence, Tuple, Optional, Iterator, Union +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None] + OptionalAsyncRetry = Union[retries_async.AsyncRetry, gapic_v1.method._MethodDefault, None] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object, None] # type: ignore + OptionalAsyncRetry = Union[retries_async.AsyncRetry, object, None] # type: ignore + +from google.cloud.bigquery_reservation_v1.types import reservation + + +class ListReservationsPager: + """A pager for iterating through ``list_reservations`` requests. + + This class thinly wraps an initial + :class:`google.cloud.bigquery_reservation_v1.types.ListReservationsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``reservations`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListReservations`` requests and continue to iterate + through the ``reservations`` field on the + corresponding responses. + + All the usual :class:`google.cloud.bigquery_reservation_v1.types.ListReservationsResponse` + 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[..., reservation.ListReservationsResponse], + request: reservation.ListReservationsRequest, + response: reservation.ListReservationsResponse, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.bigquery_reservation_v1.types.ListReservationsRequest): + The initial request object. + response (google.cloud.bigquery_reservation_v1.types.ListReservationsResponse): + The initial response object. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + """ + self._method = method + self._request = reservation.ListReservationsRequest(request) + self._response = response + self._retry = retry + self._timeout = timeout + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[reservation.ListReservationsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, retry=self._retry, timeout=self._timeout, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[reservation.Reservation]: + for page in self.pages: + yield from page.reservations + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListReservationsAsyncPager: + """A pager for iterating through ``list_reservations`` requests. + + This class thinly wraps an initial + :class:`google.cloud.bigquery_reservation_v1.types.ListReservationsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``reservations`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListReservations`` requests and continue to iterate + through the ``reservations`` field on the + corresponding responses. + + All the usual :class:`google.cloud.bigquery_reservation_v1.types.ListReservationsResponse` + 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[reservation.ListReservationsResponse]], + request: reservation.ListReservationsRequest, + response: reservation.ListReservationsResponse, + *, + retry: OptionalAsyncRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.bigquery_reservation_v1.types.ListReservationsRequest): + The initial request object. + response (google.cloud.bigquery_reservation_v1.types.ListReservationsResponse): + The initial response object. + retry (google.api_core.retry.AsyncRetry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + """ + self._method = method + self._request = reservation.ListReservationsRequest(request) + self._response = response + self._retry = retry + self._timeout = timeout + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[reservation.ListReservationsResponse]: + 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, retry=self._retry, timeout=self._timeout, metadata=self._metadata) + yield self._response + def __aiter__(self) -> AsyncIterator[reservation.Reservation]: + async def async_generator(): + async for page in self.pages: + for response in page.reservations: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListCapacityCommitmentsPager: + """A pager for iterating through ``list_capacity_commitments`` requests. + + This class thinly wraps an initial + :class:`google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``capacity_commitments`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListCapacityCommitments`` requests and continue to iterate + through the ``capacity_commitments`` field on the + corresponding responses. + + All the usual :class:`google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsResponse` + 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[..., reservation.ListCapacityCommitmentsResponse], + request: reservation.ListCapacityCommitmentsRequest, + response: reservation.ListCapacityCommitmentsResponse, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsRequest): + The initial request object. + response (google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsResponse): + The initial response object. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + """ + self._method = method + self._request = reservation.ListCapacityCommitmentsRequest(request) + self._response = response + self._retry = retry + self._timeout = timeout + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[reservation.ListCapacityCommitmentsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, retry=self._retry, timeout=self._timeout, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[reservation.CapacityCommitment]: + for page in self.pages: + yield from page.capacity_commitments + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListCapacityCommitmentsAsyncPager: + """A pager for iterating through ``list_capacity_commitments`` requests. + + This class thinly wraps an initial + :class:`google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``capacity_commitments`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListCapacityCommitments`` requests and continue to iterate + through the ``capacity_commitments`` field on the + corresponding responses. + + All the usual :class:`google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsResponse` + 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[reservation.ListCapacityCommitmentsResponse]], + request: reservation.ListCapacityCommitmentsRequest, + response: reservation.ListCapacityCommitmentsResponse, + *, + retry: OptionalAsyncRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsRequest): + The initial request object. + response (google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsResponse): + The initial response object. + retry (google.api_core.retry.AsyncRetry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + """ + self._method = method + self._request = reservation.ListCapacityCommitmentsRequest(request) + self._response = response + self._retry = retry + self._timeout = timeout + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[reservation.ListCapacityCommitmentsResponse]: + 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, retry=self._retry, timeout=self._timeout, metadata=self._metadata) + yield self._response + def __aiter__(self) -> AsyncIterator[reservation.CapacityCommitment]: + async def async_generator(): + async for page in self.pages: + for response in page.capacity_commitments: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListAssignmentsPager: + """A pager for iterating through ``list_assignments`` requests. + + This class thinly wraps an initial + :class:`google.cloud.bigquery_reservation_v1.types.ListAssignmentsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``assignments`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListAssignments`` requests and continue to iterate + through the ``assignments`` field on the + corresponding responses. + + All the usual :class:`google.cloud.bigquery_reservation_v1.types.ListAssignmentsResponse` + 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[..., reservation.ListAssignmentsResponse], + request: reservation.ListAssignmentsRequest, + response: reservation.ListAssignmentsResponse, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.bigquery_reservation_v1.types.ListAssignmentsRequest): + The initial request object. + response (google.cloud.bigquery_reservation_v1.types.ListAssignmentsResponse): + The initial response object. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + """ + self._method = method + self._request = reservation.ListAssignmentsRequest(request) + self._response = response + self._retry = retry + self._timeout = timeout + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[reservation.ListAssignmentsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, retry=self._retry, timeout=self._timeout, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[reservation.Assignment]: + for page in self.pages: + yield from page.assignments + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListAssignmentsAsyncPager: + """A pager for iterating through ``list_assignments`` requests. + + This class thinly wraps an initial + :class:`google.cloud.bigquery_reservation_v1.types.ListAssignmentsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``assignments`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListAssignments`` requests and continue to iterate + through the ``assignments`` field on the + corresponding responses. + + All the usual :class:`google.cloud.bigquery_reservation_v1.types.ListAssignmentsResponse` + 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[reservation.ListAssignmentsResponse]], + request: reservation.ListAssignmentsRequest, + response: reservation.ListAssignmentsResponse, + *, + retry: OptionalAsyncRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.bigquery_reservation_v1.types.ListAssignmentsRequest): + The initial request object. + response (google.cloud.bigquery_reservation_v1.types.ListAssignmentsResponse): + The initial response object. + retry (google.api_core.retry.AsyncRetry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + """ + self._method = method + self._request = reservation.ListAssignmentsRequest(request) + self._response = response + self._retry = retry + self._timeout = timeout + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[reservation.ListAssignmentsResponse]: + 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, retry=self._retry, timeout=self._timeout, metadata=self._metadata) + yield self._response + def __aiter__(self) -> AsyncIterator[reservation.Assignment]: + async def async_generator(): + async for page in self.pages: + for response in page.assignments: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class SearchAssignmentsPager: + """A pager for iterating through ``search_assignments`` requests. + + This class thinly wraps an initial + :class:`google.cloud.bigquery_reservation_v1.types.SearchAssignmentsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``assignments`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``SearchAssignments`` requests and continue to iterate + through the ``assignments`` field on the + corresponding responses. + + All the usual :class:`google.cloud.bigquery_reservation_v1.types.SearchAssignmentsResponse` + 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[..., reservation.SearchAssignmentsResponse], + request: reservation.SearchAssignmentsRequest, + response: reservation.SearchAssignmentsResponse, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.bigquery_reservation_v1.types.SearchAssignmentsRequest): + The initial request object. + response (google.cloud.bigquery_reservation_v1.types.SearchAssignmentsResponse): + The initial response object. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + """ + self._method = method + self._request = reservation.SearchAssignmentsRequest(request) + self._response = response + self._retry = retry + self._timeout = timeout + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[reservation.SearchAssignmentsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, retry=self._retry, timeout=self._timeout, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[reservation.Assignment]: + for page in self.pages: + yield from page.assignments + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class SearchAssignmentsAsyncPager: + """A pager for iterating through ``search_assignments`` requests. + + This class thinly wraps an initial + :class:`google.cloud.bigquery_reservation_v1.types.SearchAssignmentsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``assignments`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``SearchAssignments`` requests and continue to iterate + through the ``assignments`` field on the + corresponding responses. + + All the usual :class:`google.cloud.bigquery_reservation_v1.types.SearchAssignmentsResponse` + 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[reservation.SearchAssignmentsResponse]], + request: reservation.SearchAssignmentsRequest, + response: reservation.SearchAssignmentsResponse, + *, + retry: OptionalAsyncRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.bigquery_reservation_v1.types.SearchAssignmentsRequest): + The initial request object. + response (google.cloud.bigquery_reservation_v1.types.SearchAssignmentsResponse): + The initial response object. + retry (google.api_core.retry.AsyncRetry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + """ + self._method = method + self._request = reservation.SearchAssignmentsRequest(request) + self._response = response + self._retry = retry + self._timeout = timeout + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[reservation.SearchAssignmentsResponse]: + 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, retry=self._retry, timeout=self._timeout, metadata=self._metadata) + yield self._response + def __aiter__(self) -> AsyncIterator[reservation.Assignment]: + async def async_generator(): + async for page in self.pages: + for response in page.assignments: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class SearchAllAssignmentsPager: + """A pager for iterating through ``search_all_assignments`` requests. + + This class thinly wraps an initial + :class:`google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``assignments`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``SearchAllAssignments`` requests and continue to iterate + through the ``assignments`` field on the + corresponding responses. + + All the usual :class:`google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsResponse` + 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[..., reservation.SearchAllAssignmentsResponse], + request: reservation.SearchAllAssignmentsRequest, + response: reservation.SearchAllAssignmentsResponse, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsRequest): + The initial request object. + response (google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsResponse): + The initial response object. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + """ + self._method = method + self._request = reservation.SearchAllAssignmentsRequest(request) + self._response = response + self._retry = retry + self._timeout = timeout + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[reservation.SearchAllAssignmentsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, retry=self._retry, timeout=self._timeout, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[reservation.Assignment]: + for page in self.pages: + yield from page.assignments + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class SearchAllAssignmentsAsyncPager: + """A pager for iterating through ``search_all_assignments`` requests. + + This class thinly wraps an initial + :class:`google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``assignments`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``SearchAllAssignments`` requests and continue to iterate + through the ``assignments`` field on the + corresponding responses. + + All the usual :class:`google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsResponse` + 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[reservation.SearchAllAssignmentsResponse]], + request: reservation.SearchAllAssignmentsRequest, + response: reservation.SearchAllAssignmentsResponse, + *, + retry: OptionalAsyncRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsRequest): + The initial request object. + response (google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsResponse): + The initial response object. + retry (google.api_core.retry.AsyncRetry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + """ + self._method = method + self._request = reservation.SearchAllAssignmentsRequest(request) + self._response = response + self._retry = retry + self._timeout = timeout + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[reservation.SearchAllAssignmentsResponse]: + 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, retry=self._retry, timeout=self._timeout, metadata=self._metadata) + yield self._response + def __aiter__(self) -> AsyncIterator[reservation.Assignment]: + async def async_generator(): + async for page in self.pages: + for response in page.assignments: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListReservationGroupsPager: + """A pager for iterating through ``list_reservation_groups`` requests. + + This class thinly wraps an initial + :class:`google.cloud.bigquery_reservation_v1.types.ListReservationGroupsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``reservation_groups`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListReservationGroups`` requests and continue to iterate + through the ``reservation_groups`` field on the + corresponding responses. + + All the usual :class:`google.cloud.bigquery_reservation_v1.types.ListReservationGroupsResponse` + 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[..., reservation.ListReservationGroupsResponse], + request: reservation.ListReservationGroupsRequest, + response: reservation.ListReservationGroupsResponse, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.bigquery_reservation_v1.types.ListReservationGroupsRequest): + The initial request object. + response (google.cloud.bigquery_reservation_v1.types.ListReservationGroupsResponse): + The initial response object. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + """ + self._method = method + self._request = reservation.ListReservationGroupsRequest(request) + self._response = response + self._retry = retry + self._timeout = timeout + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[reservation.ListReservationGroupsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, retry=self._retry, timeout=self._timeout, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[reservation.ReservationGroup]: + for page in self.pages: + yield from page.reservation_groups + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListReservationGroupsAsyncPager: + """A pager for iterating through ``list_reservation_groups`` requests. + + This class thinly wraps an initial + :class:`google.cloud.bigquery_reservation_v1.types.ListReservationGroupsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``reservation_groups`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListReservationGroups`` requests and continue to iterate + through the ``reservation_groups`` field on the + corresponding responses. + + All the usual :class:`google.cloud.bigquery_reservation_v1.types.ListReservationGroupsResponse` + 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[reservation.ListReservationGroupsResponse]], + request: reservation.ListReservationGroupsRequest, + response: reservation.ListReservationGroupsResponse, + *, + retry: OptionalAsyncRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.bigquery_reservation_v1.types.ListReservationGroupsRequest): + The initial request object. + response (google.cloud.bigquery_reservation_v1.types.ListReservationGroupsResponse): + The initial response object. + retry (google.api_core.retry.AsyncRetry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + """ + self._method = method + self._request = reservation.ListReservationGroupsRequest(request) + self._response = response + self._retry = retry + self._timeout = timeout + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[reservation.ListReservationGroupsResponse]: + 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, retry=self._retry, timeout=self._timeout, metadata=self._metadata) + yield self._response + def __aiter__(self) -> AsyncIterator[reservation.ReservationGroup]: + async def async_generator(): + async for page in self.pages: + for response in page.reservation_groups: + 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/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/README.rst b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/README.rst new file mode 100644 index 000000000000..b69ca178e2ae --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/README.rst @@ -0,0 +1,9 @@ + +transport inheritance structure +_______________________________ + +`ReservationServiceTransport` is the ABC for all transports. +- public child `ReservationServiceGrpcTransport` for sync gRPC transport (defined in `grpc.py`). +- public child `ReservationServiceGrpcAsyncIOTransport` for async gRPC transport (defined in `grpc_asyncio.py`). +- private child `_BaseReservationServiceRestTransport` for base REST transport with inner classes `_BaseMETHOD` (defined in `rest_base.py`). +- public child `ReservationServiceRestTransport` for sync REST transport with inner classes `METHOD` derived from the parent's corresponding `_BaseMETHOD` classes (defined in `rest.py`). diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/__init__.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/__init__.py new file mode 100644 index 000000000000..709db549531d --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/__init__.py @@ -0,0 +1,38 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 ReservationServiceTransport +from .grpc import ReservationServiceGrpcTransport +from .grpc_asyncio import ReservationServiceGrpcAsyncIOTransport +from .rest import ReservationServiceRestTransport +from .rest import ReservationServiceRestInterceptor + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[ReservationServiceTransport]] +_transport_registry['grpc'] = ReservationServiceGrpcTransport +_transport_registry['grpc_asyncio'] = ReservationServiceGrpcAsyncIOTransport +_transport_registry['rest'] = ReservationServiceRestTransport + +__all__ = ( + 'ReservationServiceTransport', + 'ReservationServiceGrpcTransport', + 'ReservationServiceGrpcAsyncIOTransport', + 'ReservationServiceRestTransport', + 'ReservationServiceRestInterceptor', +) diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/base.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/base.py new file mode 100644 index 000000000000..c375a69c7531 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/base.py @@ -0,0 +1,656 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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.bigquery_reservation_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.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore +import google.protobuf + +from google.cloud.bigquery_reservation_v1.types import reservation +from google.cloud.bigquery_reservation_v1.types import reservation as gcbr_reservation +from google.iam.v1 import iam_policy_pb2 # type: ignore +from google.iam.v1 import policy_pb2 # type: ignore +from google.protobuf import empty_pb2 # type: ignore + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + +if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER + DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ + + +class ReservationServiceTransport(abc.ABC): + """Abstract transport class for ReservationService.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/bigquery', + 'https://www.googleapis.com/auth/cloud-platform', + ) + + DEFAULT_HOST: str = 'bigqueryreservation.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 (default: 'bigqueryreservation.googleapis.com'). + 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 not hasattr(self, "_ignore_credentials"): + self._ignore_credentials: bool = False + + # 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 and not self._ignore_credentials: + 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 + + @property + def host(self): + return self._host + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.create_reservation: gapic_v1.method.wrap_method( + self.create_reservation, + default_timeout=300.0, + client_info=client_info, + ), + self.list_reservations: gapic_v1.method.wrap_method( + self.list_reservations, + default_retry=retries.Retry( + initial=0.1, + maximum=60.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=300.0, + ), + default_timeout=300.0, + client_info=client_info, + ), + self.get_reservation: gapic_v1.method.wrap_method( + self.get_reservation, + default_retry=retries.Retry( + initial=0.1, + maximum=60.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=300.0, + ), + default_timeout=300.0, + client_info=client_info, + ), + self.delete_reservation: gapic_v1.method.wrap_method( + self.delete_reservation, + default_retry=retries.Retry( + initial=0.1, + maximum=60.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=300.0, + ), + default_timeout=300.0, + client_info=client_info, + ), + self.update_reservation: gapic_v1.method.wrap_method( + self.update_reservation, + default_timeout=300.0, + client_info=client_info, + ), + self.failover_reservation: gapic_v1.method.wrap_method( + self.failover_reservation, + default_timeout=300.0, + client_info=client_info, + ), + self.create_capacity_commitment: gapic_v1.method.wrap_method( + self.create_capacity_commitment, + default_timeout=300.0, + client_info=client_info, + ), + self.list_capacity_commitments: gapic_v1.method.wrap_method( + self.list_capacity_commitments, + default_retry=retries.Retry( + initial=0.1, + maximum=60.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=300.0, + ), + default_timeout=300.0, + client_info=client_info, + ), + self.get_capacity_commitment: gapic_v1.method.wrap_method( + self.get_capacity_commitment, + default_retry=retries.Retry( + initial=0.1, + maximum=60.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=300.0, + ), + default_timeout=300.0, + client_info=client_info, + ), + self.delete_capacity_commitment: gapic_v1.method.wrap_method( + self.delete_capacity_commitment, + default_retry=retries.Retry( + initial=0.1, + maximum=60.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=300.0, + ), + default_timeout=300.0, + client_info=client_info, + ), + self.update_capacity_commitment: gapic_v1.method.wrap_method( + self.update_capacity_commitment, + default_timeout=300.0, + client_info=client_info, + ), + self.split_capacity_commitment: gapic_v1.method.wrap_method( + self.split_capacity_commitment, + default_timeout=300.0, + client_info=client_info, + ), + self.merge_capacity_commitments: gapic_v1.method.wrap_method( + self.merge_capacity_commitments, + default_timeout=300.0, + client_info=client_info, + ), + self.create_assignment: gapic_v1.method.wrap_method( + self.create_assignment, + default_timeout=300.0, + client_info=client_info, + ), + self.list_assignments: gapic_v1.method.wrap_method( + self.list_assignments, + default_retry=retries.Retry( + initial=0.1, + maximum=60.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=300.0, + ), + default_timeout=300.0, + client_info=client_info, + ), + self.delete_assignment: gapic_v1.method.wrap_method( + self.delete_assignment, + default_retry=retries.Retry( + initial=0.1, + maximum=60.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=300.0, + ), + default_timeout=300.0, + client_info=client_info, + ), + self.search_assignments: gapic_v1.method.wrap_method( + self.search_assignments, + default_retry=retries.Retry( + initial=0.1, + maximum=60.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=300.0, + ), + default_timeout=300.0, + client_info=client_info, + ), + self.search_all_assignments: gapic_v1.method.wrap_method( + self.search_all_assignments, + default_timeout=None, + client_info=client_info, + ), + self.move_assignment: gapic_v1.method.wrap_method( + self.move_assignment, + default_timeout=300.0, + client_info=client_info, + ), + self.update_assignment: gapic_v1.method.wrap_method( + self.update_assignment, + default_timeout=None, + client_info=client_info, + ), + self.get_bi_reservation: gapic_v1.method.wrap_method( + self.get_bi_reservation, + default_retry=retries.Retry( + initial=0.1, + maximum=60.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=300.0, + ), + default_timeout=300.0, + client_info=client_info, + ), + self.update_bi_reservation: gapic_v1.method.wrap_method( + self.update_bi_reservation, + default_timeout=300.0, + client_info=client_info, + ), + self.get_iam_policy: gapic_v1.method.wrap_method( + self.get_iam_policy, + default_timeout=None, + client_info=client_info, + ), + self.set_iam_policy: gapic_v1.method.wrap_method( + self.set_iam_policy, + default_timeout=None, + client_info=client_info, + ), + self.test_iam_permissions: gapic_v1.method.wrap_method( + self.test_iam_permissions, + default_timeout=None, + client_info=client_info, + ), + self.create_reservation_group: gapic_v1.method.wrap_method( + self.create_reservation_group, + default_timeout=None, + client_info=client_info, + ), + self.get_reservation_group: gapic_v1.method.wrap_method( + self.get_reservation_group, + default_timeout=None, + client_info=client_info, + ), + self.delete_reservation_group: gapic_v1.method.wrap_method( + self.delete_reservation_group, + default_timeout=None, + client_info=client_info, + ), + self.list_reservation_groups: gapic_v1.method.wrap_method( + self.list_reservation_groups, + 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 create_reservation(self) -> Callable[ + [gcbr_reservation.CreateReservationRequest], + Union[ + gcbr_reservation.Reservation, + Awaitable[gcbr_reservation.Reservation] + ]]: + raise NotImplementedError() + + @property + def list_reservations(self) -> Callable[ + [reservation.ListReservationsRequest], + Union[ + reservation.ListReservationsResponse, + Awaitable[reservation.ListReservationsResponse] + ]]: + raise NotImplementedError() + + @property + def get_reservation(self) -> Callable[ + [reservation.GetReservationRequest], + Union[ + reservation.Reservation, + Awaitable[reservation.Reservation] + ]]: + raise NotImplementedError() + + @property + def delete_reservation(self) -> Callable[ + [reservation.DeleteReservationRequest], + Union[ + empty_pb2.Empty, + Awaitable[empty_pb2.Empty] + ]]: + raise NotImplementedError() + + @property + def update_reservation(self) -> Callable[ + [gcbr_reservation.UpdateReservationRequest], + Union[ + gcbr_reservation.Reservation, + Awaitable[gcbr_reservation.Reservation] + ]]: + raise NotImplementedError() + + @property + def failover_reservation(self) -> Callable[ + [reservation.FailoverReservationRequest], + Union[ + reservation.Reservation, + Awaitable[reservation.Reservation] + ]]: + raise NotImplementedError() + + @property + def create_capacity_commitment(self) -> Callable[ + [reservation.CreateCapacityCommitmentRequest], + Union[ + reservation.CapacityCommitment, + Awaitable[reservation.CapacityCommitment] + ]]: + raise NotImplementedError() + + @property + def list_capacity_commitments(self) -> Callable[ + [reservation.ListCapacityCommitmentsRequest], + Union[ + reservation.ListCapacityCommitmentsResponse, + Awaitable[reservation.ListCapacityCommitmentsResponse] + ]]: + raise NotImplementedError() + + @property + def get_capacity_commitment(self) -> Callable[ + [reservation.GetCapacityCommitmentRequest], + Union[ + reservation.CapacityCommitment, + Awaitable[reservation.CapacityCommitment] + ]]: + raise NotImplementedError() + + @property + def delete_capacity_commitment(self) -> Callable[ + [reservation.DeleteCapacityCommitmentRequest], + Union[ + empty_pb2.Empty, + Awaitable[empty_pb2.Empty] + ]]: + raise NotImplementedError() + + @property + def update_capacity_commitment(self) -> Callable[ + [reservation.UpdateCapacityCommitmentRequest], + Union[ + reservation.CapacityCommitment, + Awaitable[reservation.CapacityCommitment] + ]]: + raise NotImplementedError() + + @property + def split_capacity_commitment(self) -> Callable[ + [reservation.SplitCapacityCommitmentRequest], + Union[ + reservation.SplitCapacityCommitmentResponse, + Awaitable[reservation.SplitCapacityCommitmentResponse] + ]]: + raise NotImplementedError() + + @property + def merge_capacity_commitments(self) -> Callable[ + [reservation.MergeCapacityCommitmentsRequest], + Union[ + reservation.CapacityCommitment, + Awaitable[reservation.CapacityCommitment] + ]]: + raise NotImplementedError() + + @property + def create_assignment(self) -> Callable[ + [reservation.CreateAssignmentRequest], + Union[ + reservation.Assignment, + Awaitable[reservation.Assignment] + ]]: + raise NotImplementedError() + + @property + def list_assignments(self) -> Callable[ + [reservation.ListAssignmentsRequest], + Union[ + reservation.ListAssignmentsResponse, + Awaitable[reservation.ListAssignmentsResponse] + ]]: + raise NotImplementedError() + + @property + def delete_assignment(self) -> Callable[ + [reservation.DeleteAssignmentRequest], + Union[ + empty_pb2.Empty, + Awaitable[empty_pb2.Empty] + ]]: + raise NotImplementedError() + + @property + def search_assignments(self) -> Callable[ + [reservation.SearchAssignmentsRequest], + Union[ + reservation.SearchAssignmentsResponse, + Awaitable[reservation.SearchAssignmentsResponse] + ]]: + raise NotImplementedError() + + @property + def search_all_assignments(self) -> Callable[ + [reservation.SearchAllAssignmentsRequest], + Union[ + reservation.SearchAllAssignmentsResponse, + Awaitable[reservation.SearchAllAssignmentsResponse] + ]]: + raise NotImplementedError() + + @property + def move_assignment(self) -> Callable[ + [reservation.MoveAssignmentRequest], + Union[ + reservation.Assignment, + Awaitable[reservation.Assignment] + ]]: + raise NotImplementedError() + + @property + def update_assignment(self) -> Callable[ + [reservation.UpdateAssignmentRequest], + Union[ + reservation.Assignment, + Awaitable[reservation.Assignment] + ]]: + raise NotImplementedError() + + @property + def get_bi_reservation(self) -> Callable[ + [reservation.GetBiReservationRequest], + Union[ + reservation.BiReservation, + Awaitable[reservation.BiReservation] + ]]: + raise NotImplementedError() + + @property + def update_bi_reservation(self) -> Callable[ + [reservation.UpdateBiReservationRequest], + Union[ + reservation.BiReservation, + Awaitable[reservation.BiReservation] + ]]: + raise NotImplementedError() + + @property + def get_iam_policy(self) -> Callable[ + [iam_policy_pb2.GetIamPolicyRequest], + Union[ + policy_pb2.Policy, + Awaitable[policy_pb2.Policy] + ]]: + raise NotImplementedError() + + @property + def set_iam_policy(self) -> Callable[ + [iam_policy_pb2.SetIamPolicyRequest], + Union[ + policy_pb2.Policy, + Awaitable[policy_pb2.Policy] + ]]: + raise NotImplementedError() + + @property + def test_iam_permissions(self) -> Callable[ + [iam_policy_pb2.TestIamPermissionsRequest], + Union[ + iam_policy_pb2.TestIamPermissionsResponse, + Awaitable[iam_policy_pb2.TestIamPermissionsResponse] + ]]: + raise NotImplementedError() + + @property + def create_reservation_group(self) -> Callable[ + [reservation.CreateReservationGroupRequest], + Union[ + reservation.ReservationGroup, + Awaitable[reservation.ReservationGroup] + ]]: + raise NotImplementedError() + + @property + def get_reservation_group(self) -> Callable[ + [reservation.GetReservationGroupRequest], + Union[ + reservation.ReservationGroup, + Awaitable[reservation.ReservationGroup] + ]]: + raise NotImplementedError() + + @property + def delete_reservation_group(self) -> Callable[ + [reservation.DeleteReservationGroupRequest], + Union[ + empty_pb2.Empty, + Awaitable[empty_pb2.Empty] + ]]: + raise NotImplementedError() + + @property + def list_reservation_groups(self) -> Callable[ + [reservation.ListReservationGroupsRequest], + Union[ + reservation.ListReservationGroupsResponse, + Awaitable[reservation.ListReservationGroupsResponse] + ]]: + raise NotImplementedError() + + @property + def kind(self) -> str: + raise NotImplementedError() + + +__all__ = ( + 'ReservationServiceTransport', +) diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc.py new file mode 100644 index 000000000000..37820571ef6c --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc.py @@ -0,0 +1,1299 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 json +import logging as std_logging +import pickle +import warnings +from typing import Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import grpc_helpers +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 +from google.protobuf.json_format import MessageToJson +import google.protobuf.message + +import grpc # type: ignore +import proto # type: ignore + +from google.cloud.bigquery_reservation_v1.types import reservation +from google.cloud.bigquery_reservation_v1.types import reservation as gcbr_reservation +from google.iam.v1 import iam_policy_pb2 # type: ignore +from google.iam.v1 import policy_pb2 # type: ignore +from google.protobuf import empty_pb2 # type: ignore +from .base import ReservationServiceTransport, DEFAULT_CLIENT_INFO + +try: + from google.api_core import client_logging # type: ignore + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER +except ImportError: # pragma: NO COVER + CLIENT_LOGGING_SUPPORTED = False + +_LOGGER = std_logging.getLogger(__name__) + + +class _LoggingClientInterceptor(grpc.UnaryUnaryClientInterceptor): # pragma: NO COVER + def intercept_unary_unary(self, continuation, client_call_details, request): + logging_enabled = CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(std_logging.DEBUG) + if logging_enabled: # pragma: NO COVER + request_metadata = client_call_details.metadata + if isinstance(request, proto.Message): + request_payload = type(request).to_json(request) + elif isinstance(request, google.protobuf.message.Message): + request_payload = MessageToJson(request) + else: + request_payload = f"{type(request).__name__}: {pickle.dumps(request)}" + + request_metadata = { + key: value.decode("utf-8") if isinstance(value, bytes) else value + for key, value in request_metadata + } + grpc_request = { + "payload": request_payload, + "requestMethod": "grpc", + "metadata": dict(request_metadata), + } + _LOGGER.debug( + f"Sending request for {client_call_details.method}", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": str(client_call_details.method), + "request": grpc_request, + "metadata": grpc_request["metadata"], + }, + ) + response = continuation(client_call_details, request) + if logging_enabled: # pragma: NO COVER + response_metadata = response.trailing_metadata() + # Convert gRPC metadata `` to list of tuples + metadata = dict([(k, str(v)) for k, v in response_metadata]) if response_metadata else None + result = response.result() + if isinstance(result, proto.Message): + response_payload = type(result).to_json(result) + elif isinstance(result, google.protobuf.message.Message): + response_payload = MessageToJson(result) + else: + response_payload = f"{type(result).__name__}: {pickle.dumps(result)}" + grpc_response = { + "payload": response_payload, + "metadata": metadata, + "status": "OK", + } + _LOGGER.debug( + f"Received response for {client_call_details.method}.", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": client_call_details.method, + "response": grpc_response, + "metadata": grpc_response["metadata"], + }, + ) + return response + + +class ReservationServiceGrpcTransport(ReservationServiceTransport): + """gRPC backend transport for ReservationService. + + This API allows users to manage their BigQuery reservations. + + A reservation provides computational resource guarantees, in the + form of `slots `__, to + users. A slot is a unit of computational power in BigQuery, and + serves as the basic unit of parallelism. In a scan of a + multi-partitioned table, a single slot operates on a single + partition of the table. A reservation resource exists as a child + resource of the admin project and location, e.g.: + ``projects/myproject/locations/US/reservations/reservationName``. + + A capacity commitment is a way to purchase compute capacity for + BigQuery jobs (in the form of slots) with some committed period of + usage. A capacity commitment resource exists as a child resource of + the admin project and location, e.g.: + ``projects/myproject/locations/US/capacityCommitments/id``. + + 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 = 'bigqueryreservation.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[Union[grpc.Channel, Callable[..., 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 (default: 'bigqueryreservation.googleapis.com'). + 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 a ``channel`` instance 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 a ``channel`` instance is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if a ``channel`` instance is provided. + channel (Optional[Union[grpc.Channel, Callable[..., grpc.Channel]]]): + A ``Channel`` instance through which to make calls, or a Callable + that constructs and returns one. If set to None, ``self.create_channel`` + is used to create the channel. If a Callable is given, it will be called + with the same arguments as used in ``self.create_channel``. + 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 a ``channel`` instance 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 a ``channel`` instance 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] = {} + + 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 isinstance(channel, grpc.Channel): + # Ignore credentials if a channel was passed. + credentials = None + self._ignore_credentials = True + # 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: + # initialize with the provided callable or the default channel + channel_init = channel or type(self).create_channel + self._grpc_channel = channel_init( + 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), + ], + ) + + self._interceptor = _LoggingClientInterceptor() + self._logged_channel = grpc.intercept_channel(self._grpc_channel, self._interceptor) + + # Wrap messages. This must be done after self._logged_channel exists + self._prep_wrapped_messages(client_info) + + @classmethod + def create_channel(cls, + host: str = 'bigqueryreservation.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 create_reservation(self) -> Callable[ + [gcbr_reservation.CreateReservationRequest], + gcbr_reservation.Reservation]: + r"""Return a callable for the create reservation method over gRPC. + + Creates a new reservation resource. + + Returns: + Callable[[~.CreateReservationRequest], + ~.Reservation]: + 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_reservation' not in self._stubs: + self._stubs['create_reservation'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/CreateReservation', + request_serializer=gcbr_reservation.CreateReservationRequest.serialize, + response_deserializer=gcbr_reservation.Reservation.deserialize, + ) + return self._stubs['create_reservation'] + + @property + def list_reservations(self) -> Callable[ + [reservation.ListReservationsRequest], + reservation.ListReservationsResponse]: + r"""Return a callable for the list reservations method over gRPC. + + Lists all the reservations for the project in the + specified location. + + Returns: + Callable[[~.ListReservationsRequest], + ~.ListReservationsResponse]: + 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_reservations' not in self._stubs: + self._stubs['list_reservations'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/ListReservations', + request_serializer=reservation.ListReservationsRequest.serialize, + response_deserializer=reservation.ListReservationsResponse.deserialize, + ) + return self._stubs['list_reservations'] + + @property + def get_reservation(self) -> Callable[ + [reservation.GetReservationRequest], + reservation.Reservation]: + r"""Return a callable for the get reservation method over gRPC. + + Returns information about the reservation. + + Returns: + Callable[[~.GetReservationRequest], + ~.Reservation]: + 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_reservation' not in self._stubs: + self._stubs['get_reservation'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/GetReservation', + request_serializer=reservation.GetReservationRequest.serialize, + response_deserializer=reservation.Reservation.deserialize, + ) + return self._stubs['get_reservation'] + + @property + def delete_reservation(self) -> Callable[ + [reservation.DeleteReservationRequest], + empty_pb2.Empty]: + r"""Return a callable for the delete reservation method over gRPC. + + Deletes a reservation. Returns + ``google.rpc.Code.FAILED_PRECONDITION`` when reservation has + assignments. + + Returns: + Callable[[~.DeleteReservationRequest], + ~.Empty]: + 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_reservation' not in self._stubs: + self._stubs['delete_reservation'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/DeleteReservation', + request_serializer=reservation.DeleteReservationRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_reservation'] + + @property + def update_reservation(self) -> Callable[ + [gcbr_reservation.UpdateReservationRequest], + gcbr_reservation.Reservation]: + r"""Return a callable for the update reservation method over gRPC. + + Updates an existing reservation resource. + + Returns: + Callable[[~.UpdateReservationRequest], + ~.Reservation]: + 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_reservation' not in self._stubs: + self._stubs['update_reservation'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/UpdateReservation', + request_serializer=gcbr_reservation.UpdateReservationRequest.serialize, + response_deserializer=gcbr_reservation.Reservation.deserialize, + ) + return self._stubs['update_reservation'] + + @property + def failover_reservation(self) -> Callable[ + [reservation.FailoverReservationRequest], + reservation.Reservation]: + r"""Return a callable for the failover reservation method over gRPC. + + Fail over a reservation to the secondary location. The operation + should be done in the current secondary location, which will be + promoted to the new primary location for the reservation. + Attempting to failover a reservation in the current primary + location will fail with the error code + ``google.rpc.Code.FAILED_PRECONDITION``. + + Returns: + Callable[[~.FailoverReservationRequest], + ~.Reservation]: + 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 'failover_reservation' not in self._stubs: + self._stubs['failover_reservation'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/FailoverReservation', + request_serializer=reservation.FailoverReservationRequest.serialize, + response_deserializer=reservation.Reservation.deserialize, + ) + return self._stubs['failover_reservation'] + + @property + def create_capacity_commitment(self) -> Callable[ + [reservation.CreateCapacityCommitmentRequest], + reservation.CapacityCommitment]: + r"""Return a callable for the create capacity commitment method over gRPC. + + Creates a new capacity commitment resource. + + Returns: + Callable[[~.CreateCapacityCommitmentRequest], + ~.CapacityCommitment]: + 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_capacity_commitment' not in self._stubs: + self._stubs['create_capacity_commitment'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/CreateCapacityCommitment', + request_serializer=reservation.CreateCapacityCommitmentRequest.serialize, + response_deserializer=reservation.CapacityCommitment.deserialize, + ) + return self._stubs['create_capacity_commitment'] + + @property + def list_capacity_commitments(self) -> Callable[ + [reservation.ListCapacityCommitmentsRequest], + reservation.ListCapacityCommitmentsResponse]: + r"""Return a callable for the list capacity commitments method over gRPC. + + Lists all the capacity commitments for the admin + project. + + Returns: + Callable[[~.ListCapacityCommitmentsRequest], + ~.ListCapacityCommitmentsResponse]: + 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_capacity_commitments' not in self._stubs: + self._stubs['list_capacity_commitments'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/ListCapacityCommitments', + request_serializer=reservation.ListCapacityCommitmentsRequest.serialize, + response_deserializer=reservation.ListCapacityCommitmentsResponse.deserialize, + ) + return self._stubs['list_capacity_commitments'] + + @property + def get_capacity_commitment(self) -> Callable[ + [reservation.GetCapacityCommitmentRequest], + reservation.CapacityCommitment]: + r"""Return a callable for the get capacity commitment method over gRPC. + + Returns information about the capacity commitment. + + Returns: + Callable[[~.GetCapacityCommitmentRequest], + ~.CapacityCommitment]: + 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_capacity_commitment' not in self._stubs: + self._stubs['get_capacity_commitment'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/GetCapacityCommitment', + request_serializer=reservation.GetCapacityCommitmentRequest.serialize, + response_deserializer=reservation.CapacityCommitment.deserialize, + ) + return self._stubs['get_capacity_commitment'] + + @property + def delete_capacity_commitment(self) -> Callable[ + [reservation.DeleteCapacityCommitmentRequest], + empty_pb2.Empty]: + r"""Return a callable for the delete capacity commitment method over gRPC. + + Deletes a capacity commitment. Attempting to delete capacity + commitment before its commitment_end_time will fail with the + error code ``google.rpc.Code.FAILED_PRECONDITION``. + + Returns: + Callable[[~.DeleteCapacityCommitmentRequest], + ~.Empty]: + 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_capacity_commitment' not in self._stubs: + self._stubs['delete_capacity_commitment'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/DeleteCapacityCommitment', + request_serializer=reservation.DeleteCapacityCommitmentRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_capacity_commitment'] + + @property + def update_capacity_commitment(self) -> Callable[ + [reservation.UpdateCapacityCommitmentRequest], + reservation.CapacityCommitment]: + r"""Return a callable for the update capacity commitment method over gRPC. + + Updates an existing capacity commitment. + + Only ``plan`` and ``renewal_plan`` fields can be updated. + + Plan can only be changed to a plan of a longer commitment + period. Attempting to change to a plan with shorter commitment + period will fail with the error code + ``google.rpc.Code.FAILED_PRECONDITION``. + + Returns: + Callable[[~.UpdateCapacityCommitmentRequest], + ~.CapacityCommitment]: + 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_capacity_commitment' not in self._stubs: + self._stubs['update_capacity_commitment'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/UpdateCapacityCommitment', + request_serializer=reservation.UpdateCapacityCommitmentRequest.serialize, + response_deserializer=reservation.CapacityCommitment.deserialize, + ) + return self._stubs['update_capacity_commitment'] + + @property + def split_capacity_commitment(self) -> Callable[ + [reservation.SplitCapacityCommitmentRequest], + reservation.SplitCapacityCommitmentResponse]: + r"""Return a callable for the split capacity commitment method over gRPC. + + Splits capacity commitment to two commitments of the same plan + and ``commitment_end_time``. + + A common use case is to enable downgrading commitments. + + For example, in order to downgrade from 10000 slots to 8000, you + might split a 10000 capacity commitment into commitments of 2000 + and 8000. Then, you delete the first one after the commitment + end time passes. + + Returns: + Callable[[~.SplitCapacityCommitmentRequest], + ~.SplitCapacityCommitmentResponse]: + 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 'split_capacity_commitment' not in self._stubs: + self._stubs['split_capacity_commitment'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/SplitCapacityCommitment', + request_serializer=reservation.SplitCapacityCommitmentRequest.serialize, + response_deserializer=reservation.SplitCapacityCommitmentResponse.deserialize, + ) + return self._stubs['split_capacity_commitment'] + + @property + def merge_capacity_commitments(self) -> Callable[ + [reservation.MergeCapacityCommitmentsRequest], + reservation.CapacityCommitment]: + r"""Return a callable for the merge capacity commitments method over gRPC. + + Merges capacity commitments of the same plan into a single + commitment. + + The resulting capacity commitment has the greater + commitment_end_time out of the to-be-merged capacity + commitments. + + Attempting to merge capacity commitments of different plan will + fail with the error code + ``google.rpc.Code.FAILED_PRECONDITION``. + + Returns: + Callable[[~.MergeCapacityCommitmentsRequest], + ~.CapacityCommitment]: + 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 'merge_capacity_commitments' not in self._stubs: + self._stubs['merge_capacity_commitments'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/MergeCapacityCommitments', + request_serializer=reservation.MergeCapacityCommitmentsRequest.serialize, + response_deserializer=reservation.CapacityCommitment.deserialize, + ) + return self._stubs['merge_capacity_commitments'] + + @property + def create_assignment(self) -> Callable[ + [reservation.CreateAssignmentRequest], + reservation.Assignment]: + r"""Return a callable for the create assignment method over gRPC. + + Creates an assignment object which allows the given project to + submit jobs of a certain type using slots from the specified + reservation. + + Currently a resource (project, folder, organization) can only + have one assignment per each (job_type, location) combination, + and that reservation will be used for all jobs of the matching + type. + + Different assignments can be created on different levels of the + projects, folders or organization hierarchy. During query + execution, the assignment is looked up at the project, folder + and organization levels in that order. The first assignment + found is applied to the query. + + When creating assignments, it does not matter if other + assignments exist at higher levels. + + Example: + + - The organization ``organizationA`` contains two projects, + ``project1`` and ``project2``. + - Assignments for all three entities (``organizationA``, + ``project1``, and ``project2``) could all be created and + mapped to the same or different reservations. + + "None" assignments represent an absence of the assignment. + Projects assigned to None use on-demand pricing. To create a + "None" assignment, use "none" as a reservation_id in the parent. + Example parent: + ``projects/myproject/locations/US/reservations/none``. + + Returns ``google.rpc.Code.PERMISSION_DENIED`` if user does not + have 'bigquery.admin' permissions on the project using the + reservation and the project that owns this reservation. + + Returns ``google.rpc.Code.INVALID_ARGUMENT`` when location of + the assignment does not match location of the reservation. + + Returns: + Callable[[~.CreateAssignmentRequest], + ~.Assignment]: + 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_assignment' not in self._stubs: + self._stubs['create_assignment'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/CreateAssignment', + request_serializer=reservation.CreateAssignmentRequest.serialize, + response_deserializer=reservation.Assignment.deserialize, + ) + return self._stubs['create_assignment'] + + @property + def list_assignments(self) -> Callable[ + [reservation.ListAssignmentsRequest], + reservation.ListAssignmentsResponse]: + r"""Return a callable for the list assignments method over gRPC. + + Lists assignments. + + Only explicitly created assignments will be returned. + + Example: + + - Organization ``organizationA`` contains two projects, + ``project1`` and ``project2``. + - Reservation ``res1`` exists and was created previously. + - CreateAssignment was used previously to define the following + associations between entities and reservations: + ```` and ```` + + In this example, ListAssignments will just return the above two + assignments for reservation ``res1``, and no expansion/merge + will happen. + + The wildcard "-" can be used for reservations in the request. In + that case all assignments belongs to the specified project and + location will be listed. + + **Note** "-" cannot be used for projects nor locations. + + Returns: + Callable[[~.ListAssignmentsRequest], + ~.ListAssignmentsResponse]: + 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_assignments' not in self._stubs: + self._stubs['list_assignments'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/ListAssignments', + request_serializer=reservation.ListAssignmentsRequest.serialize, + response_deserializer=reservation.ListAssignmentsResponse.deserialize, + ) + return self._stubs['list_assignments'] + + @property + def delete_assignment(self) -> Callable[ + [reservation.DeleteAssignmentRequest], + empty_pb2.Empty]: + r"""Return a callable for the delete assignment method over gRPC. + + Deletes a assignment. No expansion will happen. + + Example: + + - Organization ``organizationA`` contains two projects, + ``project1`` and ``project2``. + - Reservation ``res1`` exists and was created previously. + - CreateAssignment was used previously to define the following + associations between entities and reservations: + ```` and ```` + + In this example, deletion of the ```` + assignment won't affect the other assignment + ````. After said deletion, queries from + ``project1`` will still use ``res1`` while queries from + ``project2`` will switch to use on-demand mode. + + Returns: + Callable[[~.DeleteAssignmentRequest], + ~.Empty]: + 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_assignment' not in self._stubs: + self._stubs['delete_assignment'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/DeleteAssignment', + request_serializer=reservation.DeleteAssignmentRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_assignment'] + + @property + def search_assignments(self) -> Callable[ + [reservation.SearchAssignmentsRequest], + reservation.SearchAssignmentsResponse]: + r"""Return a callable for the search assignments method over gRPC. + + Deprecated: Looks up assignments for a specified resource for a + particular region. If the request is about a project: + + 1. Assignments created on the project will be returned if they + exist. + 2. Otherwise assignments created on the closest ancestor will be + returned. + 3. Assignments for different JobTypes will all be returned. + + The same logic applies if the request is about a folder. + + If the request is about an organization, then assignments + created on the organization will be returned (organization + doesn't have ancestors). + + Comparing to ListAssignments, there are some behavior + differences: + + 1. permission on the assignee will be verified in this API. + 2. Hierarchy lookup (project->folder->organization) happens in + this API. + 3. Parent here is ``projects/*/locations/*``, instead of + ``projects/*/locations/*reservations/*``. + + **Note** "-" cannot be used for projects nor locations. + + Returns: + Callable[[~.SearchAssignmentsRequest], + ~.SearchAssignmentsResponse]: + 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 'search_assignments' not in self._stubs: + self._stubs['search_assignments'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/SearchAssignments', + request_serializer=reservation.SearchAssignmentsRequest.serialize, + response_deserializer=reservation.SearchAssignmentsResponse.deserialize, + ) + return self._stubs['search_assignments'] + + @property + def search_all_assignments(self) -> Callable[ + [reservation.SearchAllAssignmentsRequest], + reservation.SearchAllAssignmentsResponse]: + r"""Return a callable for the search all assignments method over gRPC. + + Looks up assignments for a specified resource for a particular + region. If the request is about a project: + + 1. Assignments created on the project will be returned if they + exist. + 2. Otherwise assignments created on the closest ancestor will be + returned. + 3. Assignments for different JobTypes will all be returned. + + The same logic applies if the request is about a folder. + + If the request is about an organization, then assignments + created on the organization will be returned (organization + doesn't have ancestors). + + Comparing to ListAssignments, there are some behavior + differences: + + 1. permission on the assignee will be verified in this API. + 2. Hierarchy lookup (project->folder->organization) happens in + this API. + 3. Parent here is ``projects/*/locations/*``, instead of + ``projects/*/locations/*reservations/*``. + + Returns: + Callable[[~.SearchAllAssignmentsRequest], + ~.SearchAllAssignmentsResponse]: + 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 'search_all_assignments' not in self._stubs: + self._stubs['search_all_assignments'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/SearchAllAssignments', + request_serializer=reservation.SearchAllAssignmentsRequest.serialize, + response_deserializer=reservation.SearchAllAssignmentsResponse.deserialize, + ) + return self._stubs['search_all_assignments'] + + @property + def move_assignment(self) -> Callable[ + [reservation.MoveAssignmentRequest], + reservation.Assignment]: + r"""Return a callable for the move assignment method over gRPC. + + Moves an assignment under a new reservation. + + This differs from removing an existing assignment and + recreating a new one by providing a transactional change + that ensures an assignee always has an associated + reservation. + + Returns: + Callable[[~.MoveAssignmentRequest], + ~.Assignment]: + 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 'move_assignment' not in self._stubs: + self._stubs['move_assignment'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/MoveAssignment', + request_serializer=reservation.MoveAssignmentRequest.serialize, + response_deserializer=reservation.Assignment.deserialize, + ) + return self._stubs['move_assignment'] + + @property + def update_assignment(self) -> Callable[ + [reservation.UpdateAssignmentRequest], + reservation.Assignment]: + r"""Return a callable for the update assignment method over gRPC. + + Updates an existing assignment. + + Only the ``priority`` field can be updated. + + Returns: + Callable[[~.UpdateAssignmentRequest], + ~.Assignment]: + 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_assignment' not in self._stubs: + self._stubs['update_assignment'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/UpdateAssignment', + request_serializer=reservation.UpdateAssignmentRequest.serialize, + response_deserializer=reservation.Assignment.deserialize, + ) + return self._stubs['update_assignment'] + + @property + def get_bi_reservation(self) -> Callable[ + [reservation.GetBiReservationRequest], + reservation.BiReservation]: + r"""Return a callable for the get bi reservation method over gRPC. + + Retrieves a BI reservation. + + Returns: + Callable[[~.GetBiReservationRequest], + ~.BiReservation]: + 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_bi_reservation' not in self._stubs: + self._stubs['get_bi_reservation'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/GetBiReservation', + request_serializer=reservation.GetBiReservationRequest.serialize, + response_deserializer=reservation.BiReservation.deserialize, + ) + return self._stubs['get_bi_reservation'] + + @property + def update_bi_reservation(self) -> Callable[ + [reservation.UpdateBiReservationRequest], + reservation.BiReservation]: + r"""Return a callable for the update bi reservation method over gRPC. + + Updates a BI reservation. + + Only fields specified in the ``field_mask`` are updated. + + A singleton BI reservation always exists with default size 0. In + order to reserve BI capacity it needs to be updated to an amount + greater than 0. In order to release BI capacity reservation size + must be set to 0. + + Returns: + Callable[[~.UpdateBiReservationRequest], + ~.BiReservation]: + 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_bi_reservation' not in self._stubs: + self._stubs['update_bi_reservation'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/UpdateBiReservation', + request_serializer=reservation.UpdateBiReservationRequest.serialize, + response_deserializer=reservation.BiReservation.deserialize, + ) + return self._stubs['update_bi_reservation'] + + @property + def get_iam_policy(self) -> Callable[ + [iam_policy_pb2.GetIamPolicyRequest], + policy_pb2.Policy]: + r"""Return a callable for the get iam policy method over gRPC. + + Gets the access control policy for a resource. May return: + + - A\ ``NOT_FOUND`` error if the resource doesn't exist or you + don't have the permission to view it. + - An empty policy if the resource exists but doesn't have a set + policy. + + Supported resources are: + + - Reservations + - ReservationAssignments + + To call this method, you must have the following Google IAM + permissions: + + - ``bigqueryreservation.reservations.getIamPolicy`` to get + policies on reservations. + + Returns: + Callable[[~.GetIamPolicyRequest], + ~.Policy]: + 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_iam_policy' not in self._stubs: + self._stubs['get_iam_policy'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/GetIamPolicy', + request_serializer=iam_policy_pb2.GetIamPolicyRequest.SerializeToString, + response_deserializer=policy_pb2.Policy.FromString, + ) + return self._stubs['get_iam_policy'] + + @property + def set_iam_policy(self) -> Callable[ + [iam_policy_pb2.SetIamPolicyRequest], + policy_pb2.Policy]: + r"""Return a callable for the set iam policy method over gRPC. + + Sets an access control policy for a resource. Replaces any + existing policy. + + Supported resources are: + + - Reservations + + To call this method, you must have the following Google IAM + permissions: + + - ``bigqueryreservation.reservations.setIamPolicy`` to set + policies on reservations. + + Returns: + Callable[[~.SetIamPolicyRequest], + ~.Policy]: + 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 'set_iam_policy' not in self._stubs: + self._stubs['set_iam_policy'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/SetIamPolicy', + request_serializer=iam_policy_pb2.SetIamPolicyRequest.SerializeToString, + response_deserializer=policy_pb2.Policy.FromString, + ) + return self._stubs['set_iam_policy'] + + @property + def test_iam_permissions(self) -> Callable[ + [iam_policy_pb2.TestIamPermissionsRequest], + iam_policy_pb2.TestIamPermissionsResponse]: + r"""Return a callable for the test iam permissions method over gRPC. + + Gets your permissions on a resource. Returns an empty + set of permissions if the resource doesn't exist. + + Supported resources are: + + - Reservations + + No Google IAM permissions are required to call this + method. + + Returns: + Callable[[~.TestIamPermissionsRequest], + ~.TestIamPermissionsResponse]: + 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 'test_iam_permissions' not in self._stubs: + self._stubs['test_iam_permissions'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/TestIamPermissions', + request_serializer=iam_policy_pb2.TestIamPermissionsRequest.SerializeToString, + response_deserializer=iam_policy_pb2.TestIamPermissionsResponse.FromString, + ) + return self._stubs['test_iam_permissions'] + + @property + def create_reservation_group(self) -> Callable[ + [reservation.CreateReservationGroupRequest], + reservation.ReservationGroup]: + r"""Return a callable for the create reservation group method over gRPC. + + Creates a new reservation group. + + Returns: + Callable[[~.CreateReservationGroupRequest], + ~.ReservationGroup]: + 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_reservation_group' not in self._stubs: + self._stubs['create_reservation_group'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/CreateReservationGroup', + request_serializer=reservation.CreateReservationGroupRequest.serialize, + response_deserializer=reservation.ReservationGroup.deserialize, + ) + return self._stubs['create_reservation_group'] + + @property + def get_reservation_group(self) -> Callable[ + [reservation.GetReservationGroupRequest], + reservation.ReservationGroup]: + r"""Return a callable for the get reservation group method over gRPC. + + Returns information about the reservation group. + + Returns: + Callable[[~.GetReservationGroupRequest], + ~.ReservationGroup]: + 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_reservation_group' not in self._stubs: + self._stubs['get_reservation_group'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/GetReservationGroup', + request_serializer=reservation.GetReservationGroupRequest.serialize, + response_deserializer=reservation.ReservationGroup.deserialize, + ) + return self._stubs['get_reservation_group'] + + @property + def delete_reservation_group(self) -> Callable[ + [reservation.DeleteReservationGroupRequest], + empty_pb2.Empty]: + r"""Return a callable for the delete reservation group method over gRPC. + + Deletes a reservation. Returns + ``google.rpc.Code.FAILED_PRECONDITION`` when reservation has + assignments. + + Returns: + Callable[[~.DeleteReservationGroupRequest], + ~.Empty]: + 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_reservation_group' not in self._stubs: + self._stubs['delete_reservation_group'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/DeleteReservationGroup', + request_serializer=reservation.DeleteReservationGroupRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_reservation_group'] + + @property + def list_reservation_groups(self) -> Callable[ + [reservation.ListReservationGroupsRequest], + reservation.ListReservationGroupsResponse]: + r"""Return a callable for the list reservation groups method over gRPC. + + Lists all the reservation groups for the project in + the specified location. + + Returns: + Callable[[~.ListReservationGroupsRequest], + ~.ListReservationGroupsResponse]: + 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_reservation_groups' not in self._stubs: + self._stubs['list_reservation_groups'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/ListReservationGroups', + request_serializer=reservation.ListReservationGroupsRequest.serialize, + response_deserializer=reservation.ListReservationGroupsResponse.deserialize, + ) + return self._stubs['list_reservation_groups'] + + def close(self): + self._logged_channel.close() + + @property + def kind(self) -> str: + return "grpc" + + +__all__ = ( + 'ReservationServiceGrpcTransport', +) diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc_asyncio.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc_asyncio.py new file mode 100644 index 000000000000..e7eb71b138c7 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc_asyncio.py @@ -0,0 +1,1560 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 inspect +import json +import pickle +import logging as std_logging +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 exceptions as core_exceptions +from google.api_core import retry_async as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.protobuf.json_format import MessageToJson +import google.protobuf.message + +import grpc # type: ignore +import proto # type: ignore +from grpc.experimental import aio # type: ignore + +from google.cloud.bigquery_reservation_v1.types import reservation +from google.cloud.bigquery_reservation_v1.types import reservation as gcbr_reservation +from google.iam.v1 import iam_policy_pb2 # type: ignore +from google.iam.v1 import policy_pb2 # type: ignore +from google.protobuf import empty_pb2 # type: ignore +from .base import ReservationServiceTransport, DEFAULT_CLIENT_INFO +from .grpc import ReservationServiceGrpcTransport + +try: + from google.api_core import client_logging # type: ignore + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER +except ImportError: # pragma: NO COVER + CLIENT_LOGGING_SUPPORTED = False + +_LOGGER = std_logging.getLogger(__name__) + + +class _LoggingClientAIOInterceptor(grpc.aio.UnaryUnaryClientInterceptor): # pragma: NO COVER + async def intercept_unary_unary(self, continuation, client_call_details, request): + logging_enabled = CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(std_logging.DEBUG) + if logging_enabled: # pragma: NO COVER + request_metadata = client_call_details.metadata + if isinstance(request, proto.Message): + request_payload = type(request).to_json(request) + elif isinstance(request, google.protobuf.message.Message): + request_payload = MessageToJson(request) + else: + request_payload = f"{type(request).__name__}: {pickle.dumps(request)}" + + request_metadata = { + key: value.decode("utf-8") if isinstance(value, bytes) else value + for key, value in request_metadata + } + grpc_request = { + "payload": request_payload, + "requestMethod": "grpc", + "metadata": dict(request_metadata), + } + _LOGGER.debug( + f"Sending request for {client_call_details.method}", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": str(client_call_details.method), + "request": grpc_request, + "metadata": grpc_request["metadata"], + }, + ) + response = await continuation(client_call_details, request) + if logging_enabled: # pragma: NO COVER + response_metadata = await response.trailing_metadata() + # Convert gRPC metadata `` to list of tuples + metadata = dict([(k, str(v)) for k, v in response_metadata]) if response_metadata else None + result = await response + if isinstance(result, proto.Message): + response_payload = type(result).to_json(result) + elif isinstance(result, google.protobuf.message.Message): + response_payload = MessageToJson(result) + else: + response_payload = f"{type(result).__name__}: {pickle.dumps(result)}" + grpc_response = { + "payload": response_payload, + "metadata": metadata, + "status": "OK", + } + _LOGGER.debug( + f"Received response to rpc {client_call_details.method}.", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": str(client_call_details.method), + "response": grpc_response, + "metadata": grpc_response["metadata"], + }, + ) + return response + + +class ReservationServiceGrpcAsyncIOTransport(ReservationServiceTransport): + """gRPC AsyncIO backend transport for ReservationService. + + This API allows users to manage their BigQuery reservations. + + A reservation provides computational resource guarantees, in the + form of `slots `__, to + users. A slot is a unit of computational power in BigQuery, and + serves as the basic unit of parallelism. In a scan of a + multi-partitioned table, a single slot operates on a single + partition of the table. A reservation resource exists as a child + resource of the admin project and location, e.g.: + ``projects/myproject/locations/US/reservations/reservationName``. + + A capacity commitment is a way to purchase compute capacity for + BigQuery jobs (in the form of slots) with some committed period of + usage. A capacity commitment resource exists as a child resource of + the admin project and location, e.g.: + ``projects/myproject/locations/US/capacityCommitments/id``. + + 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 = 'bigqueryreservation.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`. + 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 = 'bigqueryreservation.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[Union[aio.Channel, Callable[..., 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 (default: 'bigqueryreservation.googleapis.com'). + 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 a ``channel`` instance 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 a ``channel`` instance 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[Union[aio.Channel, Callable[..., aio.Channel]]]): + A ``Channel`` instance through which to make calls, or a Callable + that constructs and returns one. If set to None, ``self.create_channel`` + is used to create the channel. If a Callable is given, it will be called + with the same arguments as used in ``self.create_channel``. + 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 a ``channel`` instance 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 a ``channel`` instance 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] = {} + + 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 isinstance(channel, aio.Channel): + # Ignore credentials if a channel was passed. + credentials = None + self._ignore_credentials = True + # 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: + # initialize with the provided callable or the default channel + channel_init = channel or type(self).create_channel + self._grpc_channel = channel_init( + 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), + ], + ) + + self._interceptor = _LoggingClientAIOInterceptor() + self._grpc_channel._unary_unary_interceptors.append(self._interceptor) + self._logged_channel = self._grpc_channel + self._wrap_with_kind = "kind" in inspect.signature(gapic_v1.method_async.wrap_method).parameters + # Wrap messages. This must be done after self._logged_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 create_reservation(self) -> Callable[ + [gcbr_reservation.CreateReservationRequest], + Awaitable[gcbr_reservation.Reservation]]: + r"""Return a callable for the create reservation method over gRPC. + + Creates a new reservation resource. + + Returns: + Callable[[~.CreateReservationRequest], + Awaitable[~.Reservation]]: + 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_reservation' not in self._stubs: + self._stubs['create_reservation'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/CreateReservation', + request_serializer=gcbr_reservation.CreateReservationRequest.serialize, + response_deserializer=gcbr_reservation.Reservation.deserialize, + ) + return self._stubs['create_reservation'] + + @property + def list_reservations(self) -> Callable[ + [reservation.ListReservationsRequest], + Awaitable[reservation.ListReservationsResponse]]: + r"""Return a callable for the list reservations method over gRPC. + + Lists all the reservations for the project in the + specified location. + + Returns: + Callable[[~.ListReservationsRequest], + Awaitable[~.ListReservationsResponse]]: + 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_reservations' not in self._stubs: + self._stubs['list_reservations'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/ListReservations', + request_serializer=reservation.ListReservationsRequest.serialize, + response_deserializer=reservation.ListReservationsResponse.deserialize, + ) + return self._stubs['list_reservations'] + + @property + def get_reservation(self) -> Callable[ + [reservation.GetReservationRequest], + Awaitable[reservation.Reservation]]: + r"""Return a callable for the get reservation method over gRPC. + + Returns information about the reservation. + + Returns: + Callable[[~.GetReservationRequest], + Awaitable[~.Reservation]]: + 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_reservation' not in self._stubs: + self._stubs['get_reservation'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/GetReservation', + request_serializer=reservation.GetReservationRequest.serialize, + response_deserializer=reservation.Reservation.deserialize, + ) + return self._stubs['get_reservation'] + + @property + def delete_reservation(self) -> Callable[ + [reservation.DeleteReservationRequest], + Awaitable[empty_pb2.Empty]]: + r"""Return a callable for the delete reservation method over gRPC. + + Deletes a reservation. Returns + ``google.rpc.Code.FAILED_PRECONDITION`` when reservation has + assignments. + + Returns: + Callable[[~.DeleteReservationRequest], + Awaitable[~.Empty]]: + 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_reservation' not in self._stubs: + self._stubs['delete_reservation'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/DeleteReservation', + request_serializer=reservation.DeleteReservationRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_reservation'] + + @property + def update_reservation(self) -> Callable[ + [gcbr_reservation.UpdateReservationRequest], + Awaitable[gcbr_reservation.Reservation]]: + r"""Return a callable for the update reservation method over gRPC. + + Updates an existing reservation resource. + + Returns: + Callable[[~.UpdateReservationRequest], + Awaitable[~.Reservation]]: + 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_reservation' not in self._stubs: + self._stubs['update_reservation'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/UpdateReservation', + request_serializer=gcbr_reservation.UpdateReservationRequest.serialize, + response_deserializer=gcbr_reservation.Reservation.deserialize, + ) + return self._stubs['update_reservation'] + + @property + def failover_reservation(self) -> Callable[ + [reservation.FailoverReservationRequest], + Awaitable[reservation.Reservation]]: + r"""Return a callable for the failover reservation method over gRPC. + + Fail over a reservation to the secondary location. The operation + should be done in the current secondary location, which will be + promoted to the new primary location for the reservation. + Attempting to failover a reservation in the current primary + location will fail with the error code + ``google.rpc.Code.FAILED_PRECONDITION``. + + Returns: + Callable[[~.FailoverReservationRequest], + Awaitable[~.Reservation]]: + 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 'failover_reservation' not in self._stubs: + self._stubs['failover_reservation'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/FailoverReservation', + request_serializer=reservation.FailoverReservationRequest.serialize, + response_deserializer=reservation.Reservation.deserialize, + ) + return self._stubs['failover_reservation'] + + @property + def create_capacity_commitment(self) -> Callable[ + [reservation.CreateCapacityCommitmentRequest], + Awaitable[reservation.CapacityCommitment]]: + r"""Return a callable for the create capacity commitment method over gRPC. + + Creates a new capacity commitment resource. + + Returns: + Callable[[~.CreateCapacityCommitmentRequest], + Awaitable[~.CapacityCommitment]]: + 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_capacity_commitment' not in self._stubs: + self._stubs['create_capacity_commitment'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/CreateCapacityCommitment', + request_serializer=reservation.CreateCapacityCommitmentRequest.serialize, + response_deserializer=reservation.CapacityCommitment.deserialize, + ) + return self._stubs['create_capacity_commitment'] + + @property + def list_capacity_commitments(self) -> Callable[ + [reservation.ListCapacityCommitmentsRequest], + Awaitable[reservation.ListCapacityCommitmentsResponse]]: + r"""Return a callable for the list capacity commitments method over gRPC. + + Lists all the capacity commitments for the admin + project. + + Returns: + Callable[[~.ListCapacityCommitmentsRequest], + Awaitable[~.ListCapacityCommitmentsResponse]]: + 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_capacity_commitments' not in self._stubs: + self._stubs['list_capacity_commitments'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/ListCapacityCommitments', + request_serializer=reservation.ListCapacityCommitmentsRequest.serialize, + response_deserializer=reservation.ListCapacityCommitmentsResponse.deserialize, + ) + return self._stubs['list_capacity_commitments'] + + @property + def get_capacity_commitment(self) -> Callable[ + [reservation.GetCapacityCommitmentRequest], + Awaitable[reservation.CapacityCommitment]]: + r"""Return a callable for the get capacity commitment method over gRPC. + + Returns information about the capacity commitment. + + Returns: + Callable[[~.GetCapacityCommitmentRequest], + Awaitable[~.CapacityCommitment]]: + 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_capacity_commitment' not in self._stubs: + self._stubs['get_capacity_commitment'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/GetCapacityCommitment', + request_serializer=reservation.GetCapacityCommitmentRequest.serialize, + response_deserializer=reservation.CapacityCommitment.deserialize, + ) + return self._stubs['get_capacity_commitment'] + + @property + def delete_capacity_commitment(self) -> Callable[ + [reservation.DeleteCapacityCommitmentRequest], + Awaitable[empty_pb2.Empty]]: + r"""Return a callable for the delete capacity commitment method over gRPC. + + Deletes a capacity commitment. Attempting to delete capacity + commitment before its commitment_end_time will fail with the + error code ``google.rpc.Code.FAILED_PRECONDITION``. + + Returns: + Callable[[~.DeleteCapacityCommitmentRequest], + Awaitable[~.Empty]]: + 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_capacity_commitment' not in self._stubs: + self._stubs['delete_capacity_commitment'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/DeleteCapacityCommitment', + request_serializer=reservation.DeleteCapacityCommitmentRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_capacity_commitment'] + + @property + def update_capacity_commitment(self) -> Callable[ + [reservation.UpdateCapacityCommitmentRequest], + Awaitable[reservation.CapacityCommitment]]: + r"""Return a callable for the update capacity commitment method over gRPC. + + Updates an existing capacity commitment. + + Only ``plan`` and ``renewal_plan`` fields can be updated. + + Plan can only be changed to a plan of a longer commitment + period. Attempting to change to a plan with shorter commitment + period will fail with the error code + ``google.rpc.Code.FAILED_PRECONDITION``. + + Returns: + Callable[[~.UpdateCapacityCommitmentRequest], + Awaitable[~.CapacityCommitment]]: + 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_capacity_commitment' not in self._stubs: + self._stubs['update_capacity_commitment'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/UpdateCapacityCommitment', + request_serializer=reservation.UpdateCapacityCommitmentRequest.serialize, + response_deserializer=reservation.CapacityCommitment.deserialize, + ) + return self._stubs['update_capacity_commitment'] + + @property + def split_capacity_commitment(self) -> Callable[ + [reservation.SplitCapacityCommitmentRequest], + Awaitable[reservation.SplitCapacityCommitmentResponse]]: + r"""Return a callable for the split capacity commitment method over gRPC. + + Splits capacity commitment to two commitments of the same plan + and ``commitment_end_time``. + + A common use case is to enable downgrading commitments. + + For example, in order to downgrade from 10000 slots to 8000, you + might split a 10000 capacity commitment into commitments of 2000 + and 8000. Then, you delete the first one after the commitment + end time passes. + + Returns: + Callable[[~.SplitCapacityCommitmentRequest], + Awaitable[~.SplitCapacityCommitmentResponse]]: + 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 'split_capacity_commitment' not in self._stubs: + self._stubs['split_capacity_commitment'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/SplitCapacityCommitment', + request_serializer=reservation.SplitCapacityCommitmentRequest.serialize, + response_deserializer=reservation.SplitCapacityCommitmentResponse.deserialize, + ) + return self._stubs['split_capacity_commitment'] + + @property + def merge_capacity_commitments(self) -> Callable[ + [reservation.MergeCapacityCommitmentsRequest], + Awaitable[reservation.CapacityCommitment]]: + r"""Return a callable for the merge capacity commitments method over gRPC. + + Merges capacity commitments of the same plan into a single + commitment. + + The resulting capacity commitment has the greater + commitment_end_time out of the to-be-merged capacity + commitments. + + Attempting to merge capacity commitments of different plan will + fail with the error code + ``google.rpc.Code.FAILED_PRECONDITION``. + + Returns: + Callable[[~.MergeCapacityCommitmentsRequest], + Awaitable[~.CapacityCommitment]]: + 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 'merge_capacity_commitments' not in self._stubs: + self._stubs['merge_capacity_commitments'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/MergeCapacityCommitments', + request_serializer=reservation.MergeCapacityCommitmentsRequest.serialize, + response_deserializer=reservation.CapacityCommitment.deserialize, + ) + return self._stubs['merge_capacity_commitments'] + + @property + def create_assignment(self) -> Callable[ + [reservation.CreateAssignmentRequest], + Awaitable[reservation.Assignment]]: + r"""Return a callable for the create assignment method over gRPC. + + Creates an assignment object which allows the given project to + submit jobs of a certain type using slots from the specified + reservation. + + Currently a resource (project, folder, organization) can only + have one assignment per each (job_type, location) combination, + and that reservation will be used for all jobs of the matching + type. + + Different assignments can be created on different levels of the + projects, folders or organization hierarchy. During query + execution, the assignment is looked up at the project, folder + and organization levels in that order. The first assignment + found is applied to the query. + + When creating assignments, it does not matter if other + assignments exist at higher levels. + + Example: + + - The organization ``organizationA`` contains two projects, + ``project1`` and ``project2``. + - Assignments for all three entities (``organizationA``, + ``project1``, and ``project2``) could all be created and + mapped to the same or different reservations. + + "None" assignments represent an absence of the assignment. + Projects assigned to None use on-demand pricing. To create a + "None" assignment, use "none" as a reservation_id in the parent. + Example parent: + ``projects/myproject/locations/US/reservations/none``. + + Returns ``google.rpc.Code.PERMISSION_DENIED`` if user does not + have 'bigquery.admin' permissions on the project using the + reservation and the project that owns this reservation. + + Returns ``google.rpc.Code.INVALID_ARGUMENT`` when location of + the assignment does not match location of the reservation. + + Returns: + Callable[[~.CreateAssignmentRequest], + Awaitable[~.Assignment]]: + 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_assignment' not in self._stubs: + self._stubs['create_assignment'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/CreateAssignment', + request_serializer=reservation.CreateAssignmentRequest.serialize, + response_deserializer=reservation.Assignment.deserialize, + ) + return self._stubs['create_assignment'] + + @property + def list_assignments(self) -> Callable[ + [reservation.ListAssignmentsRequest], + Awaitable[reservation.ListAssignmentsResponse]]: + r"""Return a callable for the list assignments method over gRPC. + + Lists assignments. + + Only explicitly created assignments will be returned. + + Example: + + - Organization ``organizationA`` contains two projects, + ``project1`` and ``project2``. + - Reservation ``res1`` exists and was created previously. + - CreateAssignment was used previously to define the following + associations between entities and reservations: + ```` and ```` + + In this example, ListAssignments will just return the above two + assignments for reservation ``res1``, and no expansion/merge + will happen. + + The wildcard "-" can be used for reservations in the request. In + that case all assignments belongs to the specified project and + location will be listed. + + **Note** "-" cannot be used for projects nor locations. + + Returns: + Callable[[~.ListAssignmentsRequest], + Awaitable[~.ListAssignmentsResponse]]: + 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_assignments' not in self._stubs: + self._stubs['list_assignments'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/ListAssignments', + request_serializer=reservation.ListAssignmentsRequest.serialize, + response_deserializer=reservation.ListAssignmentsResponse.deserialize, + ) + return self._stubs['list_assignments'] + + @property + def delete_assignment(self) -> Callable[ + [reservation.DeleteAssignmentRequest], + Awaitable[empty_pb2.Empty]]: + r"""Return a callable for the delete assignment method over gRPC. + + Deletes a assignment. No expansion will happen. + + Example: + + - Organization ``organizationA`` contains two projects, + ``project1`` and ``project2``. + - Reservation ``res1`` exists and was created previously. + - CreateAssignment was used previously to define the following + associations between entities and reservations: + ```` and ```` + + In this example, deletion of the ```` + assignment won't affect the other assignment + ````. After said deletion, queries from + ``project1`` will still use ``res1`` while queries from + ``project2`` will switch to use on-demand mode. + + Returns: + Callable[[~.DeleteAssignmentRequest], + Awaitable[~.Empty]]: + 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_assignment' not in self._stubs: + self._stubs['delete_assignment'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/DeleteAssignment', + request_serializer=reservation.DeleteAssignmentRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_assignment'] + + @property + def search_assignments(self) -> Callable[ + [reservation.SearchAssignmentsRequest], + Awaitable[reservation.SearchAssignmentsResponse]]: + r"""Return a callable for the search assignments method over gRPC. + + Deprecated: Looks up assignments for a specified resource for a + particular region. If the request is about a project: + + 1. Assignments created on the project will be returned if they + exist. + 2. Otherwise assignments created on the closest ancestor will be + returned. + 3. Assignments for different JobTypes will all be returned. + + The same logic applies if the request is about a folder. + + If the request is about an organization, then assignments + created on the organization will be returned (organization + doesn't have ancestors). + + Comparing to ListAssignments, there are some behavior + differences: + + 1. permission on the assignee will be verified in this API. + 2. Hierarchy lookup (project->folder->organization) happens in + this API. + 3. Parent here is ``projects/*/locations/*``, instead of + ``projects/*/locations/*reservations/*``. + + **Note** "-" cannot be used for projects nor locations. + + Returns: + Callable[[~.SearchAssignmentsRequest], + Awaitable[~.SearchAssignmentsResponse]]: + 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 'search_assignments' not in self._stubs: + self._stubs['search_assignments'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/SearchAssignments', + request_serializer=reservation.SearchAssignmentsRequest.serialize, + response_deserializer=reservation.SearchAssignmentsResponse.deserialize, + ) + return self._stubs['search_assignments'] + + @property + def search_all_assignments(self) -> Callable[ + [reservation.SearchAllAssignmentsRequest], + Awaitable[reservation.SearchAllAssignmentsResponse]]: + r"""Return a callable for the search all assignments method over gRPC. + + Looks up assignments for a specified resource for a particular + region. If the request is about a project: + + 1. Assignments created on the project will be returned if they + exist. + 2. Otherwise assignments created on the closest ancestor will be + returned. + 3. Assignments for different JobTypes will all be returned. + + The same logic applies if the request is about a folder. + + If the request is about an organization, then assignments + created on the organization will be returned (organization + doesn't have ancestors). + + Comparing to ListAssignments, there are some behavior + differences: + + 1. permission on the assignee will be verified in this API. + 2. Hierarchy lookup (project->folder->organization) happens in + this API. + 3. Parent here is ``projects/*/locations/*``, instead of + ``projects/*/locations/*reservations/*``. + + Returns: + Callable[[~.SearchAllAssignmentsRequest], + Awaitable[~.SearchAllAssignmentsResponse]]: + 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 'search_all_assignments' not in self._stubs: + self._stubs['search_all_assignments'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/SearchAllAssignments', + request_serializer=reservation.SearchAllAssignmentsRequest.serialize, + response_deserializer=reservation.SearchAllAssignmentsResponse.deserialize, + ) + return self._stubs['search_all_assignments'] + + @property + def move_assignment(self) -> Callable[ + [reservation.MoveAssignmentRequest], + Awaitable[reservation.Assignment]]: + r"""Return a callable for the move assignment method over gRPC. + + Moves an assignment under a new reservation. + + This differs from removing an existing assignment and + recreating a new one by providing a transactional change + that ensures an assignee always has an associated + reservation. + + Returns: + Callable[[~.MoveAssignmentRequest], + Awaitable[~.Assignment]]: + 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 'move_assignment' not in self._stubs: + self._stubs['move_assignment'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/MoveAssignment', + request_serializer=reservation.MoveAssignmentRequest.serialize, + response_deserializer=reservation.Assignment.deserialize, + ) + return self._stubs['move_assignment'] + + @property + def update_assignment(self) -> Callable[ + [reservation.UpdateAssignmentRequest], + Awaitable[reservation.Assignment]]: + r"""Return a callable for the update assignment method over gRPC. + + Updates an existing assignment. + + Only the ``priority`` field can be updated. + + Returns: + Callable[[~.UpdateAssignmentRequest], + Awaitable[~.Assignment]]: + 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_assignment' not in self._stubs: + self._stubs['update_assignment'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/UpdateAssignment', + request_serializer=reservation.UpdateAssignmentRequest.serialize, + response_deserializer=reservation.Assignment.deserialize, + ) + return self._stubs['update_assignment'] + + @property + def get_bi_reservation(self) -> Callable[ + [reservation.GetBiReservationRequest], + Awaitable[reservation.BiReservation]]: + r"""Return a callable for the get bi reservation method over gRPC. + + Retrieves a BI reservation. + + Returns: + Callable[[~.GetBiReservationRequest], + Awaitable[~.BiReservation]]: + 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_bi_reservation' not in self._stubs: + self._stubs['get_bi_reservation'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/GetBiReservation', + request_serializer=reservation.GetBiReservationRequest.serialize, + response_deserializer=reservation.BiReservation.deserialize, + ) + return self._stubs['get_bi_reservation'] + + @property + def update_bi_reservation(self) -> Callable[ + [reservation.UpdateBiReservationRequest], + Awaitable[reservation.BiReservation]]: + r"""Return a callable for the update bi reservation method over gRPC. + + Updates a BI reservation. + + Only fields specified in the ``field_mask`` are updated. + + A singleton BI reservation always exists with default size 0. In + order to reserve BI capacity it needs to be updated to an amount + greater than 0. In order to release BI capacity reservation size + must be set to 0. + + Returns: + Callable[[~.UpdateBiReservationRequest], + Awaitable[~.BiReservation]]: + 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_bi_reservation' not in self._stubs: + self._stubs['update_bi_reservation'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/UpdateBiReservation', + request_serializer=reservation.UpdateBiReservationRequest.serialize, + response_deserializer=reservation.BiReservation.deserialize, + ) + return self._stubs['update_bi_reservation'] + + @property + def get_iam_policy(self) -> Callable[ + [iam_policy_pb2.GetIamPolicyRequest], + Awaitable[policy_pb2.Policy]]: + r"""Return a callable for the get iam policy method over gRPC. + + Gets the access control policy for a resource. May return: + + - A\ ``NOT_FOUND`` error if the resource doesn't exist or you + don't have the permission to view it. + - An empty policy if the resource exists but doesn't have a set + policy. + + Supported resources are: + + - Reservations + - ReservationAssignments + + To call this method, you must have the following Google IAM + permissions: + + - ``bigqueryreservation.reservations.getIamPolicy`` to get + policies on reservations. + + Returns: + Callable[[~.GetIamPolicyRequest], + Awaitable[~.Policy]]: + 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_iam_policy' not in self._stubs: + self._stubs['get_iam_policy'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/GetIamPolicy', + request_serializer=iam_policy_pb2.GetIamPolicyRequest.SerializeToString, + response_deserializer=policy_pb2.Policy.FromString, + ) + return self._stubs['get_iam_policy'] + + @property + def set_iam_policy(self) -> Callable[ + [iam_policy_pb2.SetIamPolicyRequest], + Awaitable[policy_pb2.Policy]]: + r"""Return a callable for the set iam policy method over gRPC. + + Sets an access control policy for a resource. Replaces any + existing policy. + + Supported resources are: + + - Reservations + + To call this method, you must have the following Google IAM + permissions: + + - ``bigqueryreservation.reservations.setIamPolicy`` to set + policies on reservations. + + Returns: + Callable[[~.SetIamPolicyRequest], + Awaitable[~.Policy]]: + 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 'set_iam_policy' not in self._stubs: + self._stubs['set_iam_policy'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/SetIamPolicy', + request_serializer=iam_policy_pb2.SetIamPolicyRequest.SerializeToString, + response_deserializer=policy_pb2.Policy.FromString, + ) + return self._stubs['set_iam_policy'] + + @property + def test_iam_permissions(self) -> Callable[ + [iam_policy_pb2.TestIamPermissionsRequest], + Awaitable[iam_policy_pb2.TestIamPermissionsResponse]]: + r"""Return a callable for the test iam permissions method over gRPC. + + Gets your permissions on a resource. Returns an empty + set of permissions if the resource doesn't exist. + + Supported resources are: + + - Reservations + + No Google IAM permissions are required to call this + method. + + Returns: + Callable[[~.TestIamPermissionsRequest], + Awaitable[~.TestIamPermissionsResponse]]: + 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 'test_iam_permissions' not in self._stubs: + self._stubs['test_iam_permissions'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/TestIamPermissions', + request_serializer=iam_policy_pb2.TestIamPermissionsRequest.SerializeToString, + response_deserializer=iam_policy_pb2.TestIamPermissionsResponse.FromString, + ) + return self._stubs['test_iam_permissions'] + + @property + def create_reservation_group(self) -> Callable[ + [reservation.CreateReservationGroupRequest], + Awaitable[reservation.ReservationGroup]]: + r"""Return a callable for the create reservation group method over gRPC. + + Creates a new reservation group. + + Returns: + Callable[[~.CreateReservationGroupRequest], + Awaitable[~.ReservationGroup]]: + 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_reservation_group' not in self._stubs: + self._stubs['create_reservation_group'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/CreateReservationGroup', + request_serializer=reservation.CreateReservationGroupRequest.serialize, + response_deserializer=reservation.ReservationGroup.deserialize, + ) + return self._stubs['create_reservation_group'] + + @property + def get_reservation_group(self) -> Callable[ + [reservation.GetReservationGroupRequest], + Awaitable[reservation.ReservationGroup]]: + r"""Return a callable for the get reservation group method over gRPC. + + Returns information about the reservation group. + + Returns: + Callable[[~.GetReservationGroupRequest], + Awaitable[~.ReservationGroup]]: + 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_reservation_group' not in self._stubs: + self._stubs['get_reservation_group'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/GetReservationGroup', + request_serializer=reservation.GetReservationGroupRequest.serialize, + response_deserializer=reservation.ReservationGroup.deserialize, + ) + return self._stubs['get_reservation_group'] + + @property + def delete_reservation_group(self) -> Callable[ + [reservation.DeleteReservationGroupRequest], + Awaitable[empty_pb2.Empty]]: + r"""Return a callable for the delete reservation group method over gRPC. + + Deletes a reservation. Returns + ``google.rpc.Code.FAILED_PRECONDITION`` when reservation has + assignments. + + Returns: + Callable[[~.DeleteReservationGroupRequest], + Awaitable[~.Empty]]: + 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_reservation_group' not in self._stubs: + self._stubs['delete_reservation_group'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/DeleteReservationGroup', + request_serializer=reservation.DeleteReservationGroupRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_reservation_group'] + + @property + def list_reservation_groups(self) -> Callable[ + [reservation.ListReservationGroupsRequest], + Awaitable[reservation.ListReservationGroupsResponse]]: + r"""Return a callable for the list reservation groups method over gRPC. + + Lists all the reservation groups for the project in + the specified location. + + Returns: + Callable[[~.ListReservationGroupsRequest], + Awaitable[~.ListReservationGroupsResponse]]: + 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_reservation_groups' not in self._stubs: + self._stubs['list_reservation_groups'] = self._logged_channel.unary_unary( + '/google.cloud.bigquery.reservation.v1.ReservationService/ListReservationGroups', + request_serializer=reservation.ListReservationGroupsRequest.serialize, + response_deserializer=reservation.ListReservationGroupsResponse.deserialize, + ) + return self._stubs['list_reservation_groups'] + + def _prep_wrapped_messages(self, client_info): + """ Precompute the wrapped methods, overriding the base class method to use async wrappers.""" + self._wrapped_methods = { + self.create_reservation: self._wrap_method( + self.create_reservation, + default_timeout=300.0, + client_info=client_info, + ), + self.list_reservations: self._wrap_method( + self.list_reservations, + default_retry=retries.AsyncRetry( + initial=0.1, + maximum=60.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=300.0, + ), + default_timeout=300.0, + client_info=client_info, + ), + self.get_reservation: self._wrap_method( + self.get_reservation, + default_retry=retries.AsyncRetry( + initial=0.1, + maximum=60.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=300.0, + ), + default_timeout=300.0, + client_info=client_info, + ), + self.delete_reservation: self._wrap_method( + self.delete_reservation, + default_retry=retries.AsyncRetry( + initial=0.1, + maximum=60.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=300.0, + ), + default_timeout=300.0, + client_info=client_info, + ), + self.update_reservation: self._wrap_method( + self.update_reservation, + default_timeout=300.0, + client_info=client_info, + ), + self.failover_reservation: self._wrap_method( + self.failover_reservation, + default_timeout=300.0, + client_info=client_info, + ), + self.create_capacity_commitment: self._wrap_method( + self.create_capacity_commitment, + default_timeout=300.0, + client_info=client_info, + ), + self.list_capacity_commitments: self._wrap_method( + self.list_capacity_commitments, + default_retry=retries.AsyncRetry( + initial=0.1, + maximum=60.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=300.0, + ), + default_timeout=300.0, + client_info=client_info, + ), + self.get_capacity_commitment: self._wrap_method( + self.get_capacity_commitment, + default_retry=retries.AsyncRetry( + initial=0.1, + maximum=60.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=300.0, + ), + default_timeout=300.0, + client_info=client_info, + ), + self.delete_capacity_commitment: self._wrap_method( + self.delete_capacity_commitment, + default_retry=retries.AsyncRetry( + initial=0.1, + maximum=60.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=300.0, + ), + default_timeout=300.0, + client_info=client_info, + ), + self.update_capacity_commitment: self._wrap_method( + self.update_capacity_commitment, + default_timeout=300.0, + client_info=client_info, + ), + self.split_capacity_commitment: self._wrap_method( + self.split_capacity_commitment, + default_timeout=300.0, + client_info=client_info, + ), + self.merge_capacity_commitments: self._wrap_method( + self.merge_capacity_commitments, + default_timeout=300.0, + client_info=client_info, + ), + self.create_assignment: self._wrap_method( + self.create_assignment, + default_timeout=300.0, + client_info=client_info, + ), + self.list_assignments: self._wrap_method( + self.list_assignments, + default_retry=retries.AsyncRetry( + initial=0.1, + maximum=60.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=300.0, + ), + default_timeout=300.0, + client_info=client_info, + ), + self.delete_assignment: self._wrap_method( + self.delete_assignment, + default_retry=retries.AsyncRetry( + initial=0.1, + maximum=60.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=300.0, + ), + default_timeout=300.0, + client_info=client_info, + ), + self.search_assignments: self._wrap_method( + self.search_assignments, + default_retry=retries.AsyncRetry( + initial=0.1, + maximum=60.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=300.0, + ), + default_timeout=300.0, + client_info=client_info, + ), + self.search_all_assignments: self._wrap_method( + self.search_all_assignments, + default_timeout=None, + client_info=client_info, + ), + self.move_assignment: self._wrap_method( + self.move_assignment, + default_timeout=300.0, + client_info=client_info, + ), + self.update_assignment: self._wrap_method( + self.update_assignment, + default_timeout=None, + client_info=client_info, + ), + self.get_bi_reservation: self._wrap_method( + self.get_bi_reservation, + default_retry=retries.AsyncRetry( + initial=0.1, + maximum=60.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=300.0, + ), + default_timeout=300.0, + client_info=client_info, + ), + self.update_bi_reservation: self._wrap_method( + self.update_bi_reservation, + default_timeout=300.0, + client_info=client_info, + ), + self.get_iam_policy: self._wrap_method( + self.get_iam_policy, + default_timeout=None, + client_info=client_info, + ), + self.set_iam_policy: self._wrap_method( + self.set_iam_policy, + default_timeout=None, + client_info=client_info, + ), + self.test_iam_permissions: self._wrap_method( + self.test_iam_permissions, + default_timeout=None, + client_info=client_info, + ), + self.create_reservation_group: self._wrap_method( + self.create_reservation_group, + default_timeout=None, + client_info=client_info, + ), + self.get_reservation_group: self._wrap_method( + self.get_reservation_group, + default_timeout=None, + client_info=client_info, + ), + self.delete_reservation_group: self._wrap_method( + self.delete_reservation_group, + default_timeout=None, + client_info=client_info, + ), + self.list_reservation_groups: self._wrap_method( + self.list_reservation_groups, + default_timeout=None, + client_info=client_info, + ), + } + + def _wrap_method(self, func, *args, **kwargs): + if self._wrap_with_kind: # pragma: NO COVER + kwargs["kind"] = self.kind + return gapic_v1.method_async.wrap_method(func, *args, **kwargs) + + def close(self): + return self._logged_channel.close() + + @property + def kind(self) -> str: + return "grpc_asyncio" + + +__all__ = ( + 'ReservationServiceGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/rest.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/rest.py new file mode 100644 index 000000000000..a14b23460d5f --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/rest.py @@ -0,0 +1,5221 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 logging +import json # type: ignore + +from google.auth.transport.requests import AuthorizedSession # 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 gapic_v1 +import google.protobuf + +from google.protobuf import json_format + +from requests import __version__ as requests_version +import dataclasses +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + + +from google.cloud.bigquery_reservation_v1.types import reservation +from google.cloud.bigquery_reservation_v1.types import reservation as gcbr_reservation +from google.iam.v1 import iam_policy_pb2 # type: ignore +from google.iam.v1 import policy_pb2 # type: ignore +from google.protobuf import empty_pb2 # type: ignore + + +from .rest_base import _BaseReservationServiceRestTransport +from .base import DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object, None] # type: ignore + +try: + from google.api_core import client_logging # type: ignore + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER +except ImportError: # pragma: NO COVER + CLIENT_LOGGING_SUPPORTED = False + +_LOGGER = logging.getLogger(__name__) + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=f"requests@{requests_version}", +) + +if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER + DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ + + +class ReservationServiceRestInterceptor: + """Interceptor for ReservationService. + + 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 ReservationServiceRestTransport. + + .. code-block:: python + class MyCustomReservationServiceInterceptor(ReservationServiceRestInterceptor): + def pre_create_assignment(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_assignment(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_create_capacity_commitment(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_capacity_commitment(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_create_reservation(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_reservation(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_create_reservation_group(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_reservation_group(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_delete_assignment(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_delete_capacity_commitment(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_delete_reservation(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_delete_reservation_group(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_failover_reservation(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_failover_reservation(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_bi_reservation(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_bi_reservation(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_capacity_commitment(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_capacity_commitment(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_iam_policy(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_iam_policy(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_reservation(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_reservation(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_reservation_group(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_reservation_group(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_assignments(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_assignments(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_capacity_commitments(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_capacity_commitments(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_reservation_groups(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_reservation_groups(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_reservations(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_reservations(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_merge_capacity_commitments(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_merge_capacity_commitments(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_move_assignment(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_move_assignment(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_search_all_assignments(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_search_all_assignments(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_search_assignments(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_search_assignments(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_set_iam_policy(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_set_iam_policy(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_split_capacity_commitment(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_split_capacity_commitment(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_test_iam_permissions(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_test_iam_permissions(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_assignment(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_assignment(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_bi_reservation(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_bi_reservation(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_capacity_commitment(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_capacity_commitment(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_reservation(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_reservation(self, response): + logging.log(f"Received response: {response}") + return response + + transport = ReservationServiceRestTransport(interceptor=MyCustomReservationServiceInterceptor()) + client = ReservationServiceClient(transport=transport) + + + """ + def pre_create_assignment(self, request: reservation.CreateAssignmentRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.CreateAssignmentRequest, Sequence[Tuple[str, Union[str, bytes]]]]: + """Pre-rpc interceptor for create_assignment + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def post_create_assignment(self, response: reservation.Assignment) -> reservation.Assignment: + """Post-rpc interceptor for create_assignment + + DEPRECATED. Please use the `post_create_assignment_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ReservationService server but before + it is returned to user code. This `post_create_assignment` interceptor runs + before the `post_create_assignment_with_metadata` interceptor. + """ + return response + + def post_create_assignment_with_metadata(self, response: reservation.Assignment, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.Assignment, Sequence[Tuple[str, Union[str, bytes]]]]: + """Post-rpc interceptor for create_assignment + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ReservationService server but before it is returned to user code. + + We recommend only using this `post_create_assignment_with_metadata` + interceptor in new development instead of the `post_create_assignment` interceptor. + When both interceptors are used, this `post_create_assignment_with_metadata` interceptor runs after the + `post_create_assignment` interceptor. The (possibly modified) response returned by + `post_create_assignment` will be passed to + `post_create_assignment_with_metadata`. + """ + return response, metadata + + def pre_create_capacity_commitment(self, request: reservation.CreateCapacityCommitmentRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.CreateCapacityCommitmentRequest, Sequence[Tuple[str, Union[str, bytes]]]]: + """Pre-rpc interceptor for create_capacity_commitment + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def post_create_capacity_commitment(self, response: reservation.CapacityCommitment) -> reservation.CapacityCommitment: + """Post-rpc interceptor for create_capacity_commitment + + DEPRECATED. Please use the `post_create_capacity_commitment_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ReservationService server but before + it is returned to user code. This `post_create_capacity_commitment` interceptor runs + before the `post_create_capacity_commitment_with_metadata` interceptor. + """ + return response + + def post_create_capacity_commitment_with_metadata(self, response: reservation.CapacityCommitment, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.CapacityCommitment, Sequence[Tuple[str, Union[str, bytes]]]]: + """Post-rpc interceptor for create_capacity_commitment + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ReservationService server but before it is returned to user code. + + We recommend only using this `post_create_capacity_commitment_with_metadata` + interceptor in new development instead of the `post_create_capacity_commitment` interceptor. + When both interceptors are used, this `post_create_capacity_commitment_with_metadata` interceptor runs after the + `post_create_capacity_commitment` interceptor. The (possibly modified) response returned by + `post_create_capacity_commitment` will be passed to + `post_create_capacity_commitment_with_metadata`. + """ + return response, metadata + + def pre_create_reservation(self, request: gcbr_reservation.CreateReservationRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[gcbr_reservation.CreateReservationRequest, Sequence[Tuple[str, Union[str, bytes]]]]: + """Pre-rpc interceptor for create_reservation + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def post_create_reservation(self, response: gcbr_reservation.Reservation) -> gcbr_reservation.Reservation: + """Post-rpc interceptor for create_reservation + + DEPRECATED. Please use the `post_create_reservation_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ReservationService server but before + it is returned to user code. This `post_create_reservation` interceptor runs + before the `post_create_reservation_with_metadata` interceptor. + """ + return response + + def post_create_reservation_with_metadata(self, response: gcbr_reservation.Reservation, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[gcbr_reservation.Reservation, Sequence[Tuple[str, Union[str, bytes]]]]: + """Post-rpc interceptor for create_reservation + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ReservationService server but before it is returned to user code. + + We recommend only using this `post_create_reservation_with_metadata` + interceptor in new development instead of the `post_create_reservation` interceptor. + When both interceptors are used, this `post_create_reservation_with_metadata` interceptor runs after the + `post_create_reservation` interceptor. The (possibly modified) response returned by + `post_create_reservation` will be passed to + `post_create_reservation_with_metadata`. + """ + return response, metadata + + def pre_create_reservation_group(self, request: reservation.CreateReservationGroupRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.CreateReservationGroupRequest, Sequence[Tuple[str, Union[str, bytes]]]]: + """Pre-rpc interceptor for create_reservation_group + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def post_create_reservation_group(self, response: reservation.ReservationGroup) -> reservation.ReservationGroup: + """Post-rpc interceptor for create_reservation_group + + DEPRECATED. Please use the `post_create_reservation_group_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ReservationService server but before + it is returned to user code. This `post_create_reservation_group` interceptor runs + before the `post_create_reservation_group_with_metadata` interceptor. + """ + return response + + def post_create_reservation_group_with_metadata(self, response: reservation.ReservationGroup, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.ReservationGroup, Sequence[Tuple[str, Union[str, bytes]]]]: + """Post-rpc interceptor for create_reservation_group + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ReservationService server but before it is returned to user code. + + We recommend only using this `post_create_reservation_group_with_metadata` + interceptor in new development instead of the `post_create_reservation_group` interceptor. + When both interceptors are used, this `post_create_reservation_group_with_metadata` interceptor runs after the + `post_create_reservation_group` interceptor. The (possibly modified) response returned by + `post_create_reservation_group` will be passed to + `post_create_reservation_group_with_metadata`. + """ + return response, metadata + + def pre_delete_assignment(self, request: reservation.DeleteAssignmentRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.DeleteAssignmentRequest, Sequence[Tuple[str, Union[str, bytes]]]]: + """Pre-rpc interceptor for delete_assignment + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def pre_delete_capacity_commitment(self, request: reservation.DeleteCapacityCommitmentRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.DeleteCapacityCommitmentRequest, Sequence[Tuple[str, Union[str, bytes]]]]: + """Pre-rpc interceptor for delete_capacity_commitment + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def pre_delete_reservation(self, request: reservation.DeleteReservationRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.DeleteReservationRequest, Sequence[Tuple[str, Union[str, bytes]]]]: + """Pre-rpc interceptor for delete_reservation + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def pre_delete_reservation_group(self, request: reservation.DeleteReservationGroupRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.DeleteReservationGroupRequest, Sequence[Tuple[str, Union[str, bytes]]]]: + """Pre-rpc interceptor for delete_reservation_group + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def pre_failover_reservation(self, request: reservation.FailoverReservationRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.FailoverReservationRequest, Sequence[Tuple[str, Union[str, bytes]]]]: + """Pre-rpc interceptor for failover_reservation + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def post_failover_reservation(self, response: reservation.Reservation) -> reservation.Reservation: + """Post-rpc interceptor for failover_reservation + + DEPRECATED. Please use the `post_failover_reservation_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ReservationService server but before + it is returned to user code. This `post_failover_reservation` interceptor runs + before the `post_failover_reservation_with_metadata` interceptor. + """ + return response + + def post_failover_reservation_with_metadata(self, response: reservation.Reservation, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.Reservation, Sequence[Tuple[str, Union[str, bytes]]]]: + """Post-rpc interceptor for failover_reservation + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ReservationService server but before it is returned to user code. + + We recommend only using this `post_failover_reservation_with_metadata` + interceptor in new development instead of the `post_failover_reservation` interceptor. + When both interceptors are used, this `post_failover_reservation_with_metadata` interceptor runs after the + `post_failover_reservation` interceptor. The (possibly modified) response returned by + `post_failover_reservation` will be passed to + `post_failover_reservation_with_metadata`. + """ + return response, metadata + + def pre_get_bi_reservation(self, request: reservation.GetBiReservationRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.GetBiReservationRequest, Sequence[Tuple[str, Union[str, bytes]]]]: + """Pre-rpc interceptor for get_bi_reservation + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def post_get_bi_reservation(self, response: reservation.BiReservation) -> reservation.BiReservation: + """Post-rpc interceptor for get_bi_reservation + + DEPRECATED. Please use the `post_get_bi_reservation_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ReservationService server but before + it is returned to user code. This `post_get_bi_reservation` interceptor runs + before the `post_get_bi_reservation_with_metadata` interceptor. + """ + return response + + def post_get_bi_reservation_with_metadata(self, response: reservation.BiReservation, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.BiReservation, Sequence[Tuple[str, Union[str, bytes]]]]: + """Post-rpc interceptor for get_bi_reservation + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ReservationService server but before it is returned to user code. + + We recommend only using this `post_get_bi_reservation_with_metadata` + interceptor in new development instead of the `post_get_bi_reservation` interceptor. + When both interceptors are used, this `post_get_bi_reservation_with_metadata` interceptor runs after the + `post_get_bi_reservation` interceptor. The (possibly modified) response returned by + `post_get_bi_reservation` will be passed to + `post_get_bi_reservation_with_metadata`. + """ + return response, metadata + + def pre_get_capacity_commitment(self, request: reservation.GetCapacityCommitmentRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.GetCapacityCommitmentRequest, Sequence[Tuple[str, Union[str, bytes]]]]: + """Pre-rpc interceptor for get_capacity_commitment + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def post_get_capacity_commitment(self, response: reservation.CapacityCommitment) -> reservation.CapacityCommitment: + """Post-rpc interceptor for get_capacity_commitment + + DEPRECATED. Please use the `post_get_capacity_commitment_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ReservationService server but before + it is returned to user code. This `post_get_capacity_commitment` interceptor runs + before the `post_get_capacity_commitment_with_metadata` interceptor. + """ + return response + + def post_get_capacity_commitment_with_metadata(self, response: reservation.CapacityCommitment, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.CapacityCommitment, Sequence[Tuple[str, Union[str, bytes]]]]: + """Post-rpc interceptor for get_capacity_commitment + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ReservationService server but before it is returned to user code. + + We recommend only using this `post_get_capacity_commitment_with_metadata` + interceptor in new development instead of the `post_get_capacity_commitment` interceptor. + When both interceptors are used, this `post_get_capacity_commitment_with_metadata` interceptor runs after the + `post_get_capacity_commitment` interceptor. The (possibly modified) response returned by + `post_get_capacity_commitment` will be passed to + `post_get_capacity_commitment_with_metadata`. + """ + return response, metadata + + def pre_get_iam_policy(self, request: iam_policy_pb2.GetIamPolicyRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[iam_policy_pb2.GetIamPolicyRequest, Sequence[Tuple[str, Union[str, bytes]]]]: + """Pre-rpc interceptor for get_iam_policy + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def post_get_iam_policy(self, response: policy_pb2.Policy) -> policy_pb2.Policy: + """Post-rpc interceptor for get_iam_policy + + DEPRECATED. Please use the `post_get_iam_policy_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ReservationService server but before + it is returned to user code. This `post_get_iam_policy` interceptor runs + before the `post_get_iam_policy_with_metadata` interceptor. + """ + return response + + def post_get_iam_policy_with_metadata(self, response: policy_pb2.Policy, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[policy_pb2.Policy, Sequence[Tuple[str, Union[str, bytes]]]]: + """Post-rpc interceptor for get_iam_policy + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ReservationService server but before it is returned to user code. + + We recommend only using this `post_get_iam_policy_with_metadata` + interceptor in new development instead of the `post_get_iam_policy` interceptor. + When both interceptors are used, this `post_get_iam_policy_with_metadata` interceptor runs after the + `post_get_iam_policy` interceptor. The (possibly modified) response returned by + `post_get_iam_policy` will be passed to + `post_get_iam_policy_with_metadata`. + """ + return response, metadata + + def pre_get_reservation(self, request: reservation.GetReservationRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.GetReservationRequest, Sequence[Tuple[str, Union[str, bytes]]]]: + """Pre-rpc interceptor for get_reservation + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def post_get_reservation(self, response: reservation.Reservation) -> reservation.Reservation: + """Post-rpc interceptor for get_reservation + + DEPRECATED. Please use the `post_get_reservation_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ReservationService server but before + it is returned to user code. This `post_get_reservation` interceptor runs + before the `post_get_reservation_with_metadata` interceptor. + """ + return response + + def post_get_reservation_with_metadata(self, response: reservation.Reservation, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.Reservation, Sequence[Tuple[str, Union[str, bytes]]]]: + """Post-rpc interceptor for get_reservation + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ReservationService server but before it is returned to user code. + + We recommend only using this `post_get_reservation_with_metadata` + interceptor in new development instead of the `post_get_reservation` interceptor. + When both interceptors are used, this `post_get_reservation_with_metadata` interceptor runs after the + `post_get_reservation` interceptor. The (possibly modified) response returned by + `post_get_reservation` will be passed to + `post_get_reservation_with_metadata`. + """ + return response, metadata + + def pre_get_reservation_group(self, request: reservation.GetReservationGroupRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.GetReservationGroupRequest, Sequence[Tuple[str, Union[str, bytes]]]]: + """Pre-rpc interceptor for get_reservation_group + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def post_get_reservation_group(self, response: reservation.ReservationGroup) -> reservation.ReservationGroup: + """Post-rpc interceptor for get_reservation_group + + DEPRECATED. Please use the `post_get_reservation_group_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ReservationService server but before + it is returned to user code. This `post_get_reservation_group` interceptor runs + before the `post_get_reservation_group_with_metadata` interceptor. + """ + return response + + def post_get_reservation_group_with_metadata(self, response: reservation.ReservationGroup, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.ReservationGroup, Sequence[Tuple[str, Union[str, bytes]]]]: + """Post-rpc interceptor for get_reservation_group + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ReservationService server but before it is returned to user code. + + We recommend only using this `post_get_reservation_group_with_metadata` + interceptor in new development instead of the `post_get_reservation_group` interceptor. + When both interceptors are used, this `post_get_reservation_group_with_metadata` interceptor runs after the + `post_get_reservation_group` interceptor. The (possibly modified) response returned by + `post_get_reservation_group` will be passed to + `post_get_reservation_group_with_metadata`. + """ + return response, metadata + + def pre_list_assignments(self, request: reservation.ListAssignmentsRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.ListAssignmentsRequest, Sequence[Tuple[str, Union[str, bytes]]]]: + """Pre-rpc interceptor for list_assignments + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def post_list_assignments(self, response: reservation.ListAssignmentsResponse) -> reservation.ListAssignmentsResponse: + """Post-rpc interceptor for list_assignments + + DEPRECATED. Please use the `post_list_assignments_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ReservationService server but before + it is returned to user code. This `post_list_assignments` interceptor runs + before the `post_list_assignments_with_metadata` interceptor. + """ + return response + + def post_list_assignments_with_metadata(self, response: reservation.ListAssignmentsResponse, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.ListAssignmentsResponse, Sequence[Tuple[str, Union[str, bytes]]]]: + """Post-rpc interceptor for list_assignments + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ReservationService server but before it is returned to user code. + + We recommend only using this `post_list_assignments_with_metadata` + interceptor in new development instead of the `post_list_assignments` interceptor. + When both interceptors are used, this `post_list_assignments_with_metadata` interceptor runs after the + `post_list_assignments` interceptor. The (possibly modified) response returned by + `post_list_assignments` will be passed to + `post_list_assignments_with_metadata`. + """ + return response, metadata + + def pre_list_capacity_commitments(self, request: reservation.ListCapacityCommitmentsRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.ListCapacityCommitmentsRequest, Sequence[Tuple[str, Union[str, bytes]]]]: + """Pre-rpc interceptor for list_capacity_commitments + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def post_list_capacity_commitments(self, response: reservation.ListCapacityCommitmentsResponse) -> reservation.ListCapacityCommitmentsResponse: + """Post-rpc interceptor for list_capacity_commitments + + DEPRECATED. Please use the `post_list_capacity_commitments_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ReservationService server but before + it is returned to user code. This `post_list_capacity_commitments` interceptor runs + before the `post_list_capacity_commitments_with_metadata` interceptor. + """ + return response + + def post_list_capacity_commitments_with_metadata(self, response: reservation.ListCapacityCommitmentsResponse, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.ListCapacityCommitmentsResponse, Sequence[Tuple[str, Union[str, bytes]]]]: + """Post-rpc interceptor for list_capacity_commitments + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ReservationService server but before it is returned to user code. + + We recommend only using this `post_list_capacity_commitments_with_metadata` + interceptor in new development instead of the `post_list_capacity_commitments` interceptor. + When both interceptors are used, this `post_list_capacity_commitments_with_metadata` interceptor runs after the + `post_list_capacity_commitments` interceptor. The (possibly modified) response returned by + `post_list_capacity_commitments` will be passed to + `post_list_capacity_commitments_with_metadata`. + """ + return response, metadata + + def pre_list_reservation_groups(self, request: reservation.ListReservationGroupsRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.ListReservationGroupsRequest, Sequence[Tuple[str, Union[str, bytes]]]]: + """Pre-rpc interceptor for list_reservation_groups + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def post_list_reservation_groups(self, response: reservation.ListReservationGroupsResponse) -> reservation.ListReservationGroupsResponse: + """Post-rpc interceptor for list_reservation_groups + + DEPRECATED. Please use the `post_list_reservation_groups_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ReservationService server but before + it is returned to user code. This `post_list_reservation_groups` interceptor runs + before the `post_list_reservation_groups_with_metadata` interceptor. + """ + return response + + def post_list_reservation_groups_with_metadata(self, response: reservation.ListReservationGroupsResponse, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.ListReservationGroupsResponse, Sequence[Tuple[str, Union[str, bytes]]]]: + """Post-rpc interceptor for list_reservation_groups + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ReservationService server but before it is returned to user code. + + We recommend only using this `post_list_reservation_groups_with_metadata` + interceptor in new development instead of the `post_list_reservation_groups` interceptor. + When both interceptors are used, this `post_list_reservation_groups_with_metadata` interceptor runs after the + `post_list_reservation_groups` interceptor. The (possibly modified) response returned by + `post_list_reservation_groups` will be passed to + `post_list_reservation_groups_with_metadata`. + """ + return response, metadata + + def pre_list_reservations(self, request: reservation.ListReservationsRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.ListReservationsRequest, Sequence[Tuple[str, Union[str, bytes]]]]: + """Pre-rpc interceptor for list_reservations + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def post_list_reservations(self, response: reservation.ListReservationsResponse) -> reservation.ListReservationsResponse: + """Post-rpc interceptor for list_reservations + + DEPRECATED. Please use the `post_list_reservations_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ReservationService server but before + it is returned to user code. This `post_list_reservations` interceptor runs + before the `post_list_reservations_with_metadata` interceptor. + """ + return response + + def post_list_reservations_with_metadata(self, response: reservation.ListReservationsResponse, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.ListReservationsResponse, Sequence[Tuple[str, Union[str, bytes]]]]: + """Post-rpc interceptor for list_reservations + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ReservationService server but before it is returned to user code. + + We recommend only using this `post_list_reservations_with_metadata` + interceptor in new development instead of the `post_list_reservations` interceptor. + When both interceptors are used, this `post_list_reservations_with_metadata` interceptor runs after the + `post_list_reservations` interceptor. The (possibly modified) response returned by + `post_list_reservations` will be passed to + `post_list_reservations_with_metadata`. + """ + return response, metadata + + def pre_merge_capacity_commitments(self, request: reservation.MergeCapacityCommitmentsRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.MergeCapacityCommitmentsRequest, Sequence[Tuple[str, Union[str, bytes]]]]: + """Pre-rpc interceptor for merge_capacity_commitments + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def post_merge_capacity_commitments(self, response: reservation.CapacityCommitment) -> reservation.CapacityCommitment: + """Post-rpc interceptor for merge_capacity_commitments + + DEPRECATED. Please use the `post_merge_capacity_commitments_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ReservationService server but before + it is returned to user code. This `post_merge_capacity_commitments` interceptor runs + before the `post_merge_capacity_commitments_with_metadata` interceptor. + """ + return response + + def post_merge_capacity_commitments_with_metadata(self, response: reservation.CapacityCommitment, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.CapacityCommitment, Sequence[Tuple[str, Union[str, bytes]]]]: + """Post-rpc interceptor for merge_capacity_commitments + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ReservationService server but before it is returned to user code. + + We recommend only using this `post_merge_capacity_commitments_with_metadata` + interceptor in new development instead of the `post_merge_capacity_commitments` interceptor. + When both interceptors are used, this `post_merge_capacity_commitments_with_metadata` interceptor runs after the + `post_merge_capacity_commitments` interceptor. The (possibly modified) response returned by + `post_merge_capacity_commitments` will be passed to + `post_merge_capacity_commitments_with_metadata`. + """ + return response, metadata + + def pre_move_assignment(self, request: reservation.MoveAssignmentRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.MoveAssignmentRequest, Sequence[Tuple[str, Union[str, bytes]]]]: + """Pre-rpc interceptor for move_assignment + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def post_move_assignment(self, response: reservation.Assignment) -> reservation.Assignment: + """Post-rpc interceptor for move_assignment + + DEPRECATED. Please use the `post_move_assignment_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ReservationService server but before + it is returned to user code. This `post_move_assignment` interceptor runs + before the `post_move_assignment_with_metadata` interceptor. + """ + return response + + def post_move_assignment_with_metadata(self, response: reservation.Assignment, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.Assignment, Sequence[Tuple[str, Union[str, bytes]]]]: + """Post-rpc interceptor for move_assignment + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ReservationService server but before it is returned to user code. + + We recommend only using this `post_move_assignment_with_metadata` + interceptor in new development instead of the `post_move_assignment` interceptor. + When both interceptors are used, this `post_move_assignment_with_metadata` interceptor runs after the + `post_move_assignment` interceptor. The (possibly modified) response returned by + `post_move_assignment` will be passed to + `post_move_assignment_with_metadata`. + """ + return response, metadata + + def pre_search_all_assignments(self, request: reservation.SearchAllAssignmentsRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.SearchAllAssignmentsRequest, Sequence[Tuple[str, Union[str, bytes]]]]: + """Pre-rpc interceptor for search_all_assignments + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def post_search_all_assignments(self, response: reservation.SearchAllAssignmentsResponse) -> reservation.SearchAllAssignmentsResponse: + """Post-rpc interceptor for search_all_assignments + + DEPRECATED. Please use the `post_search_all_assignments_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ReservationService server but before + it is returned to user code. This `post_search_all_assignments` interceptor runs + before the `post_search_all_assignments_with_metadata` interceptor. + """ + return response + + def post_search_all_assignments_with_metadata(self, response: reservation.SearchAllAssignmentsResponse, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.SearchAllAssignmentsResponse, Sequence[Tuple[str, Union[str, bytes]]]]: + """Post-rpc interceptor for search_all_assignments + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ReservationService server but before it is returned to user code. + + We recommend only using this `post_search_all_assignments_with_metadata` + interceptor in new development instead of the `post_search_all_assignments` interceptor. + When both interceptors are used, this `post_search_all_assignments_with_metadata` interceptor runs after the + `post_search_all_assignments` interceptor. The (possibly modified) response returned by + `post_search_all_assignments` will be passed to + `post_search_all_assignments_with_metadata`. + """ + return response, metadata + + def pre_search_assignments(self, request: reservation.SearchAssignmentsRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.SearchAssignmentsRequest, Sequence[Tuple[str, Union[str, bytes]]]]: + """Pre-rpc interceptor for search_assignments + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def post_search_assignments(self, response: reservation.SearchAssignmentsResponse) -> reservation.SearchAssignmentsResponse: + """Post-rpc interceptor for search_assignments + + DEPRECATED. Please use the `post_search_assignments_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ReservationService server but before + it is returned to user code. This `post_search_assignments` interceptor runs + before the `post_search_assignments_with_metadata` interceptor. + """ + return response + + def post_search_assignments_with_metadata(self, response: reservation.SearchAssignmentsResponse, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.SearchAssignmentsResponse, Sequence[Tuple[str, Union[str, bytes]]]]: + """Post-rpc interceptor for search_assignments + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ReservationService server but before it is returned to user code. + + We recommend only using this `post_search_assignments_with_metadata` + interceptor in new development instead of the `post_search_assignments` interceptor. + When both interceptors are used, this `post_search_assignments_with_metadata` interceptor runs after the + `post_search_assignments` interceptor. The (possibly modified) response returned by + `post_search_assignments` will be passed to + `post_search_assignments_with_metadata`. + """ + return response, metadata + + def pre_set_iam_policy(self, request: iam_policy_pb2.SetIamPolicyRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[iam_policy_pb2.SetIamPolicyRequest, Sequence[Tuple[str, Union[str, bytes]]]]: + """Pre-rpc interceptor for set_iam_policy + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def post_set_iam_policy(self, response: policy_pb2.Policy) -> policy_pb2.Policy: + """Post-rpc interceptor for set_iam_policy + + DEPRECATED. Please use the `post_set_iam_policy_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ReservationService server but before + it is returned to user code. This `post_set_iam_policy` interceptor runs + before the `post_set_iam_policy_with_metadata` interceptor. + """ + return response + + def post_set_iam_policy_with_metadata(self, response: policy_pb2.Policy, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[policy_pb2.Policy, Sequence[Tuple[str, Union[str, bytes]]]]: + """Post-rpc interceptor for set_iam_policy + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ReservationService server but before it is returned to user code. + + We recommend only using this `post_set_iam_policy_with_metadata` + interceptor in new development instead of the `post_set_iam_policy` interceptor. + When both interceptors are used, this `post_set_iam_policy_with_metadata` interceptor runs after the + `post_set_iam_policy` interceptor. The (possibly modified) response returned by + `post_set_iam_policy` will be passed to + `post_set_iam_policy_with_metadata`. + """ + return response, metadata + + def pre_split_capacity_commitment(self, request: reservation.SplitCapacityCommitmentRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.SplitCapacityCommitmentRequest, Sequence[Tuple[str, Union[str, bytes]]]]: + """Pre-rpc interceptor for split_capacity_commitment + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def post_split_capacity_commitment(self, response: reservation.SplitCapacityCommitmentResponse) -> reservation.SplitCapacityCommitmentResponse: + """Post-rpc interceptor for split_capacity_commitment + + DEPRECATED. Please use the `post_split_capacity_commitment_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ReservationService server but before + it is returned to user code. This `post_split_capacity_commitment` interceptor runs + before the `post_split_capacity_commitment_with_metadata` interceptor. + """ + return response + + def post_split_capacity_commitment_with_metadata(self, response: reservation.SplitCapacityCommitmentResponse, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.SplitCapacityCommitmentResponse, Sequence[Tuple[str, Union[str, bytes]]]]: + """Post-rpc interceptor for split_capacity_commitment + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ReservationService server but before it is returned to user code. + + We recommend only using this `post_split_capacity_commitment_with_metadata` + interceptor in new development instead of the `post_split_capacity_commitment` interceptor. + When both interceptors are used, this `post_split_capacity_commitment_with_metadata` interceptor runs after the + `post_split_capacity_commitment` interceptor. The (possibly modified) response returned by + `post_split_capacity_commitment` will be passed to + `post_split_capacity_commitment_with_metadata`. + """ + return response, metadata + + def pre_test_iam_permissions(self, request: iam_policy_pb2.TestIamPermissionsRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[iam_policy_pb2.TestIamPermissionsRequest, Sequence[Tuple[str, Union[str, bytes]]]]: + """Pre-rpc interceptor for test_iam_permissions + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def post_test_iam_permissions(self, response: iam_policy_pb2.TestIamPermissionsResponse) -> iam_policy_pb2.TestIamPermissionsResponse: + """Post-rpc interceptor for test_iam_permissions + + DEPRECATED. Please use the `post_test_iam_permissions_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ReservationService server but before + it is returned to user code. This `post_test_iam_permissions` interceptor runs + before the `post_test_iam_permissions_with_metadata` interceptor. + """ + return response + + def post_test_iam_permissions_with_metadata(self, response: iam_policy_pb2.TestIamPermissionsResponse, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[iam_policy_pb2.TestIamPermissionsResponse, Sequence[Tuple[str, Union[str, bytes]]]]: + """Post-rpc interceptor for test_iam_permissions + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ReservationService server but before it is returned to user code. + + We recommend only using this `post_test_iam_permissions_with_metadata` + interceptor in new development instead of the `post_test_iam_permissions` interceptor. + When both interceptors are used, this `post_test_iam_permissions_with_metadata` interceptor runs after the + `post_test_iam_permissions` interceptor. The (possibly modified) response returned by + `post_test_iam_permissions` will be passed to + `post_test_iam_permissions_with_metadata`. + """ + return response, metadata + + def pre_update_assignment(self, request: reservation.UpdateAssignmentRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.UpdateAssignmentRequest, Sequence[Tuple[str, Union[str, bytes]]]]: + """Pre-rpc interceptor for update_assignment + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def post_update_assignment(self, response: reservation.Assignment) -> reservation.Assignment: + """Post-rpc interceptor for update_assignment + + DEPRECATED. Please use the `post_update_assignment_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ReservationService server but before + it is returned to user code. This `post_update_assignment` interceptor runs + before the `post_update_assignment_with_metadata` interceptor. + """ + return response + + def post_update_assignment_with_metadata(self, response: reservation.Assignment, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.Assignment, Sequence[Tuple[str, Union[str, bytes]]]]: + """Post-rpc interceptor for update_assignment + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ReservationService server but before it is returned to user code. + + We recommend only using this `post_update_assignment_with_metadata` + interceptor in new development instead of the `post_update_assignment` interceptor. + When both interceptors are used, this `post_update_assignment_with_metadata` interceptor runs after the + `post_update_assignment` interceptor. The (possibly modified) response returned by + `post_update_assignment` will be passed to + `post_update_assignment_with_metadata`. + """ + return response, metadata + + def pre_update_bi_reservation(self, request: reservation.UpdateBiReservationRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.UpdateBiReservationRequest, Sequence[Tuple[str, Union[str, bytes]]]]: + """Pre-rpc interceptor for update_bi_reservation + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def post_update_bi_reservation(self, response: reservation.BiReservation) -> reservation.BiReservation: + """Post-rpc interceptor for update_bi_reservation + + DEPRECATED. Please use the `post_update_bi_reservation_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ReservationService server but before + it is returned to user code. This `post_update_bi_reservation` interceptor runs + before the `post_update_bi_reservation_with_metadata` interceptor. + """ + return response + + def post_update_bi_reservation_with_metadata(self, response: reservation.BiReservation, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.BiReservation, Sequence[Tuple[str, Union[str, bytes]]]]: + """Post-rpc interceptor for update_bi_reservation + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ReservationService server but before it is returned to user code. + + We recommend only using this `post_update_bi_reservation_with_metadata` + interceptor in new development instead of the `post_update_bi_reservation` interceptor. + When both interceptors are used, this `post_update_bi_reservation_with_metadata` interceptor runs after the + `post_update_bi_reservation` interceptor. The (possibly modified) response returned by + `post_update_bi_reservation` will be passed to + `post_update_bi_reservation_with_metadata`. + """ + return response, metadata + + def pre_update_capacity_commitment(self, request: reservation.UpdateCapacityCommitmentRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.UpdateCapacityCommitmentRequest, Sequence[Tuple[str, Union[str, bytes]]]]: + """Pre-rpc interceptor for update_capacity_commitment + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def post_update_capacity_commitment(self, response: reservation.CapacityCommitment) -> reservation.CapacityCommitment: + """Post-rpc interceptor for update_capacity_commitment + + DEPRECATED. Please use the `post_update_capacity_commitment_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ReservationService server but before + it is returned to user code. This `post_update_capacity_commitment` interceptor runs + before the `post_update_capacity_commitment_with_metadata` interceptor. + """ + return response + + def post_update_capacity_commitment_with_metadata(self, response: reservation.CapacityCommitment, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.CapacityCommitment, Sequence[Tuple[str, Union[str, bytes]]]]: + """Post-rpc interceptor for update_capacity_commitment + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ReservationService server but before it is returned to user code. + + We recommend only using this `post_update_capacity_commitment_with_metadata` + interceptor in new development instead of the `post_update_capacity_commitment` interceptor. + When both interceptors are used, this `post_update_capacity_commitment_with_metadata` interceptor runs after the + `post_update_capacity_commitment` interceptor. The (possibly modified) response returned by + `post_update_capacity_commitment` will be passed to + `post_update_capacity_commitment_with_metadata`. + """ + return response, metadata + + def pre_update_reservation(self, request: gcbr_reservation.UpdateReservationRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[gcbr_reservation.UpdateReservationRequest, Sequence[Tuple[str, Union[str, bytes]]]]: + """Pre-rpc interceptor for update_reservation + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def post_update_reservation(self, response: gcbr_reservation.Reservation) -> gcbr_reservation.Reservation: + """Post-rpc interceptor for update_reservation + + DEPRECATED. Please use the `post_update_reservation_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ReservationService server but before + it is returned to user code. This `post_update_reservation` interceptor runs + before the `post_update_reservation_with_metadata` interceptor. + """ + return response + + def post_update_reservation_with_metadata(self, response: gcbr_reservation.Reservation, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[gcbr_reservation.Reservation, Sequence[Tuple[str, Union[str, bytes]]]]: + """Post-rpc interceptor for update_reservation + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ReservationService server but before it is returned to user code. + + We recommend only using this `post_update_reservation_with_metadata` + interceptor in new development instead of the `post_update_reservation` interceptor. + When both interceptors are used, this `post_update_reservation_with_metadata` interceptor runs after the + `post_update_reservation` interceptor. The (possibly modified) response returned by + `post_update_reservation` will be passed to + `post_update_reservation_with_metadata`. + """ + return response, metadata + + +@dataclasses.dataclass +class ReservationServiceRestStub: + _session: AuthorizedSession + _host: str + _interceptor: ReservationServiceRestInterceptor + + +class ReservationServiceRestTransport(_BaseReservationServiceRestTransport): + """REST backend synchronous transport for ReservationService. + + This API allows users to manage their BigQuery reservations. + + A reservation provides computational resource guarantees, in the + form of `slots `__, to + users. A slot is a unit of computational power in BigQuery, and + serves as the basic unit of parallelism. In a scan of a + multi-partitioned table, a single slot operates on a single + partition of the table. A reservation resource exists as a child + resource of the admin project and location, e.g.: + ``projects/myproject/locations/US/reservations/reservationName``. + + A capacity commitment is a way to purchase compute capacity for + BigQuery jobs (in the form of slots) with some committed period of + usage. A capacity commitment resource exists as a child resource of + the admin project and location, e.g.: + ``projects/myproject/locations/US/capacityCommitments/id``. + + 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 = 'bigqueryreservation.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[ReservationServiceRestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'bigqueryreservation.googleapis.com'). + 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 + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + url_scheme=url_scheme, + api_audience=api_audience + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST) + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or ReservationServiceRestInterceptor() + self._prep_wrapped_messages(client_info) + + class _CreateAssignment(_BaseReservationServiceRestTransport._BaseCreateAssignment, ReservationServiceRestStub): + def __hash__(self): + return hash("ReservationServiceRestTransport.CreateAssignment") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None): + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + return response + + def __call__(self, + request: reservation.CreateAssignmentRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), + ) -> reservation.Assignment: + r"""Call the create assignment method over HTTP. + + Args: + request (~.reservation.CreateAssignmentRequest): + The request object. The request for + [ReservationService.CreateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.CreateAssignment]. + Note: "bigquery.reservationAssignments.create" + permission is required on the related assignee. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.reservation.Assignment: + An assignment allows a project to + submit jobs of a certain type using + slots from the specified reservation. + + """ + + http_options = _BaseReservationServiceRestTransport._BaseCreateAssignment._get_http_options() + + request, metadata = self._interceptor.pre_create_assignment(request, metadata) + transcoded_request = _BaseReservationServiceRestTransport._BaseCreateAssignment._get_transcoded_request(http_options, request) + + body = _BaseReservationServiceRestTransport._BaseCreateAssignment._get_request_body_json(transcoded_request) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseCreateAssignment._get_query_params_json(transcoded_request) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) + method = transcoded_request['method'] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.CreateAssignment", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "CreateAssignment", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ReservationServiceRestTransport._CreateAssignment._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request, 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 = reservation.Assignment() + pb_resp = reservation.Assignment.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_create_assignment(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_create_assignment_with_metadata(resp, response_metadata) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + try: + response_payload = reservation.Assignment.to_json(response) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.create_assignment", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "CreateAssignment", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _CreateCapacityCommitment(_BaseReservationServiceRestTransport._BaseCreateCapacityCommitment, ReservationServiceRestStub): + def __hash__(self): + return hash("ReservationServiceRestTransport.CreateCapacityCommitment") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None): + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + return response + + def __call__(self, + request: reservation.CreateCapacityCommitmentRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), + ) -> reservation.CapacityCommitment: + r"""Call the create capacity + commitment method over HTTP. + + Args: + request (~.reservation.CreateCapacityCommitmentRequest): + The request object. The request for + [ReservationService.CreateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.CreateCapacityCommitment]. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.reservation.CapacityCommitment: + Capacity commitment is a way to + purchase compute capacity for BigQuery + jobs (in the form of slots) with some + committed period of usage. Annual + commitments renew by default. + Commitments can be removed after their + commitment end time passes. + + In order to remove annual commitment, + its plan needs to be changed to monthly + or flex first. + + A capacity commitment resource exists as + a child resource of the admin project. + + """ + + http_options = _BaseReservationServiceRestTransport._BaseCreateCapacityCommitment._get_http_options() + + request, metadata = self._interceptor.pre_create_capacity_commitment(request, metadata) + transcoded_request = _BaseReservationServiceRestTransport._BaseCreateCapacityCommitment._get_transcoded_request(http_options, request) + + body = _BaseReservationServiceRestTransport._BaseCreateCapacityCommitment._get_request_body_json(transcoded_request) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseCreateCapacityCommitment._get_query_params_json(transcoded_request) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) + method = transcoded_request['method'] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.CreateCapacityCommitment", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "CreateCapacityCommitment", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ReservationServiceRestTransport._CreateCapacityCommitment._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request, 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 = reservation.CapacityCommitment() + pb_resp = reservation.CapacityCommitment.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_create_capacity_commitment(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_create_capacity_commitment_with_metadata(resp, response_metadata) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + try: + response_payload = reservation.CapacityCommitment.to_json(response) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.create_capacity_commitment", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "CreateCapacityCommitment", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _CreateReservation(_BaseReservationServiceRestTransport._BaseCreateReservation, ReservationServiceRestStub): + def __hash__(self): + return hash("ReservationServiceRestTransport.CreateReservation") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None): + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + return response + + def __call__(self, + request: gcbr_reservation.CreateReservationRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), + ) -> gcbr_reservation.Reservation: + r"""Call the create reservation method over HTTP. + + Args: + request (~.gcbr_reservation.CreateReservationRequest): + The request object. The request for + [ReservationService.CreateReservation][google.cloud.bigquery.reservation.v1.ReservationService.CreateReservation]. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.gcbr_reservation.Reservation: + A reservation is a mechanism used to + guarantee slots to users. + + """ + + http_options = _BaseReservationServiceRestTransport._BaseCreateReservation._get_http_options() + + request, metadata = self._interceptor.pre_create_reservation(request, metadata) + transcoded_request = _BaseReservationServiceRestTransport._BaseCreateReservation._get_transcoded_request(http_options, request) + + body = _BaseReservationServiceRestTransport._BaseCreateReservation._get_request_body_json(transcoded_request) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseCreateReservation._get_query_params_json(transcoded_request) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) + method = transcoded_request['method'] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.CreateReservation", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "CreateReservation", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ReservationServiceRestTransport._CreateReservation._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request, 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 = gcbr_reservation.Reservation() + pb_resp = gcbr_reservation.Reservation.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_create_reservation(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_create_reservation_with_metadata(resp, response_metadata) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + try: + response_payload = gcbr_reservation.Reservation.to_json(response) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.create_reservation", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "CreateReservation", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _CreateReservationGroup(_BaseReservationServiceRestTransport._BaseCreateReservationGroup, ReservationServiceRestStub): + def __hash__(self): + return hash("ReservationServiceRestTransport.CreateReservationGroup") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None): + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + return response + + def __call__(self, + request: reservation.CreateReservationGroupRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), + ) -> reservation.ReservationGroup: + r"""Call the create reservation group method over HTTP. + + Args: + request (~.reservation.CreateReservationGroupRequest): + The request object. The request for + [ReservationService.CreateReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.CreateReservationGroup]. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.reservation.ReservationGroup: + A reservation group is a container + for reservations. + + """ + + http_options = _BaseReservationServiceRestTransport._BaseCreateReservationGroup._get_http_options() + + request, metadata = self._interceptor.pre_create_reservation_group(request, metadata) + transcoded_request = _BaseReservationServiceRestTransport._BaseCreateReservationGroup._get_transcoded_request(http_options, request) + + body = _BaseReservationServiceRestTransport._BaseCreateReservationGroup._get_request_body_json(transcoded_request) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseCreateReservationGroup._get_query_params_json(transcoded_request) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) + method = transcoded_request['method'] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.CreateReservationGroup", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "CreateReservationGroup", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ReservationServiceRestTransport._CreateReservationGroup._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request, 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 = reservation.ReservationGroup() + pb_resp = reservation.ReservationGroup.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_create_reservation_group(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_create_reservation_group_with_metadata(resp, response_metadata) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + try: + response_payload = reservation.ReservationGroup.to_json(response) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.create_reservation_group", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "CreateReservationGroup", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _DeleteAssignment(_BaseReservationServiceRestTransport._BaseDeleteAssignment, ReservationServiceRestStub): + def __hash__(self): + return hash("ReservationServiceRestTransport.DeleteAssignment") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None): + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + return response + + def __call__(self, + request: reservation.DeleteAssignmentRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), + ): + r"""Call the delete assignment method over HTTP. + + Args: + request (~.reservation.DeleteAssignmentRequest): + The request object. The request for + [ReservationService.DeleteAssignment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteAssignment]. + Note: "bigquery.reservationAssignments.delete" + permission is required on the related assignee. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + """ + + http_options = _BaseReservationServiceRestTransport._BaseDeleteAssignment._get_http_options() + + request, metadata = self._interceptor.pre_delete_assignment(request, metadata) + transcoded_request = _BaseReservationServiceRestTransport._BaseDeleteAssignment._get_transcoded_request(http_options, request) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseDeleteAssignment._get_query_params_json(transcoded_request) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) + method = transcoded_request['method'] + try: + request_payload = json_format.MessageToJson(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.DeleteAssignment", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "DeleteAssignment", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ReservationServiceRestTransport._DeleteAssignment._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _DeleteCapacityCommitment(_BaseReservationServiceRestTransport._BaseDeleteCapacityCommitment, ReservationServiceRestStub): + def __hash__(self): + return hash("ReservationServiceRestTransport.DeleteCapacityCommitment") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None): + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + return response + + def __call__(self, + request: reservation.DeleteCapacityCommitmentRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), + ): + r"""Call the delete capacity + commitment method over HTTP. + + Args: + request (~.reservation.DeleteCapacityCommitmentRequest): + The request object. The request for + [ReservationService.DeleteCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteCapacityCommitment]. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + """ + + http_options = _BaseReservationServiceRestTransport._BaseDeleteCapacityCommitment._get_http_options() + + request, metadata = self._interceptor.pre_delete_capacity_commitment(request, metadata) + transcoded_request = _BaseReservationServiceRestTransport._BaseDeleteCapacityCommitment._get_transcoded_request(http_options, request) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseDeleteCapacityCommitment._get_query_params_json(transcoded_request) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) + method = transcoded_request['method'] + try: + request_payload = json_format.MessageToJson(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.DeleteCapacityCommitment", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "DeleteCapacityCommitment", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ReservationServiceRestTransport._DeleteCapacityCommitment._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _DeleteReservation(_BaseReservationServiceRestTransport._BaseDeleteReservation, ReservationServiceRestStub): + def __hash__(self): + return hash("ReservationServiceRestTransport.DeleteReservation") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None): + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + return response + + def __call__(self, + request: reservation.DeleteReservationRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), + ): + r"""Call the delete reservation method over HTTP. + + Args: + request (~.reservation.DeleteReservationRequest): + The request object. The request for + [ReservationService.DeleteReservation][google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservation]. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + """ + + http_options = _BaseReservationServiceRestTransport._BaseDeleteReservation._get_http_options() + + request, metadata = self._interceptor.pre_delete_reservation(request, metadata) + transcoded_request = _BaseReservationServiceRestTransport._BaseDeleteReservation._get_transcoded_request(http_options, request) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseDeleteReservation._get_query_params_json(transcoded_request) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) + method = transcoded_request['method'] + try: + request_payload = json_format.MessageToJson(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.DeleteReservation", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "DeleteReservation", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ReservationServiceRestTransport._DeleteReservation._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _DeleteReservationGroup(_BaseReservationServiceRestTransport._BaseDeleteReservationGroup, ReservationServiceRestStub): + def __hash__(self): + return hash("ReservationServiceRestTransport.DeleteReservationGroup") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None): + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + return response + + def __call__(self, + request: reservation.DeleteReservationGroupRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), + ): + r"""Call the delete reservation group method over HTTP. + + Args: + request (~.reservation.DeleteReservationGroupRequest): + The request object. The request for + [ReservationService.DeleteReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservationGroup]. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + """ + + http_options = _BaseReservationServiceRestTransport._BaseDeleteReservationGroup._get_http_options() + + request, metadata = self._interceptor.pre_delete_reservation_group(request, metadata) + transcoded_request = _BaseReservationServiceRestTransport._BaseDeleteReservationGroup._get_transcoded_request(http_options, request) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseDeleteReservationGroup._get_query_params_json(transcoded_request) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) + method = transcoded_request['method'] + try: + request_payload = json_format.MessageToJson(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.DeleteReservationGroup", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "DeleteReservationGroup", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ReservationServiceRestTransport._DeleteReservationGroup._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _FailoverReservation(_BaseReservationServiceRestTransport._BaseFailoverReservation, ReservationServiceRestStub): + def __hash__(self): + return hash("ReservationServiceRestTransport.FailoverReservation") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None): + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + return response + + def __call__(self, + request: reservation.FailoverReservationRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), + ) -> reservation.Reservation: + r"""Call the failover reservation method over HTTP. + + Args: + request (~.reservation.FailoverReservationRequest): + The request object. The request for + ReservationService.FailoverReservation. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.reservation.Reservation: + A reservation is a mechanism used to + guarantee slots to users. + + """ + + http_options = _BaseReservationServiceRestTransport._BaseFailoverReservation._get_http_options() + + request, metadata = self._interceptor.pre_failover_reservation(request, metadata) + transcoded_request = _BaseReservationServiceRestTransport._BaseFailoverReservation._get_transcoded_request(http_options, request) + + body = _BaseReservationServiceRestTransport._BaseFailoverReservation._get_request_body_json(transcoded_request) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseFailoverReservation._get_query_params_json(transcoded_request) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) + method = transcoded_request['method'] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.FailoverReservation", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "FailoverReservation", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ReservationServiceRestTransport._FailoverReservation._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request, 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 = reservation.Reservation() + pb_resp = reservation.Reservation.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_failover_reservation(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_failover_reservation_with_metadata(resp, response_metadata) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + try: + response_payload = reservation.Reservation.to_json(response) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.failover_reservation", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "FailoverReservation", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _GetBiReservation(_BaseReservationServiceRestTransport._BaseGetBiReservation, ReservationServiceRestStub): + def __hash__(self): + return hash("ReservationServiceRestTransport.GetBiReservation") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None): + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + return response + + def __call__(self, + request: reservation.GetBiReservationRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), + ) -> reservation.BiReservation: + r"""Call the get bi reservation method over HTTP. + + Args: + request (~.reservation.GetBiReservationRequest): + The request object. A request to get a singleton BI + reservation. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.reservation.BiReservation: + Represents a BI Reservation. + """ + + http_options = _BaseReservationServiceRestTransport._BaseGetBiReservation._get_http_options() + + request, metadata = self._interceptor.pre_get_bi_reservation(request, metadata) + transcoded_request = _BaseReservationServiceRestTransport._BaseGetBiReservation._get_transcoded_request(http_options, request) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseGetBiReservation._get_query_params_json(transcoded_request) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) + method = transcoded_request['method'] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.GetBiReservation", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "GetBiReservation", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ReservationServiceRestTransport._GetBiReservation._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request) + + # 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 = reservation.BiReservation() + pb_resp = reservation.BiReservation.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_get_bi_reservation(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_get_bi_reservation_with_metadata(resp, response_metadata) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + try: + response_payload = reservation.BiReservation.to_json(response) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.get_bi_reservation", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "GetBiReservation", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _GetCapacityCommitment(_BaseReservationServiceRestTransport._BaseGetCapacityCommitment, ReservationServiceRestStub): + def __hash__(self): + return hash("ReservationServiceRestTransport.GetCapacityCommitment") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None): + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + return response + + def __call__(self, + request: reservation.GetCapacityCommitmentRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), + ) -> reservation.CapacityCommitment: + r"""Call the get capacity commitment method over HTTP. + + Args: + request (~.reservation.GetCapacityCommitmentRequest): + The request object. The request for + [ReservationService.GetCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitment]. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.reservation.CapacityCommitment: + Capacity commitment is a way to + purchase compute capacity for BigQuery + jobs (in the form of slots) with some + committed period of usage. Annual + commitments renew by default. + Commitments can be removed after their + commitment end time passes. + + In order to remove annual commitment, + its plan needs to be changed to monthly + or flex first. + + A capacity commitment resource exists as + a child resource of the admin project. + + """ + + http_options = _BaseReservationServiceRestTransport._BaseGetCapacityCommitment._get_http_options() + + request, metadata = self._interceptor.pre_get_capacity_commitment(request, metadata) + transcoded_request = _BaseReservationServiceRestTransport._BaseGetCapacityCommitment._get_transcoded_request(http_options, request) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseGetCapacityCommitment._get_query_params_json(transcoded_request) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) + method = transcoded_request['method'] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.GetCapacityCommitment", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "GetCapacityCommitment", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ReservationServiceRestTransport._GetCapacityCommitment._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request) + + # 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 = reservation.CapacityCommitment() + pb_resp = reservation.CapacityCommitment.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_get_capacity_commitment(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_get_capacity_commitment_with_metadata(resp, response_metadata) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + try: + response_payload = reservation.CapacityCommitment.to_json(response) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.get_capacity_commitment", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "GetCapacityCommitment", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _GetIamPolicy(_BaseReservationServiceRestTransport._BaseGetIamPolicy, ReservationServiceRestStub): + def __hash__(self): + return hash("ReservationServiceRestTransport.GetIamPolicy") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None): + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + return response + + def __call__(self, + request: iam_policy_pb2.GetIamPolicyRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), + ) -> policy_pb2.Policy: + r"""Call the get iam policy method over HTTP. + + Args: + request (~.iam_policy_pb2.GetIamPolicyRequest): + The request object. Request message for ``GetIamPolicy`` 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.policy_pb2.Policy: + An Identity and Access Management (IAM) policy, which + specifies access controls for Google Cloud resources. + + A ``Policy`` is a collection of ``bindings``. A + ``binding`` binds one or more ``members``, or + principals, to a single ``role``. Principals can be user + accounts, service accounts, Google groups, and domains + (such as G Suite). A ``role`` is a named list of + permissions; each ``role`` can be an IAM predefined role + or a user-created custom role. + + For some types of Google Cloud resources, a ``binding`` + can also specify a ``condition``, which is a logical + expression that allows access to a resource only if the + expression evaluates to ``true``. A condition can add + constraints based on attributes of the request, the + resource, or both. To learn which resources support + conditions in their IAM policies, see the `IAM + documentation `__. + + **JSON example:** + + :: + + { + "bindings": [ + { + "role": "roles/resourcemanager.organizationAdmin", + "members": [ + "user:mike@example.com", + "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" + ] + }, + { + "role": "roles/resourcemanager.organizationViewer", + "members": [ + "user:eve@example.com" + ], + "condition": { + "title": "expirable access", + "description": "Does not grant access after Sep 2020", + "expression": "request.time < + timestamp('2020-10-01T00:00:00.000Z')", + } + } + ], + "etag": "BwWWja0YfJA=", + "version": 3 + } + + **YAML example:** + + :: + + bindings: + - members: + - user:mike@example.com + - group:admins@example.com + - domain:google.com + - serviceAccount:my-project-id@appspot.gserviceaccount.com + role: roles/resourcemanager.organizationAdmin + - members: + - user:eve@example.com + role: roles/resourcemanager.organizationViewer + condition: + title: expirable access + description: Does not grant access after Sep 2020 + expression: request.time < timestamp('2020-10-01T00:00:00.000Z') + etag: BwWWja0YfJA= + version: 3 + + For a description of IAM and its features, see the `IAM + documentation `__. + + """ + + http_options = _BaseReservationServiceRestTransport._BaseGetIamPolicy._get_http_options() + + request, metadata = self._interceptor.pre_get_iam_policy(request, metadata) + transcoded_request = _BaseReservationServiceRestTransport._BaseGetIamPolicy._get_transcoded_request(http_options, request) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseGetIamPolicy._get_query_params_json(transcoded_request) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) + method = transcoded_request['method'] + try: + request_payload = json_format.MessageToJson(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.GetIamPolicy", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "GetIamPolicy", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ReservationServiceRestTransport._GetIamPolicy._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request) + + # 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 = policy_pb2.Policy() + pb_resp = resp + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_get_iam_policy(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_get_iam_policy_with_metadata(resp, response_metadata) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + try: + response_payload = json_format.MessageToJson(resp) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.get_iam_policy", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "GetIamPolicy", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _GetReservation(_BaseReservationServiceRestTransport._BaseGetReservation, ReservationServiceRestStub): + def __hash__(self): + return hash("ReservationServiceRestTransport.GetReservation") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None): + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + return response + + def __call__(self, + request: reservation.GetReservationRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), + ) -> reservation.Reservation: + r"""Call the get reservation method over HTTP. + + Args: + request (~.reservation.GetReservationRequest): + The request object. The request for + [ReservationService.GetReservation][google.cloud.bigquery.reservation.v1.ReservationService.GetReservation]. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.reservation.Reservation: + A reservation is a mechanism used to + guarantee slots to users. + + """ + + http_options = _BaseReservationServiceRestTransport._BaseGetReservation._get_http_options() + + request, metadata = self._interceptor.pre_get_reservation(request, metadata) + transcoded_request = _BaseReservationServiceRestTransport._BaseGetReservation._get_transcoded_request(http_options, request) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseGetReservation._get_query_params_json(transcoded_request) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) + method = transcoded_request['method'] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.GetReservation", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "GetReservation", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ReservationServiceRestTransport._GetReservation._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request) + + # 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 = reservation.Reservation() + pb_resp = reservation.Reservation.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_get_reservation(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_get_reservation_with_metadata(resp, response_metadata) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + try: + response_payload = reservation.Reservation.to_json(response) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.get_reservation", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "GetReservation", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _GetReservationGroup(_BaseReservationServiceRestTransport._BaseGetReservationGroup, ReservationServiceRestStub): + def __hash__(self): + return hash("ReservationServiceRestTransport.GetReservationGroup") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None): + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + return response + + def __call__(self, + request: reservation.GetReservationGroupRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), + ) -> reservation.ReservationGroup: + r"""Call the get reservation group method over HTTP. + + Args: + request (~.reservation.GetReservationGroupRequest): + The request object. The request for + [ReservationService.GetReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.GetReservationGroup]. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.reservation.ReservationGroup: + A reservation group is a container + for reservations. + + """ + + http_options = _BaseReservationServiceRestTransport._BaseGetReservationGroup._get_http_options() + + request, metadata = self._interceptor.pre_get_reservation_group(request, metadata) + transcoded_request = _BaseReservationServiceRestTransport._BaseGetReservationGroup._get_transcoded_request(http_options, request) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseGetReservationGroup._get_query_params_json(transcoded_request) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) + method = transcoded_request['method'] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.GetReservationGroup", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "GetReservationGroup", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ReservationServiceRestTransport._GetReservationGroup._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request) + + # 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 = reservation.ReservationGroup() + pb_resp = reservation.ReservationGroup.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_get_reservation_group(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_get_reservation_group_with_metadata(resp, response_metadata) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + try: + response_payload = reservation.ReservationGroup.to_json(response) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.get_reservation_group", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "GetReservationGroup", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _ListAssignments(_BaseReservationServiceRestTransport._BaseListAssignments, ReservationServiceRestStub): + def __hash__(self): + return hash("ReservationServiceRestTransport.ListAssignments") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None): + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + return response + + def __call__(self, + request: reservation.ListAssignmentsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), + ) -> reservation.ListAssignmentsResponse: + r"""Call the list assignments method over HTTP. + + Args: + request (~.reservation.ListAssignmentsRequest): + The request object. The request for + [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments]. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.reservation.ListAssignmentsResponse: + The response for + [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments]. + + """ + + http_options = _BaseReservationServiceRestTransport._BaseListAssignments._get_http_options() + + request, metadata = self._interceptor.pre_list_assignments(request, metadata) + transcoded_request = _BaseReservationServiceRestTransport._BaseListAssignments._get_transcoded_request(http_options, request) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseListAssignments._get_query_params_json(transcoded_request) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) + method = transcoded_request['method'] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.ListAssignments", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "ListAssignments", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ReservationServiceRestTransport._ListAssignments._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request) + + # 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 = reservation.ListAssignmentsResponse() + pb_resp = reservation.ListAssignmentsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_list_assignments(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_list_assignments_with_metadata(resp, response_metadata) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + try: + response_payload = reservation.ListAssignmentsResponse.to_json(response) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.list_assignments", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "ListAssignments", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _ListCapacityCommitments(_BaseReservationServiceRestTransport._BaseListCapacityCommitments, ReservationServiceRestStub): + def __hash__(self): + return hash("ReservationServiceRestTransport.ListCapacityCommitments") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None): + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + return response + + def __call__(self, + request: reservation.ListCapacityCommitmentsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), + ) -> reservation.ListCapacityCommitmentsResponse: + r"""Call the list capacity commitments method over HTTP. + + Args: + request (~.reservation.ListCapacityCommitmentsRequest): + The request object. The request for + [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments]. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.reservation.ListCapacityCommitmentsResponse: + The response for + [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments]. + + """ + + http_options = _BaseReservationServiceRestTransport._BaseListCapacityCommitments._get_http_options() + + request, metadata = self._interceptor.pre_list_capacity_commitments(request, metadata) + transcoded_request = _BaseReservationServiceRestTransport._BaseListCapacityCommitments._get_transcoded_request(http_options, request) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseListCapacityCommitments._get_query_params_json(transcoded_request) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) + method = transcoded_request['method'] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.ListCapacityCommitments", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "ListCapacityCommitments", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ReservationServiceRestTransport._ListCapacityCommitments._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request) + + # 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 = reservation.ListCapacityCommitmentsResponse() + pb_resp = reservation.ListCapacityCommitmentsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_list_capacity_commitments(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_list_capacity_commitments_with_metadata(resp, response_metadata) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + try: + response_payload = reservation.ListCapacityCommitmentsResponse.to_json(response) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.list_capacity_commitments", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "ListCapacityCommitments", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _ListReservationGroups(_BaseReservationServiceRestTransport._BaseListReservationGroups, ReservationServiceRestStub): + def __hash__(self): + return hash("ReservationServiceRestTransport.ListReservationGroups") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None): + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + return response + + def __call__(self, + request: reservation.ListReservationGroupsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), + ) -> reservation.ListReservationGroupsResponse: + r"""Call the list reservation groups method over HTTP. + + Args: + request (~.reservation.ListReservationGroupsRequest): + The request object. The request for + [ReservationService.ListReservationGroups][google.cloud.bigquery.reservation.v1.ReservationService.ListReservationGroups]. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.reservation.ListReservationGroupsResponse: + The response for + [ReservationService.ListReservationGroups][google.cloud.bigquery.reservation.v1.ReservationService.ListReservationGroups]. + + """ + + http_options = _BaseReservationServiceRestTransport._BaseListReservationGroups._get_http_options() + + request, metadata = self._interceptor.pre_list_reservation_groups(request, metadata) + transcoded_request = _BaseReservationServiceRestTransport._BaseListReservationGroups._get_transcoded_request(http_options, request) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseListReservationGroups._get_query_params_json(transcoded_request) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) + method = transcoded_request['method'] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.ListReservationGroups", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "ListReservationGroups", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ReservationServiceRestTransport._ListReservationGroups._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request) + + # 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 = reservation.ListReservationGroupsResponse() + pb_resp = reservation.ListReservationGroupsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_list_reservation_groups(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_list_reservation_groups_with_metadata(resp, response_metadata) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + try: + response_payload = reservation.ListReservationGroupsResponse.to_json(response) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.list_reservation_groups", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "ListReservationGroups", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _ListReservations(_BaseReservationServiceRestTransport._BaseListReservations, ReservationServiceRestStub): + def __hash__(self): + return hash("ReservationServiceRestTransport.ListReservations") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None): + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + return response + + def __call__(self, + request: reservation.ListReservationsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), + ) -> reservation.ListReservationsResponse: + r"""Call the list reservations method over HTTP. + + Args: + request (~.reservation.ListReservationsRequest): + The request object. The request for + [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations]. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.reservation.ListReservationsResponse: + The response for + [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations]. + + """ + + http_options = _BaseReservationServiceRestTransport._BaseListReservations._get_http_options() + + request, metadata = self._interceptor.pre_list_reservations(request, metadata) + transcoded_request = _BaseReservationServiceRestTransport._BaseListReservations._get_transcoded_request(http_options, request) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseListReservations._get_query_params_json(transcoded_request) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) + method = transcoded_request['method'] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.ListReservations", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "ListReservations", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ReservationServiceRestTransport._ListReservations._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request) + + # 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 = reservation.ListReservationsResponse() + pb_resp = reservation.ListReservationsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_list_reservations(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_list_reservations_with_metadata(resp, response_metadata) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + try: + response_payload = reservation.ListReservationsResponse.to_json(response) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.list_reservations", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "ListReservations", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _MergeCapacityCommitments(_BaseReservationServiceRestTransport._BaseMergeCapacityCommitments, ReservationServiceRestStub): + def __hash__(self): + return hash("ReservationServiceRestTransport.MergeCapacityCommitments") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None): + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + return response + + def __call__(self, + request: reservation.MergeCapacityCommitmentsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), + ) -> reservation.CapacityCommitment: + r"""Call the merge capacity + commitments method over HTTP. + + Args: + request (~.reservation.MergeCapacityCommitmentsRequest): + The request object. The request for + [ReservationService.MergeCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.MergeCapacityCommitments]. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.reservation.CapacityCommitment: + Capacity commitment is a way to + purchase compute capacity for BigQuery + jobs (in the form of slots) with some + committed period of usage. Annual + commitments renew by default. + Commitments can be removed after their + commitment end time passes. + + In order to remove annual commitment, + its plan needs to be changed to monthly + or flex first. + + A capacity commitment resource exists as + a child resource of the admin project. + + """ + + http_options = _BaseReservationServiceRestTransport._BaseMergeCapacityCommitments._get_http_options() + + request, metadata = self._interceptor.pre_merge_capacity_commitments(request, metadata) + transcoded_request = _BaseReservationServiceRestTransport._BaseMergeCapacityCommitments._get_transcoded_request(http_options, request) + + body = _BaseReservationServiceRestTransport._BaseMergeCapacityCommitments._get_request_body_json(transcoded_request) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseMergeCapacityCommitments._get_query_params_json(transcoded_request) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) + method = transcoded_request['method'] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.MergeCapacityCommitments", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "MergeCapacityCommitments", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ReservationServiceRestTransport._MergeCapacityCommitments._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request, 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 = reservation.CapacityCommitment() + pb_resp = reservation.CapacityCommitment.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_merge_capacity_commitments(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_merge_capacity_commitments_with_metadata(resp, response_metadata) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + try: + response_payload = reservation.CapacityCommitment.to_json(response) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.merge_capacity_commitments", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "MergeCapacityCommitments", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _MoveAssignment(_BaseReservationServiceRestTransport._BaseMoveAssignment, ReservationServiceRestStub): + def __hash__(self): + return hash("ReservationServiceRestTransport.MoveAssignment") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None): + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + return response + + def __call__(self, + request: reservation.MoveAssignmentRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), + ) -> reservation.Assignment: + r"""Call the move assignment method over HTTP. + + Args: + request (~.reservation.MoveAssignmentRequest): + The request object. The request for + [ReservationService.MoveAssignment][google.cloud.bigquery.reservation.v1.ReservationService.MoveAssignment]. + + **Note**: "bigquery.reservationAssignments.create" + permission is required on the destination_id. + + **Note**: "bigquery.reservationAssignments.create" and + "bigquery.reservationAssignments.delete" permission are + required on the related assignee. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.reservation.Assignment: + An assignment allows a project to + submit jobs of a certain type using + slots from the specified reservation. + + """ + + http_options = _BaseReservationServiceRestTransport._BaseMoveAssignment._get_http_options() + + request, metadata = self._interceptor.pre_move_assignment(request, metadata) + transcoded_request = _BaseReservationServiceRestTransport._BaseMoveAssignment._get_transcoded_request(http_options, request) + + body = _BaseReservationServiceRestTransport._BaseMoveAssignment._get_request_body_json(transcoded_request) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseMoveAssignment._get_query_params_json(transcoded_request) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) + method = transcoded_request['method'] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.MoveAssignment", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "MoveAssignment", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ReservationServiceRestTransport._MoveAssignment._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request, 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 = reservation.Assignment() + pb_resp = reservation.Assignment.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_move_assignment(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_move_assignment_with_metadata(resp, response_metadata) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + try: + response_payload = reservation.Assignment.to_json(response) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.move_assignment", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "MoveAssignment", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _SearchAllAssignments(_BaseReservationServiceRestTransport._BaseSearchAllAssignments, ReservationServiceRestStub): + def __hash__(self): + return hash("ReservationServiceRestTransport.SearchAllAssignments") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None): + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + return response + + def __call__(self, + request: reservation.SearchAllAssignmentsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), + ) -> reservation.SearchAllAssignmentsResponse: + r"""Call the search all assignments method over HTTP. + + Args: + request (~.reservation.SearchAllAssignmentsRequest): + The request object. The request for + [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. + Note: "bigquery.reservationAssignments.search" + permission is required on the related assignee. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.reservation.SearchAllAssignmentsResponse: + The response for + [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. + + """ + + http_options = _BaseReservationServiceRestTransport._BaseSearchAllAssignments._get_http_options() + + request, metadata = self._interceptor.pre_search_all_assignments(request, metadata) + transcoded_request = _BaseReservationServiceRestTransport._BaseSearchAllAssignments._get_transcoded_request(http_options, request) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseSearchAllAssignments._get_query_params_json(transcoded_request) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) + method = transcoded_request['method'] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.SearchAllAssignments", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "SearchAllAssignments", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ReservationServiceRestTransport._SearchAllAssignments._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request) + + # 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 = reservation.SearchAllAssignmentsResponse() + pb_resp = reservation.SearchAllAssignmentsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_search_all_assignments(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_search_all_assignments_with_metadata(resp, response_metadata) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + try: + response_payload = reservation.SearchAllAssignmentsResponse.to_json(response) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.search_all_assignments", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "SearchAllAssignments", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _SearchAssignments(_BaseReservationServiceRestTransport._BaseSearchAssignments, ReservationServiceRestStub): + def __hash__(self): + return hash("ReservationServiceRestTransport.SearchAssignments") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None): + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + return response + + def __call__(self, + request: reservation.SearchAssignmentsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), + ) -> reservation.SearchAssignmentsResponse: + r"""Call the search assignments method over HTTP. + + Args: + request (~.reservation.SearchAssignmentsRequest): + The request object. The request for + [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. + Note: "bigquery.reservationAssignments.search" + permission is required on the related assignee. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.reservation.SearchAssignmentsResponse: + The response for + [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. + + """ + + http_options = _BaseReservationServiceRestTransport._BaseSearchAssignments._get_http_options() + + request, metadata = self._interceptor.pre_search_assignments(request, metadata) + transcoded_request = _BaseReservationServiceRestTransport._BaseSearchAssignments._get_transcoded_request(http_options, request) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseSearchAssignments._get_query_params_json(transcoded_request) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) + method = transcoded_request['method'] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.SearchAssignments", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "SearchAssignments", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ReservationServiceRestTransport._SearchAssignments._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request) + + # 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 = reservation.SearchAssignmentsResponse() + pb_resp = reservation.SearchAssignmentsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_search_assignments(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_search_assignments_with_metadata(resp, response_metadata) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + try: + response_payload = reservation.SearchAssignmentsResponse.to_json(response) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.search_assignments", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "SearchAssignments", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _SetIamPolicy(_BaseReservationServiceRestTransport._BaseSetIamPolicy, ReservationServiceRestStub): + def __hash__(self): + return hash("ReservationServiceRestTransport.SetIamPolicy") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None): + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + return response + + def __call__(self, + request: iam_policy_pb2.SetIamPolicyRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), + ) -> policy_pb2.Policy: + r"""Call the set iam policy method over HTTP. + + Args: + request (~.iam_policy_pb2.SetIamPolicyRequest): + The request object. Request message for ``SetIamPolicy`` 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.policy_pb2.Policy: + An Identity and Access Management (IAM) policy, which + specifies access controls for Google Cloud resources. + + A ``Policy`` is a collection of ``bindings``. A + ``binding`` binds one or more ``members``, or + principals, to a single ``role``. Principals can be user + accounts, service accounts, Google groups, and domains + (such as G Suite). A ``role`` is a named list of + permissions; each ``role`` can be an IAM predefined role + or a user-created custom role. + + For some types of Google Cloud resources, a ``binding`` + can also specify a ``condition``, which is a logical + expression that allows access to a resource only if the + expression evaluates to ``true``. A condition can add + constraints based on attributes of the request, the + resource, or both. To learn which resources support + conditions in their IAM policies, see the `IAM + documentation `__. + + **JSON example:** + + :: + + { + "bindings": [ + { + "role": "roles/resourcemanager.organizationAdmin", + "members": [ + "user:mike@example.com", + "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" + ] + }, + { + "role": "roles/resourcemanager.organizationViewer", + "members": [ + "user:eve@example.com" + ], + "condition": { + "title": "expirable access", + "description": "Does not grant access after Sep 2020", + "expression": "request.time < + timestamp('2020-10-01T00:00:00.000Z')", + } + } + ], + "etag": "BwWWja0YfJA=", + "version": 3 + } + + **YAML example:** + + :: + + bindings: + - members: + - user:mike@example.com + - group:admins@example.com + - domain:google.com + - serviceAccount:my-project-id@appspot.gserviceaccount.com + role: roles/resourcemanager.organizationAdmin + - members: + - user:eve@example.com + role: roles/resourcemanager.organizationViewer + condition: + title: expirable access + description: Does not grant access after Sep 2020 + expression: request.time < timestamp('2020-10-01T00:00:00.000Z') + etag: BwWWja0YfJA= + version: 3 + + For a description of IAM and its features, see the `IAM + documentation `__. + + """ + + http_options = _BaseReservationServiceRestTransport._BaseSetIamPolicy._get_http_options() + + request, metadata = self._interceptor.pre_set_iam_policy(request, metadata) + transcoded_request = _BaseReservationServiceRestTransport._BaseSetIamPolicy._get_transcoded_request(http_options, request) + + body = _BaseReservationServiceRestTransport._BaseSetIamPolicy._get_request_body_json(transcoded_request) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseSetIamPolicy._get_query_params_json(transcoded_request) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) + method = transcoded_request['method'] + try: + request_payload = json_format.MessageToJson(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.SetIamPolicy", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "SetIamPolicy", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ReservationServiceRestTransport._SetIamPolicy._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request, 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 = policy_pb2.Policy() + pb_resp = resp + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_set_iam_policy(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_set_iam_policy_with_metadata(resp, response_metadata) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + try: + response_payload = json_format.MessageToJson(resp) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.set_iam_policy", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "SetIamPolicy", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _SplitCapacityCommitment(_BaseReservationServiceRestTransport._BaseSplitCapacityCommitment, ReservationServiceRestStub): + def __hash__(self): + return hash("ReservationServiceRestTransport.SplitCapacityCommitment") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None): + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + return response + + def __call__(self, + request: reservation.SplitCapacityCommitmentRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), + ) -> reservation.SplitCapacityCommitmentResponse: + r"""Call the split capacity commitment method over HTTP. + + Args: + request (~.reservation.SplitCapacityCommitmentRequest): + The request object. The request for + [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment]. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.reservation.SplitCapacityCommitmentResponse: + The response for + [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment]. + + """ + + http_options = _BaseReservationServiceRestTransport._BaseSplitCapacityCommitment._get_http_options() + + request, metadata = self._interceptor.pre_split_capacity_commitment(request, metadata) + transcoded_request = _BaseReservationServiceRestTransport._BaseSplitCapacityCommitment._get_transcoded_request(http_options, request) + + body = _BaseReservationServiceRestTransport._BaseSplitCapacityCommitment._get_request_body_json(transcoded_request) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseSplitCapacityCommitment._get_query_params_json(transcoded_request) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) + method = transcoded_request['method'] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.SplitCapacityCommitment", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "SplitCapacityCommitment", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ReservationServiceRestTransport._SplitCapacityCommitment._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request, 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 = reservation.SplitCapacityCommitmentResponse() + pb_resp = reservation.SplitCapacityCommitmentResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_split_capacity_commitment(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_split_capacity_commitment_with_metadata(resp, response_metadata) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + try: + response_payload = reservation.SplitCapacityCommitmentResponse.to_json(response) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.split_capacity_commitment", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "SplitCapacityCommitment", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _TestIamPermissions(_BaseReservationServiceRestTransport._BaseTestIamPermissions, ReservationServiceRestStub): + def __hash__(self): + return hash("ReservationServiceRestTransport.TestIamPermissions") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None): + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + return response + + def __call__(self, + request: iam_policy_pb2.TestIamPermissionsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), + ) -> iam_policy_pb2.TestIamPermissionsResponse: + r"""Call the test iam permissions method over HTTP. + + Args: + request (~.iam_policy_pb2.TestIamPermissionsRequest): + The request object. Request message for ``TestIamPermissions`` 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.iam_policy_pb2.TestIamPermissionsResponse: + Response message for ``TestIamPermissions`` method. + """ + + http_options = _BaseReservationServiceRestTransport._BaseTestIamPermissions._get_http_options() + + request, metadata = self._interceptor.pre_test_iam_permissions(request, metadata) + transcoded_request = _BaseReservationServiceRestTransport._BaseTestIamPermissions._get_transcoded_request(http_options, request) + + body = _BaseReservationServiceRestTransport._BaseTestIamPermissions._get_request_body_json(transcoded_request) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseTestIamPermissions._get_query_params_json(transcoded_request) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) + method = transcoded_request['method'] + try: + request_payload = json_format.MessageToJson(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.TestIamPermissions", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "TestIamPermissions", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ReservationServiceRestTransport._TestIamPermissions._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request, 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 = iam_policy_pb2.TestIamPermissionsResponse() + pb_resp = resp + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_test_iam_permissions(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_test_iam_permissions_with_metadata(resp, response_metadata) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + try: + response_payload = json_format.MessageToJson(resp) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.test_iam_permissions", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "TestIamPermissions", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _UpdateAssignment(_BaseReservationServiceRestTransport._BaseUpdateAssignment, ReservationServiceRestStub): + def __hash__(self): + return hash("ReservationServiceRestTransport.UpdateAssignment") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None): + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + return response + + def __call__(self, + request: reservation.UpdateAssignmentRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), + ) -> reservation.Assignment: + r"""Call the update assignment method over HTTP. + + Args: + request (~.reservation.UpdateAssignmentRequest): + The request object. The request for + [ReservationService.UpdateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateAssignment]. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.reservation.Assignment: + An assignment allows a project to + submit jobs of a certain type using + slots from the specified reservation. + + """ + + http_options = _BaseReservationServiceRestTransport._BaseUpdateAssignment._get_http_options() + + request, metadata = self._interceptor.pre_update_assignment(request, metadata) + transcoded_request = _BaseReservationServiceRestTransport._BaseUpdateAssignment._get_transcoded_request(http_options, request) + + body = _BaseReservationServiceRestTransport._BaseUpdateAssignment._get_request_body_json(transcoded_request) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseUpdateAssignment._get_query_params_json(transcoded_request) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) + method = transcoded_request['method'] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.UpdateAssignment", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "UpdateAssignment", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ReservationServiceRestTransport._UpdateAssignment._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request, 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 = reservation.Assignment() + pb_resp = reservation.Assignment.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_update_assignment(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_update_assignment_with_metadata(resp, response_metadata) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + try: + response_payload = reservation.Assignment.to_json(response) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.update_assignment", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "UpdateAssignment", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _UpdateBiReservation(_BaseReservationServiceRestTransport._BaseUpdateBiReservation, ReservationServiceRestStub): + def __hash__(self): + return hash("ReservationServiceRestTransport.UpdateBiReservation") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None): + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + return response + + def __call__(self, + request: reservation.UpdateBiReservationRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), + ) -> reservation.BiReservation: + r"""Call the update bi reservation method over HTTP. + + Args: + request (~.reservation.UpdateBiReservationRequest): + The request object. A request to update a BI reservation. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.reservation.BiReservation: + Represents a BI Reservation. + """ + + http_options = _BaseReservationServiceRestTransport._BaseUpdateBiReservation._get_http_options() + + request, metadata = self._interceptor.pre_update_bi_reservation(request, metadata) + transcoded_request = _BaseReservationServiceRestTransport._BaseUpdateBiReservation._get_transcoded_request(http_options, request) + + body = _BaseReservationServiceRestTransport._BaseUpdateBiReservation._get_request_body_json(transcoded_request) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseUpdateBiReservation._get_query_params_json(transcoded_request) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) + method = transcoded_request['method'] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.UpdateBiReservation", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "UpdateBiReservation", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ReservationServiceRestTransport._UpdateBiReservation._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request, 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 = reservation.BiReservation() + pb_resp = reservation.BiReservation.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_update_bi_reservation(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_update_bi_reservation_with_metadata(resp, response_metadata) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + try: + response_payload = reservation.BiReservation.to_json(response) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.update_bi_reservation", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "UpdateBiReservation", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _UpdateCapacityCommitment(_BaseReservationServiceRestTransport._BaseUpdateCapacityCommitment, ReservationServiceRestStub): + def __hash__(self): + return hash("ReservationServiceRestTransport.UpdateCapacityCommitment") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None): + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + return response + + def __call__(self, + request: reservation.UpdateCapacityCommitmentRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), + ) -> reservation.CapacityCommitment: + r"""Call the update capacity + commitment method over HTTP. + + Args: + request (~.reservation.UpdateCapacityCommitmentRequest): + The request object. The request for + [ReservationService.UpdateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateCapacityCommitment]. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.reservation.CapacityCommitment: + Capacity commitment is a way to + purchase compute capacity for BigQuery + jobs (in the form of slots) with some + committed period of usage. Annual + commitments renew by default. + Commitments can be removed after their + commitment end time passes. + + In order to remove annual commitment, + its plan needs to be changed to monthly + or flex first. + + A capacity commitment resource exists as + a child resource of the admin project. + + """ + + http_options = _BaseReservationServiceRestTransport._BaseUpdateCapacityCommitment._get_http_options() + + request, metadata = self._interceptor.pre_update_capacity_commitment(request, metadata) + transcoded_request = _BaseReservationServiceRestTransport._BaseUpdateCapacityCommitment._get_transcoded_request(http_options, request) + + body = _BaseReservationServiceRestTransport._BaseUpdateCapacityCommitment._get_request_body_json(transcoded_request) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseUpdateCapacityCommitment._get_query_params_json(transcoded_request) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) + method = transcoded_request['method'] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.UpdateCapacityCommitment", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "UpdateCapacityCommitment", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ReservationServiceRestTransport._UpdateCapacityCommitment._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request, 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 = reservation.CapacityCommitment() + pb_resp = reservation.CapacityCommitment.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_update_capacity_commitment(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_update_capacity_commitment_with_metadata(resp, response_metadata) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + try: + response_payload = reservation.CapacityCommitment.to_json(response) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.update_capacity_commitment", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "UpdateCapacityCommitment", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _UpdateReservation(_BaseReservationServiceRestTransport._BaseUpdateReservation, ReservationServiceRestStub): + def __hash__(self): + return hash("ReservationServiceRestTransport.UpdateReservation") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None): + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + return response + + def __call__(self, + request: gcbr_reservation.UpdateReservationRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), + ) -> gcbr_reservation.Reservation: + r"""Call the update reservation method over HTTP. + + Args: + request (~.gcbr_reservation.UpdateReservationRequest): + The request object. The request for + [ReservationService.UpdateReservation][google.cloud.bigquery.reservation.v1.ReservationService.UpdateReservation]. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.gcbr_reservation.Reservation: + A reservation is a mechanism used to + guarantee slots to users. + + """ + + http_options = _BaseReservationServiceRestTransport._BaseUpdateReservation._get_http_options() + + request, metadata = self._interceptor.pre_update_reservation(request, metadata) + transcoded_request = _BaseReservationServiceRestTransport._BaseUpdateReservation._get_transcoded_request(http_options, request) + + body = _BaseReservationServiceRestTransport._BaseUpdateReservation._get_request_body_json(transcoded_request) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseUpdateReservation._get_query_params_json(transcoded_request) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) + method = transcoded_request['method'] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.UpdateReservation", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "UpdateReservation", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ReservationServiceRestTransport._UpdateReservation._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request, 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 = gcbr_reservation.Reservation() + pb_resp = gcbr_reservation.Reservation.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_update_reservation(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_update_reservation_with_metadata(resp, response_metadata) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + try: + response_payload = gcbr_reservation.Reservation.to_json(response) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.update_reservation", + extra = { + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "UpdateReservation", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + @property + def create_assignment(self) -> Callable[ + [reservation.CreateAssignmentRequest], + reservation.Assignment]: + # 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._CreateAssignment(self._session, self._host, self._interceptor) # type: ignore + + @property + def create_capacity_commitment(self) -> Callable[ + [reservation.CreateCapacityCommitmentRequest], + reservation.CapacityCommitment]: + # 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._CreateCapacityCommitment(self._session, self._host, self._interceptor) # type: ignore + + @property + def create_reservation(self) -> Callable[ + [gcbr_reservation.CreateReservationRequest], + gcbr_reservation.Reservation]: + # 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._CreateReservation(self._session, self._host, self._interceptor) # type: ignore + + @property + def create_reservation_group(self) -> Callable[ + [reservation.CreateReservationGroupRequest], + reservation.ReservationGroup]: + # 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._CreateReservationGroup(self._session, self._host, self._interceptor) # type: ignore + + @property + def delete_assignment(self) -> Callable[ + [reservation.DeleteAssignmentRequest], + empty_pb2.Empty]: + # 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._DeleteAssignment(self._session, self._host, self._interceptor) # type: ignore + + @property + def delete_capacity_commitment(self) -> Callable[ + [reservation.DeleteCapacityCommitmentRequest], + empty_pb2.Empty]: + # 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._DeleteCapacityCommitment(self._session, self._host, self._interceptor) # type: ignore + + @property + def delete_reservation(self) -> Callable[ + [reservation.DeleteReservationRequest], + empty_pb2.Empty]: + # 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._DeleteReservation(self._session, self._host, self._interceptor) # type: ignore + + @property + def delete_reservation_group(self) -> Callable[ + [reservation.DeleteReservationGroupRequest], + empty_pb2.Empty]: + # 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._DeleteReservationGroup(self._session, self._host, self._interceptor) # type: ignore + + @property + def failover_reservation(self) -> Callable[ + [reservation.FailoverReservationRequest], + reservation.Reservation]: + # 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._FailoverReservation(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_bi_reservation(self) -> Callable[ + [reservation.GetBiReservationRequest], + reservation.BiReservation]: + # 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._GetBiReservation(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_capacity_commitment(self) -> Callable[ + [reservation.GetCapacityCommitmentRequest], + reservation.CapacityCommitment]: + # 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._GetCapacityCommitment(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_iam_policy(self) -> Callable[ + [iam_policy_pb2.GetIamPolicyRequest], + policy_pb2.Policy]: + # 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._GetIamPolicy(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_reservation(self) -> Callable[ + [reservation.GetReservationRequest], + reservation.Reservation]: + # 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._GetReservation(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_reservation_group(self) -> Callable[ + [reservation.GetReservationGroupRequest], + reservation.ReservationGroup]: + # 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._GetReservationGroup(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_assignments(self) -> Callable[ + [reservation.ListAssignmentsRequest], + reservation.ListAssignmentsResponse]: + # 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._ListAssignments(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_capacity_commitments(self) -> Callable[ + [reservation.ListCapacityCommitmentsRequest], + reservation.ListCapacityCommitmentsResponse]: + # 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._ListCapacityCommitments(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_reservation_groups(self) -> Callable[ + [reservation.ListReservationGroupsRequest], + reservation.ListReservationGroupsResponse]: + # 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._ListReservationGroups(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_reservations(self) -> Callable[ + [reservation.ListReservationsRequest], + reservation.ListReservationsResponse]: + # 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._ListReservations(self._session, self._host, self._interceptor) # type: ignore + + @property + def merge_capacity_commitments(self) -> Callable[ + [reservation.MergeCapacityCommitmentsRequest], + reservation.CapacityCommitment]: + # 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._MergeCapacityCommitments(self._session, self._host, self._interceptor) # type: ignore + + @property + def move_assignment(self) -> Callable[ + [reservation.MoveAssignmentRequest], + reservation.Assignment]: + # 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._MoveAssignment(self._session, self._host, self._interceptor) # type: ignore + + @property + def search_all_assignments(self) -> Callable[ + [reservation.SearchAllAssignmentsRequest], + reservation.SearchAllAssignmentsResponse]: + # 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._SearchAllAssignments(self._session, self._host, self._interceptor) # type: ignore + + @property + def search_assignments(self) -> Callable[ + [reservation.SearchAssignmentsRequest], + reservation.SearchAssignmentsResponse]: + # 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._SearchAssignments(self._session, self._host, self._interceptor) # type: ignore + + @property + def set_iam_policy(self) -> Callable[ + [iam_policy_pb2.SetIamPolicyRequest], + policy_pb2.Policy]: + # 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._SetIamPolicy(self._session, self._host, self._interceptor) # type: ignore + + @property + def split_capacity_commitment(self) -> Callable[ + [reservation.SplitCapacityCommitmentRequest], + reservation.SplitCapacityCommitmentResponse]: + # 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._SplitCapacityCommitment(self._session, self._host, self._interceptor) # type: ignore + + @property + def test_iam_permissions(self) -> Callable[ + [iam_policy_pb2.TestIamPermissionsRequest], + iam_policy_pb2.TestIamPermissionsResponse]: + # 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._TestIamPermissions(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_assignment(self) -> Callable[ + [reservation.UpdateAssignmentRequest], + reservation.Assignment]: + # 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._UpdateAssignment(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_bi_reservation(self) -> Callable[ + [reservation.UpdateBiReservationRequest], + reservation.BiReservation]: + # 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._UpdateBiReservation(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_capacity_commitment(self) -> Callable[ + [reservation.UpdateCapacityCommitmentRequest], + reservation.CapacityCommitment]: + # 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._UpdateCapacityCommitment(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_reservation(self) -> Callable[ + [gcbr_reservation.UpdateReservationRequest], + gcbr_reservation.Reservation]: + # 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._UpdateReservation(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__=( + 'ReservationServiceRestTransport', +) diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/rest_base.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/rest_base.py new file mode 100644 index 000000000000..ba78ae5c5d1e --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/rest_base.py @@ -0,0 +1,1282 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 json # type: ignore +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from .base import ReservationServiceTransport, DEFAULT_CLIENT_INFO + +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union + + +from google.cloud.bigquery_reservation_v1.types import reservation +from google.cloud.bigquery_reservation_v1.types import reservation as gcbr_reservation +from google.iam.v1 import iam_policy_pb2 # type: ignore +from google.iam.v1 import policy_pb2 # type: ignore +from google.protobuf import empty_pb2 # type: ignore + + +class _BaseReservationServiceRestTransport(ReservationServiceTransport): + """Base REST backend transport for ReservationService. + + Note: This class is not meant to be used directly. Use its sync and + async sub-classes instead. + + 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 = 'bigqueryreservation.googleapis.com', + credentials: Optional[Any] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = 'https', + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + Args: + host (Optional[str]): + The hostname to connect to (default: 'bigqueryreservation.googleapis.com'). + credentials (Optional[Any]): 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. + 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 + 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 + ) + + class _BaseCreateAssignment: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __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} + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1/{parent=projects/*/locations/*/reservations/*}/assignments', + 'body': 'assignment', + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = reservation.CreateAssignmentRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_request_body_json(transcoded_request): + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + use_integers_for_enums=True + ) + return body + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + use_integers_for_enums=True, + )) + query_params.update(_BaseReservationServiceRestTransport._BaseCreateAssignment._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseCreateCapacityCommitment: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __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} + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1/{parent=projects/*/locations/*}/capacityCommitments', + 'body': 'capacity_commitment', + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = reservation.CreateCapacityCommitmentRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_request_body_json(transcoded_request): + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + use_integers_for_enums=True + ) + return body + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + use_integers_for_enums=True, + )) + query_params.update(_BaseReservationServiceRestTransport._BaseCreateCapacityCommitment._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseCreateReservation: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __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} + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1/{parent=projects/*/locations/*}/reservations', + 'body': 'reservation', + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = gcbr_reservation.CreateReservationRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_request_body_json(transcoded_request): + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + use_integers_for_enums=True + ) + return body + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + use_integers_for_enums=True, + )) + query_params.update(_BaseReservationServiceRestTransport._BaseCreateReservation._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseCreateReservationGroup: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "reservationGroupId" : "", } + + @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} + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1/{parent=projects/*/locations/*}/reservationGroups', + 'body': 'reservation_group', + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = reservation.CreateReservationGroupRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_request_body_json(transcoded_request): + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + use_integers_for_enums=True + ) + return body + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + use_integers_for_enums=True, + )) + query_params.update(_BaseReservationServiceRestTransport._BaseCreateReservationGroup._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseDeleteAssignment: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __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} + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [{ + 'method': 'delete', + 'uri': '/v1/{name=projects/*/locations/*/reservations/*/assignments/*}', + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = reservation.DeleteAssignmentRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + use_integers_for_enums=True, + )) + query_params.update(_BaseReservationServiceRestTransport._BaseDeleteAssignment._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseDeleteCapacityCommitment: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __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} + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [{ + 'method': 'delete', + 'uri': '/v1/{name=projects/*/locations/*/capacityCommitments/*}', + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = reservation.DeleteCapacityCommitmentRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + use_integers_for_enums=True, + )) + query_params.update(_BaseReservationServiceRestTransport._BaseDeleteCapacityCommitment._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseDeleteReservation: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __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} + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [{ + 'method': 'delete', + 'uri': '/v1/{name=projects/*/locations/*/reservations/*}', + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = reservation.DeleteReservationRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + use_integers_for_enums=True, + )) + query_params.update(_BaseReservationServiceRestTransport._BaseDeleteReservation._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseDeleteReservationGroup: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __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} + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [{ + 'method': 'delete', + 'uri': '/v1/{name=projects/*/locations/*/reservationGroups/*}', + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = reservation.DeleteReservationGroupRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + use_integers_for_enums=True, + )) + query_params.update(_BaseReservationServiceRestTransport._BaseDeleteReservationGroup._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseFailoverReservation: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __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} + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1/{name=projects/*/locations/*/reservations/*}:failoverReservation', + 'body': '*', + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = reservation.FailoverReservationRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_request_body_json(transcoded_request): + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + use_integers_for_enums=True + ) + return body + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + use_integers_for_enums=True, + )) + query_params.update(_BaseReservationServiceRestTransport._BaseFailoverReservation._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseGetBiReservation: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __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} + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/{name=projects/*/locations/*/biReservation}', + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = reservation.GetBiReservationRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + use_integers_for_enums=True, + )) + query_params.update(_BaseReservationServiceRestTransport._BaseGetBiReservation._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseGetCapacityCommitment: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __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} + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/{name=projects/*/locations/*/capacityCommitments/*}', + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = reservation.GetCapacityCommitmentRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + use_integers_for_enums=True, + )) + query_params.update(_BaseReservationServiceRestTransport._BaseGetCapacityCommitment._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseGetIamPolicy: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __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} + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/{resource=projects/*/locations/*/reservations/*}:getIamPolicy', + }, + { + 'method': 'get', + 'uri': '/v1/{resource=projects/*/locations/*/reservations/*/assignments/*}:getIamPolicy', + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = request + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + use_integers_for_enums=True, + )) + query_params.update(_BaseReservationServiceRestTransport._BaseGetIamPolicy._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseGetReservation: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __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} + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/{name=projects/*/locations/*/reservations/*}', + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = reservation.GetReservationRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + use_integers_for_enums=True, + )) + query_params.update(_BaseReservationServiceRestTransport._BaseGetReservation._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseGetReservationGroup: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __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} + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/{name=projects/*/locations/*/reservationGroups/*}', + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = reservation.GetReservationGroupRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + use_integers_for_enums=True, + )) + query_params.update(_BaseReservationServiceRestTransport._BaseGetReservationGroup._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseListAssignments: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __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} + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/{parent=projects/*/locations/*/reservations/*}/assignments', + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = reservation.ListAssignmentsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + use_integers_for_enums=True, + )) + query_params.update(_BaseReservationServiceRestTransport._BaseListAssignments._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseListCapacityCommitments: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __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} + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/{parent=projects/*/locations/*}/capacityCommitments', + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = reservation.ListCapacityCommitmentsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + use_integers_for_enums=True, + )) + query_params.update(_BaseReservationServiceRestTransport._BaseListCapacityCommitments._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseListReservationGroups: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __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} + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/{parent=projects/*/locations/*}/reservationGroups', + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = reservation.ListReservationGroupsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + use_integers_for_enums=True, + )) + query_params.update(_BaseReservationServiceRestTransport._BaseListReservationGroups._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseListReservations: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __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} + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/{parent=projects/*/locations/*}/reservations', + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = reservation.ListReservationsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + use_integers_for_enums=True, + )) + query_params.update(_BaseReservationServiceRestTransport._BaseListReservations._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseMergeCapacityCommitments: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1/{parent=projects/*/locations/*}/capacityCommitments:merge', + 'body': '*', + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = reservation.MergeCapacityCommitmentsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_request_body_json(transcoded_request): + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + use_integers_for_enums=True + ) + return body + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + use_integers_for_enums=True, + )) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseMoveAssignment: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __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} + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1/{name=projects/*/locations/*/reservations/*/assignments/*}:move', + 'body': '*', + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = reservation.MoveAssignmentRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_request_body_json(transcoded_request): + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + use_integers_for_enums=True + ) + return body + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + use_integers_for_enums=True, + )) + query_params.update(_BaseReservationServiceRestTransport._BaseMoveAssignment._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseSearchAllAssignments: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __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} + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/{parent=projects/*/locations/*}:searchAllAssignments', + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = reservation.SearchAllAssignmentsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + use_integers_for_enums=True, + )) + query_params.update(_BaseReservationServiceRestTransport._BaseSearchAllAssignments._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseSearchAssignments: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __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} + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/{parent=projects/*/locations/*}:searchAssignments', + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = reservation.SearchAssignmentsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + use_integers_for_enums=True, + )) + query_params.update(_BaseReservationServiceRestTransport._BaseSearchAssignments._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseSetIamPolicy: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __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} + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1/{resource=projects/*/locations/*/reservations/*}:setIamPolicy', + 'body': '*', + }, + { + 'method': 'post', + 'uri': '/v1/{resource=projects/*/locations/*/reservations/*/assignments/*}:setIamPolicy', + 'body': '*', + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = request + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_request_body_json(transcoded_request): + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + use_integers_for_enums=True + ) + return body + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + use_integers_for_enums=True, + )) + query_params.update(_BaseReservationServiceRestTransport._BaseSetIamPolicy._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseSplitCapacityCommitment: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __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} + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1/{name=projects/*/locations/*/capacityCommitments/*}:split', + 'body': '*', + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = reservation.SplitCapacityCommitmentRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_request_body_json(transcoded_request): + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + use_integers_for_enums=True + ) + return body + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + use_integers_for_enums=True, + )) + query_params.update(_BaseReservationServiceRestTransport._BaseSplitCapacityCommitment._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseTestIamPermissions: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __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} + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1/{resource=projects/*/locations/*/reservations/*}:testIamPermissions', + 'body': '*', + }, + { + 'method': 'post', + 'uri': '/v1/{resource=projects/*/locations/*/reservations/*/assignments/*}:testIamPermissions', + 'body': '*', + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = request + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_request_body_json(transcoded_request): + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + use_integers_for_enums=True + ) + return body + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + use_integers_for_enums=True, + )) + query_params.update(_BaseReservationServiceRestTransport._BaseTestIamPermissions._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseUpdateAssignment: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [{ + 'method': 'patch', + 'uri': '/v1/{assignment.name=projects/*/locations/*/reservations/*/assignments/*}', + 'body': 'assignment', + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = reservation.UpdateAssignmentRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_request_body_json(transcoded_request): + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + use_integers_for_enums=True + ) + return body + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + use_integers_for_enums=True, + )) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseUpdateBiReservation: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [{ + 'method': 'patch', + 'uri': '/v1/{bi_reservation.name=projects/*/locations/*/biReservation}', + 'body': 'bi_reservation', + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = reservation.UpdateBiReservationRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_request_body_json(transcoded_request): + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + use_integers_for_enums=True + ) + return body + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + use_integers_for_enums=True, + )) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseUpdateCapacityCommitment: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [{ + 'method': 'patch', + 'uri': '/v1/{capacity_commitment.name=projects/*/locations/*/capacityCommitments/*}', + 'body': 'capacity_commitment', + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = reservation.UpdateCapacityCommitmentRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_request_body_json(transcoded_request): + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + use_integers_for_enums=True + ) + return body + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + use_integers_for_enums=True, + )) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseUpdateReservation: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [{ + 'method': 'patch', + 'uri': '/v1/{reservation.name=projects/*/locations/*/reservations/*}', + 'body': 'reservation', + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = gcbr_reservation.UpdateReservationRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_request_body_json(transcoded_request): + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + use_integers_for_enums=True + ) + return body + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + use_integers_for_enums=True, + )) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + +__all__=( + '_BaseReservationServiceRestTransport', +) diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/types/__init__.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/types/__init__.py new file mode 100644 index 000000000000..aab35926c19b --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/types/__init__.py @@ -0,0 +1,104 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 .reservation import ( + Assignment, + BiReservation, + CapacityCommitment, + CreateAssignmentRequest, + CreateCapacityCommitmentRequest, + CreateReservationGroupRequest, + CreateReservationRequest, + DeleteAssignmentRequest, + DeleteCapacityCommitmentRequest, + DeleteReservationGroupRequest, + DeleteReservationRequest, + FailoverReservationRequest, + GetBiReservationRequest, + GetCapacityCommitmentRequest, + GetReservationGroupRequest, + GetReservationRequest, + ListAssignmentsRequest, + ListAssignmentsResponse, + ListCapacityCommitmentsRequest, + ListCapacityCommitmentsResponse, + ListReservationGroupsRequest, + ListReservationGroupsResponse, + ListReservationsRequest, + ListReservationsResponse, + MergeCapacityCommitmentsRequest, + MoveAssignmentRequest, + Reservation, + ReservationGroup, + SchedulingPolicy, + SearchAllAssignmentsRequest, + SearchAllAssignmentsResponse, + SearchAssignmentsRequest, + SearchAssignmentsResponse, + SplitCapacityCommitmentRequest, + SplitCapacityCommitmentResponse, + TableReference, + UpdateAssignmentRequest, + UpdateBiReservationRequest, + UpdateCapacityCommitmentRequest, + UpdateReservationRequest, + Edition, + FailoverMode, +) + +__all__ = ( + 'Assignment', + 'BiReservation', + 'CapacityCommitment', + 'CreateAssignmentRequest', + 'CreateCapacityCommitmentRequest', + 'CreateReservationGroupRequest', + 'CreateReservationRequest', + 'DeleteAssignmentRequest', + 'DeleteCapacityCommitmentRequest', + 'DeleteReservationGroupRequest', + 'DeleteReservationRequest', + 'FailoverReservationRequest', + 'GetBiReservationRequest', + 'GetCapacityCommitmentRequest', + 'GetReservationGroupRequest', + 'GetReservationRequest', + 'ListAssignmentsRequest', + 'ListAssignmentsResponse', + 'ListCapacityCommitmentsRequest', + 'ListCapacityCommitmentsResponse', + 'ListReservationGroupsRequest', + 'ListReservationGroupsResponse', + 'ListReservationsRequest', + 'ListReservationsResponse', + 'MergeCapacityCommitmentsRequest', + 'MoveAssignmentRequest', + 'Reservation', + 'ReservationGroup', + 'SchedulingPolicy', + 'SearchAllAssignmentsRequest', + 'SearchAllAssignmentsResponse', + 'SearchAssignmentsRequest', + 'SearchAssignmentsResponse', + 'SplitCapacityCommitmentRequest', + 'SplitCapacityCommitmentResponse', + 'TableReference', + 'UpdateAssignmentRequest', + 'UpdateBiReservationRequest', + 'UpdateCapacityCommitmentRequest', + 'UpdateReservationRequest', + 'Edition', + 'FailoverMode', +) diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/types/reservation.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/types/reservation.py new file mode 100644 index 000000000000..e00c4bf299f3 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/types/reservation.py @@ -0,0 +1,1937 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +from google.rpc import status_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.bigquery.reservation.v1', + manifest={ + 'Edition', + 'FailoverMode', + 'Reservation', + 'SchedulingPolicy', + 'ReservationGroup', + 'CapacityCommitment', + 'CreateReservationRequest', + 'ListReservationsRequest', + 'ListReservationsResponse', + 'GetReservationRequest', + 'DeleteReservationRequest', + 'UpdateReservationRequest', + 'FailoverReservationRequest', + 'CreateReservationGroupRequest', + 'GetReservationGroupRequest', + 'ListReservationGroupsRequest', + 'ListReservationGroupsResponse', + 'DeleteReservationGroupRequest', + 'CreateCapacityCommitmentRequest', + 'ListCapacityCommitmentsRequest', + 'ListCapacityCommitmentsResponse', + 'GetCapacityCommitmentRequest', + 'DeleteCapacityCommitmentRequest', + 'UpdateCapacityCommitmentRequest', + 'SplitCapacityCommitmentRequest', + 'SplitCapacityCommitmentResponse', + 'MergeCapacityCommitmentsRequest', + 'Assignment', + 'CreateAssignmentRequest', + 'ListAssignmentsRequest', + 'ListAssignmentsResponse', + 'DeleteAssignmentRequest', + 'SearchAssignmentsRequest', + 'SearchAllAssignmentsRequest', + 'SearchAssignmentsResponse', + 'SearchAllAssignmentsResponse', + 'MoveAssignmentRequest', + 'UpdateAssignmentRequest', + 'TableReference', + 'BiReservation', + 'GetBiReservationRequest', + 'UpdateBiReservationRequest', + }, +) + + +class Edition(proto.Enum): + r"""The type of editions. + Different features and behaviors are provided to different + editions Capacity commitments and reservations are linked to + editions. + + Values: + EDITION_UNSPECIFIED (0): + Default value, which will be treated as + ENTERPRISE. + STANDARD (1): + Standard edition. + ENTERPRISE (2): + Enterprise edition. + ENTERPRISE_PLUS (3): + Enterprise Plus edition. + """ + EDITION_UNSPECIFIED = 0 + STANDARD = 1 + ENTERPRISE = 2 + ENTERPRISE_PLUS = 3 + + +class FailoverMode(proto.Enum): + r"""The failover mode when a user initiates a failover on a + reservation determines how writes that are pending replication + are handled after the failover is initiated. + + Values: + FAILOVER_MODE_UNSPECIFIED (0): + Invalid value. + SOFT (1): + When customers initiate a soft failover, + BigQuery will wait until all committed writes + are replicated to the secondary. This mode + requires both regions to be available for the + failover to succeed and prevents data loss. + HARD (2): + When customers initiate a hard failover, + BigQuery will not wait until all committed + writes are replicated to the secondary. There + can be data loss for hard failover. + """ + FAILOVER_MODE_UNSPECIFIED = 0 + SOFT = 1 + HARD = 2 + + +class Reservation(proto.Message): + r"""A reservation is a mechanism used to guarantee slots to + users. + + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + name (str): + Identifier. The resource name of the reservation, e.g., + ``projects/*/locations/*/reservations/team1-prod``. The + reservation_id must only contain lower case alphanumeric + characters or dashes. It must start with a letter and must + not end with a dash. Its maximum length is 64 characters. + slot_capacity (int): + Optional. Baseline slots available to this reservation. A + slot is a unit of computational power in BigQuery, and + serves as the unit of parallelism. + + Queries using this reservation might use more slots during + runtime if ignore_idle_slots is set to false, or autoscaling + is enabled. + + The total slot_capacity of the reservation and its siblings + may exceed the total slot_count of capacity commitments. In + that case, the exceeding slots will be charged with the + autoscale SKU. You can increase the number of baseline slots + in a reservation every few minutes. If you want to decrease + your baseline slots, you are limited to once an hour if you + have recently changed your baseline slot capacity and your + baseline slots exceed your committed slots. Otherwise, you + can decrease your baseline slots every few minutes. + ignore_idle_slots (bool): + Optional. If false, any query or pipeline job using this + reservation will use idle slots from other reservations + within the same admin project. If true, a query or pipeline + job using this reservation will execute with the slot + capacity specified in the slot_capacity field at most. + autoscale (google.cloud.bigquery_reservation_v1.types.Reservation.Autoscale): + Optional. The configuration parameters for + the auto scaling feature. + concurrency (int): + Optional. Job concurrency target which sets a + soft upper bound on the number of jobs that can + run concurrently in this reservation. This is a + soft target due to asynchronous nature of the + system and various optimizations for small + queries. Default value is 0 which means that + concurrency target will be automatically + computed by the system. NOTE: this field is + exposed as target job concurrency in the + Information Schema, DDL and BigQuery CLI. + creation_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. Creation time of the + reservation. + update_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. Last update time of the + reservation. + multi_region_auxiliary (bool): + Applicable only for reservations located + within one of the BigQuery multi-regions (US or + EU). + + If set to true, this reservation is placed in + the organization's secondary region which is + designated for disaster recovery purposes. If + false, this reservation is placed in the + organization's default region. + + NOTE: this is a preview feature. Project must be + allow-listed in order to set this field. + edition (google.cloud.bigquery_reservation_v1.types.Edition): + Optional. Edition of the reservation. + primary_location (str): + Output only. The current location of the + reservation's primary replica. This field is + only set for reservations using the managed + disaster recovery feature. + secondary_location (str): + Optional. The current location of the + reservation's secondary replica. This field is + only set for reservations using the managed + disaster recovery feature. Users can set this in + create reservation calls to create a failover + reservation or in update reservation calls to + convert a non-failover reservation to a failover + reservation(or vice versa). + original_primary_location (str): + Output only. The location where the + reservation was originally created. This is set + only during the failover reservation's creation. + All billing charges for the failover reservation + will be applied to this location. + max_slots (int): + Optional. The overall max slots for the reservation, + covering slot_capacity (baseline), idle slots (if + ignore_idle_slots is false) and scaled slots. If present, + the reservation won't use more than the specified number of + slots, even if there is demand and supply (from idle slots). + NOTE: capping a reservation's idle slot usage is best effort + and its usage may exceed the max_slots value. However, in + terms of autoscale.current_slots (which accounts for the + additional added slots), it will never exceed the max_slots + - baseline. + + This field must be set together with the scaling_mode enum + value, otherwise the request will be rejected with error + code ``google.rpc.Code.INVALID_ARGUMENT``. + + If the max_slots and scaling_mode are set, the autoscale or + autoscale.max_slots field must be unset. Otherwise the + request will be rejected with error code + ``google.rpc.Code.INVALID_ARGUMENT``. However, the autoscale + field may still be in the output. The autopscale.max_slots + will always show as 0 and the autoscaler.current_slots will + represent the current slots from autoscaler excluding idle + slots. For example, if the max_slots is 1000 and + scaling_mode is AUTOSCALE_ONLY, then in the output, the + autoscaler.max_slots will be 0 and the + autoscaler.current_slots may be any value between 0 and + 1000. + + If the max_slots is 1000, scaling_mode is ALL_SLOTS, the + baseline is 100 and idle slots usage is 200, then in the + output, the autoscaler.max_slots will be 0 and the + autoscaler.current_slots will not be higher than 700. + + If the max_slots is 1000, scaling_mode is IDLE_SLOTS_ONLY, + then in the output, the autoscaler field will be null. + + If the max_slots and scaling_mode are set, then the + ignore_idle_slots field must be aligned with the + scaling_mode enum value.(See details in ScalingMode + comments). Otherwise the request will be rejected with error + code ``google.rpc.Code.INVALID_ARGUMENT``. + + Please note, the max_slots is for user to manage the part of + slots greater than the baseline. Therefore, we don't allow + users to set max_slots smaller or equal to the baseline as + it will not be meaningful. If the field is present and + slot_capacity>=max_slots, requests will be rejected with + error code ``google.rpc.Code.INVALID_ARGUMENT``. + + Please note that if max_slots is set to 0, we will treat it + as unset. Customers can set max_slots to 0 and set + scaling_mode to SCALING_MODE_UNSPECIFIED to disable the + max_slots feature. + + This field is a member of `oneof`_ ``_max_slots``. + scaling_mode (google.cloud.bigquery_reservation_v1.types.Reservation.ScalingMode): + Optional. The scaling mode for the reservation. If the field + is present but max_slots is not present, requests will be + rejected with error code + ``google.rpc.Code.INVALID_ARGUMENT``. + labels (MutableMapping[str, str]): + Optional. The labels associated with this + reservation. You can use these to organize and + group your reservations. You can set this + property when you create or update a + reservation. + reservation_group (str): + Optional. The reservation group that this reservation + belongs to. You can set this property when you create or + update a reservation. Reservations do not need to belong to + a reservation group. Format: + projects/{project}/locations/{location}/reservationGroups/{reservation_group} + or just {reservation_group} + replication_status (google.cloud.bigquery_reservation_v1.types.Reservation.ReplicationStatus): + Output only. The Disaster Recovery(DR) + replication status of the reservation. This is + only available for the primary replicas of + DR/failover reservations and provides + information about the both the staleness of the + secondary and the last error encountered while + trying to replicate changes from the primary to + the secondary. If this field is blank, it means + that the reservation is either not a DR + reservation or the reservation is a DR secondary + or that any replication operations on the + reservation have succeeded. + scheduling_policy (google.cloud.bigquery_reservation_v1.types.SchedulingPolicy): + Optional. The scheduling policy to use for + jobs and queries running under this reservation. + The scheduling policy controls how the + reservation's resources are distributed. + + This feature is not yet generally available. + """ + class ScalingMode(proto.Enum): + r"""The scaling mode for the reservation. This enum determines + how the reservation scales up and down. + + Values: + SCALING_MODE_UNSPECIFIED (0): + Default value of ScalingMode. + AUTOSCALE_ONLY (1): + The reservation will scale up only using slots from + autoscaling. It will not use any idle slots even if there + may be some available. The upper limit that autoscaling can + scale up to will be max_slots - baseline. For example, if + max_slots is 1000, baseline is 200 and customer sets + ScalingMode to AUTOSCALE_ONLY, then autoscalerg will scale + up to 800 slots and no idle slots will be used. + + Please note, in this mode, the ignore_idle_slots field must + be set to true. Otherwise the request will be rejected with + error code ``google.rpc.Code.INVALID_ARGUMENT``. + IDLE_SLOTS_ONLY (2): + The reservation will scale up using only idle slots + contributed by other reservations or from unassigned + commitments. If no idle slots are available it will not + scale up further. If the idle slots which it is using are + reclaimed by the contributing reservation(s) it may be + forced to scale down. The max idle slots the reservation can + be max_slots - baseline capacity. For example, if max_slots + is 1000, baseline is 200 and customer sets ScalingMode to + IDLE_SLOTS_ONLY, + + 1. if there are 1000 idle slots available in other + reservations, the reservation will scale up to 1000 slots + with 200 baseline and 800 idle slots. + 2. if there are 500 idle slots available in other + reservations, the reservation will scale up to 700 slots + with 200 baseline and 300 idle slots. Please note, in + this mode, the reservation might not be able to scale up + to max_slots. + + Please note, in this mode, the ignore_idle_slots field must + be set to false. Otherwise the request will be rejected with + error code ``google.rpc.Code.INVALID_ARGUMENT``. + ALL_SLOTS (3): + The reservation will scale up using all slots available to + it. It will use idle slots contributed by other reservations + or from unassigned commitments first. If no idle slots are + available it will scale up using autoscaling. For example, + if max_slots is 1000, baseline is 200 and customer sets + ScalingMode to ALL_SLOTS, + + 1. if there are 800 idle slots available in other + reservations, the reservation will scale up to 1000 slots + with 200 baseline and 800 idle slots. + 2. if there are 500 idle slots available in other + reservations, the reservation will scale up to 1000 slots + with 200 baseline, 500 idle slots and 300 autoscaling + slots. + 3. if there are no idle slots available in other + reservations, it will scale up to 1000 slots with 200 + baseline and 800 autoscaling slots. + + Please note, in this mode, the ignore_idle_slots field must + be set to false. Otherwise the request will be rejected with + error code ``google.rpc.Code.INVALID_ARGUMENT``. + """ + SCALING_MODE_UNSPECIFIED = 0 + AUTOSCALE_ONLY = 1 + IDLE_SLOTS_ONLY = 2 + ALL_SLOTS = 3 + + class Autoscale(proto.Message): + r"""Auto scaling settings. + + Attributes: + current_slots (int): + Output only. The slot capacity added to this reservation + when autoscale happens. Will be between [0, max_slots]. + Note: after users reduce max_slots, it may take a while + before it can be propagated, so current_slots may stay in + the original value and could be larger than max_slots for + that brief period (less than one minute) + max_slots (int): + Optional. Number of slots to be scaled when + needed. + """ + + current_slots: int = proto.Field( + proto.INT64, + number=1, + ) + max_slots: int = proto.Field( + proto.INT64, + number=2, + ) + + class ReplicationStatus(proto.Message): + r"""Disaster Recovery(DR) replication status of the reservation. + + Attributes: + error (google.rpc.status_pb2.Status): + Output only. The last error encountered while + trying to replicate changes from the primary to + the secondary. This field is only available if + the replication has not succeeded since. + last_error_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time at which the last error + was encountered while trying to replicate + changes from the primary to the secondary. This + field is only available if the replication has + not succeeded since. + last_replication_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. A timestamp corresponding to the + last change on the primary that was successfully + replicated to the secondary. + soft_failover_start_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time at which a soft + failover for the reservation and its associated + datasets was initiated. After this field is set, + all subsequent changes to the reservation will + be rejected unless a hard failover overrides + this operation. This field will be cleared once + the failover is complete. + """ + + error: status_pb2.Status = proto.Field( + proto.MESSAGE, + number=1, + message=status_pb2.Status, + ) + last_error_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=2, + message=timestamp_pb2.Timestamp, + ) + last_replication_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=3, + message=timestamp_pb2.Timestamp, + ) + soft_failover_start_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=4, + message=timestamp_pb2.Timestamp, + ) + + name: str = proto.Field( + proto.STRING, + number=1, + ) + slot_capacity: int = proto.Field( + proto.INT64, + number=2, + ) + ignore_idle_slots: bool = proto.Field( + proto.BOOL, + number=4, + ) + autoscale: Autoscale = proto.Field( + proto.MESSAGE, + number=7, + message=Autoscale, + ) + concurrency: int = proto.Field( + proto.INT64, + number=16, + ) + creation_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=8, + message=timestamp_pb2.Timestamp, + ) + update_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=9, + message=timestamp_pb2.Timestamp, + ) + multi_region_auxiliary: bool = proto.Field( + proto.BOOL, + number=14, + ) + edition: 'Edition' = proto.Field( + proto.ENUM, + number=17, + enum='Edition', + ) + primary_location: str = proto.Field( + proto.STRING, + number=18, + ) + secondary_location: str = proto.Field( + proto.STRING, + number=19, + ) + original_primary_location: str = proto.Field( + proto.STRING, + number=20, + ) + max_slots: int = proto.Field( + proto.INT64, + number=21, + optional=True, + ) + scaling_mode: ScalingMode = proto.Field( + proto.ENUM, + number=22, + enum=ScalingMode, + ) + labels: MutableMapping[str, str] = proto.MapField( + proto.STRING, + proto.STRING, + number=23, + ) + reservation_group: str = proto.Field( + proto.STRING, + number=25, + ) + replication_status: ReplicationStatus = proto.Field( + proto.MESSAGE, + number=24, + message=ReplicationStatus, + ) + scheduling_policy: 'SchedulingPolicy' = proto.Field( + proto.MESSAGE, + number=27, + message='SchedulingPolicy', + ) + + +class SchedulingPolicy(proto.Message): + r"""The scheduling policy controls how a reservation's resources + are distributed. + + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + concurrency (int): + Optional. If present and > 0, the reservation + will attempt to limit the concurrency of jobs + running for any particular project within it to + the given value. + + This feature is not yet generally available. + + This field is a member of `oneof`_ ``_concurrency``. + max_slots (int): + Optional. If present and > 0, the reservation + will attempt to limit the slot consumption of + queries running for any particular project + within it to the given value. + + This feature is not yet generally available. + + This field is a member of `oneof`_ ``_max_slots``. + """ + + concurrency: int = proto.Field( + proto.INT64, + number=1, + optional=True, + ) + max_slots: int = proto.Field( + proto.INT64, + number=2, + optional=True, + ) + + +class ReservationGroup(proto.Message): + r"""A reservation group is a container for reservations. + + Attributes: + name (str): + Identifier. The resource name of the reservation group, + e.g., + ``projects/*/locations/*/reservationGroups/team1-prod``. The + reservation_group_id must only contain lower case + alphanumeric characters or dashes. It must start with a + letter and must not end with a dash. Its maximum length is + 64 characters. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class CapacityCommitment(proto.Message): + r"""Capacity commitment is a way to purchase compute capacity for + BigQuery jobs (in the form of slots) with some committed period + of usage. Annual commitments renew by default. Commitments can + be removed after their commitment end time passes. + + In order to remove annual commitment, its plan needs to be + changed to monthly or flex first. + + A capacity commitment resource exists as a child resource of the + admin project. + + Attributes: + name (str): + Output only. The resource name of the capacity commitment, + e.g., + ``projects/myproject/locations/US/capacityCommitments/123`` + The commitment_id must only contain lower case alphanumeric + characters or dashes. It must start with a letter and must + not end with a dash. Its maximum length is 64 characters. + slot_count (int): + Optional. Number of slots in this commitment. + plan (google.cloud.bigquery_reservation_v1.types.CapacityCommitment.CommitmentPlan): + Optional. Capacity commitment commitment + plan. + state (google.cloud.bigquery_reservation_v1.types.CapacityCommitment.State): + Output only. State of the commitment. + commitment_start_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The start of the current commitment period. It + is applicable only for ACTIVE capacity commitments. Note + after the commitment is renewed, commitment_start_time won't + be changed. It refers to the start time of the original + commitment. + commitment_end_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The end of the current commitment period. It is + applicable only for ACTIVE capacity commitments. Note after + renewal, commitment_end_time is the time the renewed + commitment expires. So itwould be at a time after + commitment_start_time + committed period, because we don't + change commitment_start_time , + failure_status (google.rpc.status_pb2.Status): + Output only. For FAILED commitment plan, + provides the reason of failure. + renewal_plan (google.cloud.bigquery_reservation_v1.types.CapacityCommitment.CommitmentPlan): + Optional. The plan this capacity commitment is converted to + after commitment_end_time passes. Once the plan is changed, + committed period is extended according to commitment plan. + Only applicable for ANNUAL and TRIAL commitments. + multi_region_auxiliary (bool): + Applicable only for commitments located + within one of the BigQuery multi-regions (US or + EU). + + If set to true, this commitment is placed in the + organization's secondary region which is + designated for disaster recovery purposes. If + false, this commitment is placed in the + organization's default region. + + NOTE: this is a preview feature. Project must be + allow-listed in order to set this field. + edition (google.cloud.bigquery_reservation_v1.types.Edition): + Optional. Edition of the capacity commitment. + is_flat_rate (bool): + Output only. If true, the commitment is a + flat-rate commitment, otherwise, it's an edition + commitment. + """ + class CommitmentPlan(proto.Enum): + r"""Commitment plan defines the current committed period. + Capacity commitment cannot be deleted during it's committed + period. + + Values: + COMMITMENT_PLAN_UNSPECIFIED (0): + Invalid plan value. Requests with this value will be + rejected with error code + ``google.rpc.Code.INVALID_ARGUMENT``. + FLEX (3): + Flex commitments have committed period of 1 + minute after becoming ACTIVE. After that, they + are not in a committed period anymore and can be + removed any time. + FLEX_FLAT_RATE (7): + Same as FLEX, should only be used if + flat-rate commitments are still available. + TRIAL (5): + Trial commitments have a committed period of 182 days after + becoming ACTIVE. After that, they are converted to a new + commitment based on the ``renewal_plan``. Default + ``renewal_plan`` for Trial commitment is Flex so that it can + be deleted right after committed period ends. + MONTHLY (2): + Monthly commitments have a committed period + of 30 days after becoming ACTIVE. After that, + they are not in a committed period anymore and + can be removed any time. + MONTHLY_FLAT_RATE (8): + Same as MONTHLY, should only be used if + flat-rate commitments are still available. + ANNUAL (4): + Annual commitments have a committed period of 365 days after + becoming ACTIVE. After that they are converted to a new + commitment based on the renewal_plan. + ANNUAL_FLAT_RATE (9): + Same as ANNUAL, should only be used if + flat-rate commitments are still available. + THREE_YEAR (10): + 3-year commitments have a committed period of 1095(3 \* 365) + days after becoming ACTIVE. After that they are converted to + a new commitment based on the renewal_plan. + NONE (6): + Should only be used for ``renewal_plan`` and is only + meaningful if edition is specified to values other than + EDITION_UNSPECIFIED. Otherwise + CreateCapacityCommitmentRequest or + UpdateCapacityCommitmentRequest will be rejected with error + code ``google.rpc.Code.INVALID_ARGUMENT``. If the + renewal_plan is NONE, capacity commitment will be removed at + the end of its commitment period. + """ + COMMITMENT_PLAN_UNSPECIFIED = 0 + FLEX = 3 + FLEX_FLAT_RATE = 7 + TRIAL = 5 + MONTHLY = 2 + MONTHLY_FLAT_RATE = 8 + ANNUAL = 4 + ANNUAL_FLAT_RATE = 9 + THREE_YEAR = 10 + NONE = 6 + + class State(proto.Enum): + r"""Capacity commitment can either become ACTIVE right away or + transition from PENDING to ACTIVE or FAILED. + + Values: + STATE_UNSPECIFIED (0): + Invalid state value. + PENDING (1): + Capacity commitment is pending provisioning. Pending + capacity commitment does not contribute to the project's + slot_capacity. + ACTIVE (2): + Once slots are provisioned, capacity commitment becomes + active. slot_count is added to the project's slot_capacity. + FAILED (3): + Capacity commitment is failed to be activated + by the backend. + """ + STATE_UNSPECIFIED = 0 + PENDING = 1 + ACTIVE = 2 + FAILED = 3 + + name: str = proto.Field( + proto.STRING, + number=1, + ) + slot_count: int = proto.Field( + proto.INT64, + number=2, + ) + plan: CommitmentPlan = proto.Field( + proto.ENUM, + number=3, + enum=CommitmentPlan, + ) + state: State = proto.Field( + proto.ENUM, + number=4, + enum=State, + ) + commitment_start_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=9, + message=timestamp_pb2.Timestamp, + ) + commitment_end_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=5, + message=timestamp_pb2.Timestamp, + ) + failure_status: status_pb2.Status = proto.Field( + proto.MESSAGE, + number=7, + message=status_pb2.Status, + ) + renewal_plan: CommitmentPlan = proto.Field( + proto.ENUM, + number=8, + enum=CommitmentPlan, + ) + multi_region_auxiliary: bool = proto.Field( + proto.BOOL, + number=10, + ) + edition: 'Edition' = proto.Field( + proto.ENUM, + number=12, + enum='Edition', + ) + is_flat_rate: bool = proto.Field( + proto.BOOL, + number=14, + ) + + +class CreateReservationRequest(proto.Message): + r"""The request for + [ReservationService.CreateReservation][google.cloud.bigquery.reservation.v1.ReservationService.CreateReservation]. + + Attributes: + parent (str): + Required. Project, location. E.g., + ``projects/myproject/locations/US`` + reservation_id (str): + The reservation ID. It must only contain + lower case alphanumeric characters or dashes. It + must start with a letter and must not end with a + dash. Its maximum length is 64 characters. + reservation (google.cloud.bigquery_reservation_v1.types.Reservation): + Definition of the new reservation to create. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + reservation_id: str = proto.Field( + proto.STRING, + number=2, + ) + reservation: 'Reservation' = proto.Field( + proto.MESSAGE, + number=3, + message='Reservation', + ) + + +class ListReservationsRequest(proto.Message): + r"""The request for + [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations]. + + Attributes: + parent (str): + Required. The parent resource name containing project and + location, e.g.: ``projects/myproject/locations/US`` + page_size (int): + The maximum number of items to return per + page. + 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 ListReservationsResponse(proto.Message): + r"""The response for + [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations]. + + Attributes: + reservations (MutableSequence[google.cloud.bigquery_reservation_v1.types.Reservation]): + List of reservations visible to the user. + next_page_token (str): + Token to retrieve the next page of results, + or empty if there are no more results in the + list. + """ + + @property + def raw_page(self): + return self + + reservations: MutableSequence['Reservation'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='Reservation', + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class GetReservationRequest(proto.Message): + r"""The request for + [ReservationService.GetReservation][google.cloud.bigquery.reservation.v1.ReservationService.GetReservation]. + + Attributes: + name (str): + Required. Resource name of the reservation to retrieve. + E.g., + ``projects/myproject/locations/US/reservations/team1-prod`` + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class DeleteReservationRequest(proto.Message): + r"""The request for + [ReservationService.DeleteReservation][google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservation]. + + Attributes: + name (str): + Required. Resource name of the reservation to retrieve. + E.g., + ``projects/myproject/locations/US/reservations/team1-prod`` + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class UpdateReservationRequest(proto.Message): + r"""The request for + [ReservationService.UpdateReservation][google.cloud.bigquery.reservation.v1.ReservationService.UpdateReservation]. + + Attributes: + reservation (google.cloud.bigquery_reservation_v1.types.Reservation): + Content of the reservation to update. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Standard field mask for the set of fields to + be updated. + """ + + reservation: 'Reservation' = proto.Field( + proto.MESSAGE, + number=1, + message='Reservation', + ) + update_mask: field_mask_pb2.FieldMask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + + +class FailoverReservationRequest(proto.Message): + r"""The request for ReservationService.FailoverReservation. + + Attributes: + name (str): + Required. Resource name of the reservation to failover. + E.g., + ``projects/myproject/locations/US/reservations/team1-prod`` + failover_mode (google.cloud.bigquery_reservation_v1.types.FailoverMode): + Optional. A parameter that determines how + writes that are pending replication are handled + after a failover is initiated. If not specified, + HARD failover mode is used by default. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + failover_mode: 'FailoverMode' = proto.Field( + proto.ENUM, + number=2, + enum='FailoverMode', + ) + + +class CreateReservationGroupRequest(proto.Message): + r"""The request for + [ReservationService.CreateReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.CreateReservationGroup]. + + Attributes: + parent (str): + Required. Project, location. E.g., + ``projects/myproject/locations/US`` + reservation_group_id (str): + Required. The reservation group ID. It must + only contain lower case alphanumeric characters + or dashes. It must start with a letter and must + not end with a dash. Its maximum length is 64 + characters. + reservation_group (google.cloud.bigquery_reservation_v1.types.ReservationGroup): + Required. New Reservation Group to create. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + reservation_group_id: str = proto.Field( + proto.STRING, + number=2, + ) + reservation_group: 'ReservationGroup' = proto.Field( + proto.MESSAGE, + number=3, + message='ReservationGroup', + ) + + +class GetReservationGroupRequest(proto.Message): + r"""The request for + [ReservationService.GetReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.GetReservationGroup]. + + Attributes: + name (str): + Required. Resource name of the reservation group to + retrieve. E.g., + ``projects/myproject/locations/US/reservationGroups/team1-prod`` + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class ListReservationGroupsRequest(proto.Message): + r"""The request for + [ReservationService.ListReservationGroups][google.cloud.bigquery.reservation.v1.ReservationService.ListReservationGroups]. + + Attributes: + parent (str): + Required. The parent resource name containing project and + location, e.g.: ``projects/myproject/locations/US`` + page_size (int): + The maximum number of items to return per + page. + 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 ListReservationGroupsResponse(proto.Message): + r"""The response for + [ReservationService.ListReservationGroups][google.cloud.bigquery.reservation.v1.ReservationService.ListReservationGroups]. + + Attributes: + reservation_groups (MutableSequence[google.cloud.bigquery_reservation_v1.types.ReservationGroup]): + List of reservations visible to the user. + next_page_token (str): + Token to retrieve the next page of results, + or empty if there are no more results in the + list. + """ + + @property + def raw_page(self): + return self + + reservation_groups: MutableSequence['ReservationGroup'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='ReservationGroup', + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class DeleteReservationGroupRequest(proto.Message): + r"""The request for + [ReservationService.DeleteReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservationGroup]. + + Attributes: + name (str): + Required. Resource name of the reservation group to + retrieve. E.g., + ``projects/myproject/locations/US/reservationGroups/team1-prod`` + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class CreateCapacityCommitmentRequest(proto.Message): + r"""The request for + [ReservationService.CreateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.CreateCapacityCommitment]. + + Attributes: + parent (str): + Required. Resource name of the parent reservation. E.g., + ``projects/myproject/locations/US`` + capacity_commitment (google.cloud.bigquery_reservation_v1.types.CapacityCommitment): + Content of the capacity commitment to create. + enforce_single_admin_project_per_org (bool): + If true, fail the request if another project + in the organization has a capacity commitment. + capacity_commitment_id (str): + The optional capacity commitment ID. Capacity + commitment name will be generated automatically + if this field is empty. This field must only + contain lower case alphanumeric characters or + dashes. The first and last character cannot be a + dash. Max length is 64 characters. NOTE: this ID + won't be kept if the capacity commitment is + split or merged. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + capacity_commitment: 'CapacityCommitment' = proto.Field( + proto.MESSAGE, + number=2, + message='CapacityCommitment', + ) + enforce_single_admin_project_per_org: bool = proto.Field( + proto.BOOL, + number=4, + ) + capacity_commitment_id: str = proto.Field( + proto.STRING, + number=5, + ) + + +class ListCapacityCommitmentsRequest(proto.Message): + r"""The request for + [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments]. + + Attributes: + parent (str): + Required. Resource name of the parent reservation. E.g., + ``projects/myproject/locations/US`` + 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 ListCapacityCommitmentsResponse(proto.Message): + r"""The response for + [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments]. + + Attributes: + capacity_commitments (MutableSequence[google.cloud.bigquery_reservation_v1.types.CapacityCommitment]): + List of capacity commitments visible to the + user. + next_page_token (str): + Token to retrieve the next page of results, + or empty if there are no more results in the + list. + """ + + @property + def raw_page(self): + return self + + capacity_commitments: MutableSequence['CapacityCommitment'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='CapacityCommitment', + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class GetCapacityCommitmentRequest(proto.Message): + r"""The request for + [ReservationService.GetCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitment]. + + Attributes: + name (str): + Required. Resource name of the capacity commitment to + retrieve. E.g., + ``projects/myproject/locations/US/capacityCommitments/123`` + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class DeleteCapacityCommitmentRequest(proto.Message): + r"""The request for + [ReservationService.DeleteCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteCapacityCommitment]. + + Attributes: + name (str): + Required. Resource name of the capacity commitment to + delete. E.g., + ``projects/myproject/locations/US/capacityCommitments/123`` + force (bool): + Can be used to force delete commitments even + if assignments exist. Deleting commitments with + assignments may cause queries to fail if they no + longer have access to slots. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + force: bool = proto.Field( + proto.BOOL, + number=3, + ) + + +class UpdateCapacityCommitmentRequest(proto.Message): + r"""The request for + [ReservationService.UpdateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateCapacityCommitment]. + + Attributes: + capacity_commitment (google.cloud.bigquery_reservation_v1.types.CapacityCommitment): + Content of the capacity commitment to update. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Standard field mask for the set of fields to + be updated. + """ + + capacity_commitment: 'CapacityCommitment' = proto.Field( + proto.MESSAGE, + number=1, + message='CapacityCommitment', + ) + update_mask: field_mask_pb2.FieldMask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + + +class SplitCapacityCommitmentRequest(proto.Message): + r"""The request for + [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment]. + + Attributes: + name (str): + Required. The resource name e.g.,: + ``projects/myproject/locations/US/capacityCommitments/123`` + slot_count (int): + Number of slots in the capacity commitment + after the split. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + slot_count: int = proto.Field( + proto.INT64, + number=2, + ) + + +class SplitCapacityCommitmentResponse(proto.Message): + r"""The response for + [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment]. + + Attributes: + first (google.cloud.bigquery_reservation_v1.types.CapacityCommitment): + First capacity commitment, result of a split. + second (google.cloud.bigquery_reservation_v1.types.CapacityCommitment): + Second capacity commitment, result of a + split. + """ + + first: 'CapacityCommitment' = proto.Field( + proto.MESSAGE, + number=1, + message='CapacityCommitment', + ) + second: 'CapacityCommitment' = proto.Field( + proto.MESSAGE, + number=2, + message='CapacityCommitment', + ) + + +class MergeCapacityCommitmentsRequest(proto.Message): + r"""The request for + [ReservationService.MergeCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.MergeCapacityCommitments]. + + Attributes: + parent (str): + Parent resource that identifies admin project and location + e.g., ``projects/myproject/locations/us`` + capacity_commitment_ids (MutableSequence[str]): + Ids of capacity commitments to merge. + These capacity commitments must exist under + admin project and location specified in the + parent. + ID is the last portion of capacity commitment + name e.g., 'abc' for + projects/myproject/locations/US/capacityCommitments/abc + capacity_commitment_id (str): + Optional. The optional resulting capacity + commitment ID. Capacity commitment name will be + generated automatically if this field is empty. + This field must only contain lower case + alphanumeric characters or dashes. The first and + last character cannot be a dash. Max length is + 64 characters. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + capacity_commitment_ids: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=2, + ) + capacity_commitment_id: str = proto.Field( + proto.STRING, + number=3, + ) + + +class Assignment(proto.Message): + r"""An assignment allows a project to submit jobs + of a certain type using slots from the specified reservation. + + Attributes: + name (str): + Output only. Name of the resource. E.g.: + ``projects/myproject/locations/US/reservations/team1-prod/assignments/123``. + The assignment_id must only contain lower case alphanumeric + characters or dashes and the max length is 64 characters. + assignee (str): + Optional. The resource which will use the reservation. E.g. + ``projects/myproject``, ``folders/123``, or + ``organizations/456``. + job_type (google.cloud.bigquery_reservation_v1.types.Assignment.JobType): + Optional. Which type of jobs will use the + reservation. + state (google.cloud.bigquery_reservation_v1.types.Assignment.State): + Output only. State of the assignment. + enable_gemini_in_bigquery (bool): + Optional. This field controls if "Gemini in BigQuery" + (https://cloud.google.com/gemini/docs/bigquery/overview) + features should be enabled for this reservation assignment, + which is not on by default. "Gemini in BigQuery" has a + distinct compliance posture from BigQuery. If this field is + set to true, the assignment job type is QUERY, and the + parent reservation edition is ENTERPRISE_PLUS, then the + assignment will give the grantee project/organization access + to "Gemini in BigQuery" features. + scheduling_policy (google.cloud.bigquery_reservation_v1.types.SchedulingPolicy): + Optional. The scheduling policy to use for + jobs and queries of this assignee when running + under the associated reservation. The scheduling + policy controls how the reservation's resources + are distributed. This overrides the default + scheduling policy specified on the reservation. + + This feature is not yet generally available. + """ + class JobType(proto.Enum): + r"""Types of job, which could be specified when using the + reservation. + + Values: + JOB_TYPE_UNSPECIFIED (0): + Invalid type. Requests with this value will be rejected with + error code ``google.rpc.Code.INVALID_ARGUMENT``. + PIPELINE (1): + Pipeline (load/export) jobs from the project + will use the reservation. + QUERY (2): + Query jobs from the project will use the + reservation. + ML_EXTERNAL (3): + BigQuery ML jobs that use services external + to BigQuery for model training. These jobs will + not utilize idle slots from other reservations. + BACKGROUND (4): + Background jobs that BigQuery runs for the + customers in the background. + CONTINUOUS (6): + Continuous SQL jobs will use this + reservation. Reservations with continuous + assignments cannot be mixed with non-continuous + assignments. + BACKGROUND_CHANGE_DATA_CAPTURE (7): + Finer granularity background jobs for + capturing changes in a source database and + streaming them into BigQuery. Reservations with + this job type take priority over a default + BACKGROUND reservation assignment (if it + exists). + BACKGROUND_COLUMN_METADATA_INDEX (8): + Finer granularity background jobs for + refreshing cached metadata for BigQuery tables. + Reservations with this job type take priority + over a default BACKGROUND reservation assignment + (if it exists). + BACKGROUND_SEARCH_INDEX_REFRESH (9): + Finer granularity background jobs for + refreshing search indexes upon BigQuery table + columns. Reservations with this job type take + priority over a default BACKGROUND reservation + assignment (if it exists). + """ + JOB_TYPE_UNSPECIFIED = 0 + PIPELINE = 1 + QUERY = 2 + ML_EXTERNAL = 3 + BACKGROUND = 4 + CONTINUOUS = 6 + BACKGROUND_CHANGE_DATA_CAPTURE = 7 + BACKGROUND_COLUMN_METADATA_INDEX = 8 + BACKGROUND_SEARCH_INDEX_REFRESH = 9 + + class State(proto.Enum): + r"""Assignment will remain in PENDING state if no active capacity + commitment is present. It will become ACTIVE when some capacity + commitment becomes active. + + Values: + STATE_UNSPECIFIED (0): + Invalid state value. + PENDING (1): + Queries from assignee will be executed as + on-demand, if related assignment is pending. + ACTIVE (2): + Assignment is ready. + """ + STATE_UNSPECIFIED = 0 + PENDING = 1 + ACTIVE = 2 + + name: str = proto.Field( + proto.STRING, + number=1, + ) + assignee: str = proto.Field( + proto.STRING, + number=4, + ) + job_type: JobType = proto.Field( + proto.ENUM, + number=3, + enum=JobType, + ) + state: State = proto.Field( + proto.ENUM, + number=6, + enum=State, + ) + enable_gemini_in_bigquery: bool = proto.Field( + proto.BOOL, + number=10, + ) + scheduling_policy: 'SchedulingPolicy' = proto.Field( + proto.MESSAGE, + number=11, + message='SchedulingPolicy', + ) + + +class CreateAssignmentRequest(proto.Message): + r"""The request for + [ReservationService.CreateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.CreateAssignment]. + Note: "bigquery.reservationAssignments.create" permission is + required on the related assignee. + + Attributes: + parent (str): + Required. The parent resource name of the assignment E.g. + ``projects/myproject/locations/US/reservations/team1-prod`` + assignment (google.cloud.bigquery_reservation_v1.types.Assignment): + Assignment resource to create. + assignment_id (str): + The optional assignment ID. Assignment name + will be generated automatically if this field is + empty. This field must only contain lower case + alphanumeric characters or dashes. Max length is + 64 characters. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + assignment: 'Assignment' = proto.Field( + proto.MESSAGE, + number=2, + message='Assignment', + ) + assignment_id: str = proto.Field( + proto.STRING, + number=4, + ) + + +class ListAssignmentsRequest(proto.Message): + r"""The request for + [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments]. + + Attributes: + parent (str): + Required. The parent resource name e.g.: + + ``projects/myproject/locations/US/reservations/team1-prod`` + + Or: + + ``projects/myproject/locations/US/reservations/-`` + page_size (int): + The maximum number of items to return per + page. + 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 ListAssignmentsResponse(proto.Message): + r"""The response for + [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments]. + + Attributes: + assignments (MutableSequence[google.cloud.bigquery_reservation_v1.types.Assignment]): + List of assignments visible to the user. + next_page_token (str): + Token to retrieve the next page of results, + or empty if there are no more results in the + list. + """ + + @property + def raw_page(self): + return self + + assignments: MutableSequence['Assignment'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='Assignment', + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class DeleteAssignmentRequest(proto.Message): + r"""The request for + [ReservationService.DeleteAssignment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteAssignment]. + Note: "bigquery.reservationAssignments.delete" permission is + required on the related assignee. + + Attributes: + name (str): + Required. Name of the resource, e.g. + ``projects/myproject/locations/US/reservations/team1-prod/assignments/123`` + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class SearchAssignmentsRequest(proto.Message): + r"""The request for + [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. + Note: "bigquery.reservationAssignments.search" permission is + required on the related assignee. + + Attributes: + parent (str): + Required. The resource name of the admin project(containing + project and location), e.g.: + ``projects/myproject/locations/US``. + query (str): + Please specify resource name as assignee in the query. + + Examples: + + - ``assignee=projects/myproject`` + - ``assignee=folders/123`` + - ``assignee=organizations/456`` + page_size (int): + The maximum number of items to return per + page. + page_token (str): + The next_page_token value returned from a previous List + request, if any. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + query: str = proto.Field( + proto.STRING, + number=2, + ) + page_size: int = proto.Field( + proto.INT32, + number=3, + ) + page_token: str = proto.Field( + proto.STRING, + number=4, + ) + + +class SearchAllAssignmentsRequest(proto.Message): + r"""The request for + [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. + Note: "bigquery.reservationAssignments.search" permission is + required on the related assignee. + + Attributes: + parent (str): + Required. The resource name with location (project name + could be the wildcard '-'), e.g.: + ``projects/-/locations/US``. + query (str): + Please specify resource name as assignee in the query. + + Examples: + + - ``assignee=projects/myproject`` + - ``assignee=folders/123`` + - ``assignee=organizations/456`` + page_size (int): + The maximum number of items to return per + page. + page_token (str): + The next_page_token value returned from a previous List + request, if any. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + query: str = proto.Field( + proto.STRING, + number=2, + ) + page_size: int = proto.Field( + proto.INT32, + number=3, + ) + page_token: str = proto.Field( + proto.STRING, + number=4, + ) + + +class SearchAssignmentsResponse(proto.Message): + r"""The response for + [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. + + Attributes: + assignments (MutableSequence[google.cloud.bigquery_reservation_v1.types.Assignment]): + List of assignments visible to the user. + next_page_token (str): + Token to retrieve the next page of results, + or empty if there are no more results in the + list. + """ + + @property + def raw_page(self): + return self + + assignments: MutableSequence['Assignment'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='Assignment', + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class SearchAllAssignmentsResponse(proto.Message): + r"""The response for + [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. + + Attributes: + assignments (MutableSequence[google.cloud.bigquery_reservation_v1.types.Assignment]): + List of assignments visible to the user. + next_page_token (str): + Token to retrieve the next page of results, + or empty if there are no more results in the + list. + """ + + @property + def raw_page(self): + return self + + assignments: MutableSequence['Assignment'] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='Assignment', + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class MoveAssignmentRequest(proto.Message): + r"""The request for + [ReservationService.MoveAssignment][google.cloud.bigquery.reservation.v1.ReservationService.MoveAssignment]. + + **Note**: "bigquery.reservationAssignments.create" permission is + required on the destination_id. + + **Note**: "bigquery.reservationAssignments.create" and + "bigquery.reservationAssignments.delete" permission are required on + the related assignee. + + Attributes: + name (str): + Required. The resource name of the assignment, e.g. + ``projects/myproject/locations/US/reservations/team1-prod/assignments/123`` + destination_id (str): + The new reservation ID, e.g.: + ``projects/myotherproject/locations/US/reservations/team2-prod`` + assignment_id (str): + The optional assignment ID. A new assignment + name is generated if this field is empty. + + This field can contain only lowercase + alphanumeric characters or dashes. Max length is + 64 characters. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + destination_id: str = proto.Field( + proto.STRING, + number=3, + ) + assignment_id: str = proto.Field( + proto.STRING, + number=5, + ) + + +class UpdateAssignmentRequest(proto.Message): + r"""The request for + [ReservationService.UpdateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateAssignment]. + + Attributes: + assignment (google.cloud.bigquery_reservation_v1.types.Assignment): + Content of the assignment to update. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Standard field mask for the set of fields to + be updated. + """ + + assignment: 'Assignment' = proto.Field( + proto.MESSAGE, + number=1, + message='Assignment', + ) + update_mask: field_mask_pb2.FieldMask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + + +class TableReference(proto.Message): + r"""Fully qualified reference to BigQuery table. + Internally stored as google.cloud.bi.v1.BqTableReference. + + Attributes: + project_id (str): + Optional. The assigned project ID of the + project. + dataset_id (str): + Optional. The ID of the dataset in the above + project. + table_id (str): + Optional. The ID of the table in the above + dataset. + """ + + project_id: str = proto.Field( + proto.STRING, + number=1, + ) + dataset_id: str = proto.Field( + proto.STRING, + number=2, + ) + table_id: str = proto.Field( + proto.STRING, + number=3, + ) + + +class BiReservation(proto.Message): + r"""Represents a BI Reservation. + + Attributes: + name (str): + Identifier. The resource name of the singleton BI + reservation. Reservation names have the form + ``projects/{project_id}/locations/{location_id}/biReservation``. + update_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The last update timestamp of a + reservation. + size (int): + Optional. Size of a reservation, in bytes. + preferred_tables (MutableSequence[google.cloud.bigquery_reservation_v1.types.TableReference]): + Optional. Preferred tables to use BI capacity + for. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + update_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=3, + message=timestamp_pb2.Timestamp, + ) + size: int = proto.Field( + proto.INT64, + number=4, + ) + preferred_tables: MutableSequence['TableReference'] = proto.RepeatedField( + proto.MESSAGE, + number=5, + message='TableReference', + ) + + +class GetBiReservationRequest(proto.Message): + r"""A request to get a singleton BI reservation. + + Attributes: + name (str): + Required. Name of the requested reservation, for example: + ``projects/{project_id}/locations/{location_id}/biReservation`` + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class UpdateBiReservationRequest(proto.Message): + r"""A request to update a BI reservation. + + Attributes: + bi_reservation (google.cloud.bigquery_reservation_v1.types.BiReservation): + A reservation to update. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + A list of fields to be updated in this + request. + """ + + bi_reservation: 'BiReservation' = proto.Field( + proto.MESSAGE, + number=1, + message='BiReservation', + ) + update_mask: field_mask_pb2.FieldMask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/mypy.ini b/owl-bot-staging/google-cloud-bigquery-reservation/v1/mypy.ini new file mode 100644 index 000000000000..574c5aed394b --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/mypy.ini @@ -0,0 +1,3 @@ +[mypy] +python_version = 3.7 +namespace_packages = True diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/noxfile.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/noxfile.py new file mode 100644 index 000000000000..b3e9bbfd0e5c --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/noxfile.py @@ -0,0 +1,591 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 re +import shutil + +from typing import Dict, List +import warnings + +import nox + +BLACK_VERSION = "black[jupyter]==23.7.0" +ISORT_VERSION = "isort==5.11.0" + +LINT_PATHS = ["docs", "google", "tests", "noxfile.py", "setup.py"] + +ALL_PYTHON = [ + "3.7", + "3.8", + "3.9", + "3.10", + "3.11", + "3.12", + "3.13", +] + +DEFAULT_PYTHON_VERSION = ALL_PYTHON[-1] + +CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() + +LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" +PACKAGE_NAME = "google-cloud-bigquery-reservation" + +UNIT_TEST_STANDARD_DEPENDENCIES = [ + "mock", + "asyncmock", + "pytest", + "pytest-cov", + "pytest-asyncio", +] +UNIT_TEST_EXTERNAL_DEPENDENCIES: List[str] = [] +UNIT_TEST_LOCAL_DEPENDENCIES: List[str] = [] +UNIT_TEST_DEPENDENCIES: List[str] = [] +UNIT_TEST_EXTRAS: List[str] = [] +UNIT_TEST_EXTRAS_BY_PYTHON: Dict[str, List[str]] = {} + +SYSTEM_TEST_PYTHON_VERSIONS: List[str] = ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"] +SYSTEM_TEST_STANDARD_DEPENDENCIES = [ + "mock", + "pytest", + "google-cloud-testutils", +] +SYSTEM_TEST_EXTERNAL_DEPENDENCIES: List[str] = [] +SYSTEM_TEST_LOCAL_DEPENDENCIES: List[str] = [] +SYSTEM_TEST_DEPENDENCIES: List[str] = [] +SYSTEM_TEST_EXTRAS: List[str] = [] +SYSTEM_TEST_EXTRAS_BY_PYTHON: Dict[str, List[str]] = {} + +nox.options.sessions = [ + "unit", + "system", + "cover", + "lint", + "lint_setup_py", + "blacken", + "docs", +] + +# Error if a python version is missing +nox.options.error_on_missing_interpreters = True + + +@nox.session(python=ALL_PYTHON) +def mypy(session): + """Run the type checker.""" + session.install( + # TODO(https://github.com/googleapis/gapic-generator-python/issues/2410): Use the latest version of mypy + "mypy<1.16.0", + "types-requests", + "types-protobuf", + ) + session.install(".") + session.run( + "mypy", + "-p", + "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 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", + *LINT_PATHS, + ) + + session.run("flake8", "google", "tests") + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def blacken(session): + """Run black. Format code to uniform standard.""" + session.install(BLACK_VERSION) + session.run( + "black", + *LINT_PATHS, + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def format(session): + """ + Run isort to sort imports. Then run black + to format code to uniform standard. + """ + session.install(BLACK_VERSION, ISORT_VERSION) + # Use the --fss option to sort imports using strict alphabetical order. + # See https://pycqa.github.io/isort/docs/configuration/options.html#force-sort-within-sections + session.run( + "isort", + "--fss", + *LINT_PATHS, + ) + session.run( + "black", + *LINT_PATHS, + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint_setup_py(session): + """Verify that setup.py is valid (including RST check).""" + session.install("setuptools", "docutils", "pygments") + session.run("python", "setup.py", "check", "--restructuredtext", "--strict") + + +def install_unittest_dependencies(session, *constraints): + standard_deps = UNIT_TEST_STANDARD_DEPENDENCIES + UNIT_TEST_DEPENDENCIES + session.install(*standard_deps, *constraints) + + if UNIT_TEST_EXTERNAL_DEPENDENCIES: + warnings.warn( + "'unit_test_external_dependencies' is deprecated. Instead, please " + "use 'unit_test_dependencies' or 'unit_test_local_dependencies'.", + DeprecationWarning, + ) + session.install(*UNIT_TEST_EXTERNAL_DEPENDENCIES, *constraints) + + if UNIT_TEST_LOCAL_DEPENDENCIES: + session.install(*UNIT_TEST_LOCAL_DEPENDENCIES, *constraints) + + if UNIT_TEST_EXTRAS_BY_PYTHON: + extras = UNIT_TEST_EXTRAS_BY_PYTHON.get(session.python, []) + elif UNIT_TEST_EXTRAS: + extras = UNIT_TEST_EXTRAS + else: + extras = [] + + if extras: + session.install("-e", f".[{','.join(extras)}]", *constraints) + else: + session.install("-e", ".", *constraints) + + +@nox.session(python=ALL_PYTHON) +@nox.parametrize( + "protobuf_implementation", + ["python", "upb", "cpp"], +) +def unit(session, protobuf_implementation): + # Install all test dependencies, then install this package in-place. + + if protobuf_implementation == "cpp" and session.python in ("3.11", "3.12", "3.13"): + session.skip("cpp implementation is not supported in python 3.11+") + + constraints_path = str( + CURRENT_DIRECTORY / "testing" / f"constraints-{session.python}.txt" + ) + install_unittest_dependencies(session, "-c", constraints_path) + + # TODO(https://github.com/googleapis/synthtool/issues/1976): + # Remove the 'cpp' implementation once support for Protobuf 3.x is dropped. + # The 'cpp' implementation requires Protobuf<4. + if protobuf_implementation == "cpp": + session.install("protobuf<4") + + # Run py.test against the unit tests. + session.run( + "py.test", + "--quiet", + f"--junitxml=unit_{session.python}_sponge_log.xml", + "--cov=google", + "--cov=tests/unit", + "--cov-append", + "--cov-config=.coveragerc", + "--cov-report=", + "--cov-fail-under=0", + os.path.join("tests", "unit"), + *session.posargs, + env={ + "PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION": protobuf_implementation, + }, + ) + + +def install_systemtest_dependencies(session, *constraints): + session.install("--pre", "grpcio") + + session.install(*SYSTEM_TEST_STANDARD_DEPENDENCIES, *constraints) + + if SYSTEM_TEST_EXTERNAL_DEPENDENCIES: + session.install(*SYSTEM_TEST_EXTERNAL_DEPENDENCIES, *constraints) + + if SYSTEM_TEST_LOCAL_DEPENDENCIES: + session.install("-e", *SYSTEM_TEST_LOCAL_DEPENDENCIES, *constraints) + + if SYSTEM_TEST_DEPENDENCIES: + session.install("-e", *SYSTEM_TEST_DEPENDENCIES, *constraints) + + if SYSTEM_TEST_EXTRAS_BY_PYTHON: + extras = SYSTEM_TEST_EXTRAS_BY_PYTHON.get(session.python, []) + elif SYSTEM_TEST_EXTRAS: + extras = SYSTEM_TEST_EXTRAS + else: + extras = [] + + if extras: + session.install("-e", f".[{','.join(extras)}]", *constraints) + else: + session.install("-e", ".", *constraints) + + +@nox.session(python=SYSTEM_TEST_PYTHON_VERSIONS) +def system(session): + """Run the system test suite.""" + constraints_path = str( + CURRENT_DIRECTORY / "testing" / f"constraints-{session.python}.txt" + ) + system_test_path = os.path.join("tests", "system.py") + system_test_folder_path = os.path.join("tests", "system") + + # Check the value of `RUN_SYSTEM_TESTS` env var. It defaults to true. + if os.environ.get("RUN_SYSTEM_TESTS", "true") == "false": + session.skip("RUN_SYSTEM_TESTS is set to false, skipping") + # Install pyopenssl for mTLS testing. + if os.environ.get("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") == "true": + session.install("pyopenssl") + + system_test_exists = os.path.exists(system_test_path) + system_test_folder_exists = os.path.exists(system_test_folder_path) + # Sanity check: only run tests if found. + if not system_test_exists and not system_test_folder_exists: + session.skip("System tests were not found") + + install_systemtest_dependencies(session, "-c", constraints_path) + + # Run py.test against the system tests. + if system_test_exists: + session.run( + "py.test", + "--quiet", + f"--junitxml=system_{session.python}_sponge_log.xml", + system_test_path, + *session.posargs, + ) + if system_test_folder_exists: + session.run( + "py.test", + "--quiet", + f"--junitxml=system_{session.python}_sponge_log.xml", + system_test_folder_path, + *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="3.10") +def docs(session): + """Build the docs for this library.""" + + session.install("-e", ".") + session.install( + # We need to pin to specific versions of the `sphinxcontrib-*` packages + # which still support sphinx 4.x. + # See https://github.com/googleapis/sphinx-docfx-yaml/issues/344 + # and https://github.com/googleapis/sphinx-docfx-yaml/issues/345. + "sphinxcontrib-applehelp==1.0.4", + "sphinxcontrib-devhelp==1.0.2", + "sphinxcontrib-htmlhelp==2.0.1", + "sphinxcontrib-qthelp==1.0.3", + "sphinxcontrib-serializinghtml==1.1.5", + "sphinx==4.5.0", + "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", # builder + "-d", os.path.join("docs", "_build", "doctrees", ""), # cache directory + # paths to build: + os.path.join("docs", ""), + os.path.join("docs", "_build", "html", ""), + ) + + +@nox.session(python="3.10") +def docfx(session): + """Build the docfx yaml files for this library.""" + + session.install("-e", ".") + session.install( + # We need to pin to specific versions of the `sphinxcontrib-*` packages + # which still support sphinx 4.x. + # See https://github.com/googleapis/sphinx-docfx-yaml/issues/344 + # and https://github.com/googleapis/sphinx-docfx-yaml/issues/345. + "sphinxcontrib-applehelp==1.0.4", + "sphinxcontrib-devhelp==1.0.2", + "sphinxcontrib-htmlhelp==2.0.1", + "sphinxcontrib-qthelp==1.0.3", + "sphinxcontrib-serializinghtml==1.1.5", + "gcp-sphinx-docfx-yaml", + "alabaster", + "recommonmark", + ) + + shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) + session.run( + "sphinx-build", + "-T", # show full traceback on exception + "-N", # no colors + "-D", + ( + "extensions=sphinx.ext.autodoc," + "sphinx.ext.autosummary," + "docfx_yaml.extension," + "sphinx.ext.intersphinx," + "sphinx.ext.coverage," + "sphinx.ext.napoleon," + "sphinx.ext.todo," + "sphinx.ext.viewcode," + "recommonmark" + ), + "-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) +@nox.parametrize( + "protobuf_implementation", + ["python", "upb", "cpp"], +) +def prerelease_deps(session, protobuf_implementation): + """ + Run all tests with pre-release versions of dependencies installed + rather than the standard non pre-release versions. + Pre-release versions can be installed using + `pip install --pre `. + """ + + if protobuf_implementation == "cpp" and session.python in ("3.11", "3.12", "3.13"): + session.skip("cpp implementation is not supported in python 3.11+") + + # Install all dependencies + session.install("-e", ".") + + # Install dependencies for the unit test environment + unit_deps_all = UNIT_TEST_STANDARD_DEPENDENCIES + UNIT_TEST_EXTERNAL_DEPENDENCIES + session.install(*unit_deps_all) + + # Install dependencies for the system test environment + system_deps_all = ( + SYSTEM_TEST_STANDARD_DEPENDENCIES + + SYSTEM_TEST_EXTERNAL_DEPENDENCIES + + SYSTEM_TEST_EXTRAS + ) + session.install(*system_deps_all) + + # Because we test minimum dependency versions on the minimum Python + # version, the first version we test with in the unit tests sessions has a + # constraints file containing all dependencies and extras. + with open( + CURRENT_DIRECTORY / "testing" / f"constraints-{ALL_PYTHON[0]}.txt", + encoding="utf-8", + ) as constraints_file: + constraints_text = constraints_file.read() + + # Ignore leading whitespace and comment lines. + constraints_deps = [ + match.group(1) + for match in re.finditer( + r"^\s*(\S+)(?===\S+)", constraints_text, flags=re.MULTILINE + ) + ] + + # Install dependencies specified in `testing/constraints-X.txt`. + session.install(*constraints_deps) + + # Note: If a dependency is added to the `prerel_deps` list, + # the `core_dependencies_from_source` list in the `core_deps_from_source` + # nox session should also be updated. + prerel_deps = [ + "googleapis-common-protos", + "google-api-core", + "google-auth", + "grpc-google-iam-v1", + "grpcio", + "grpcio-status", + "protobuf", + "proto-plus", + ] + + for dep in prerel_deps: + session.install("--pre", "--no-deps", "--ignore-installed", dep) + # TODO(https://github.com/grpc/grpc/issues/38965): Add `grpcio-status`` + # to the dictionary below once this bug is fixed. + # TODO(https://github.com/googleapis/google-cloud-python/issues/13643): Add + # `googleapis-common-protos` and `grpc-google-iam-v1` to the dictionary below + # once this bug is fixed. + package_namespaces = { + "google-api-core": "google.api_core", + "google-auth": "google.auth", + "grpcio": "grpc", + "protobuf": "google.protobuf", + "proto-plus": "proto", + } + + version_namespace = package_namespaces.get(dep) + + print(f"Installed {dep}") + if version_namespace: + session.run( + "python", + "-c", + f"import {version_namespace}; print({version_namespace}.__version__)", + ) + + session.run( + "py.test", + "tests/unit", + env={ + "PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION": protobuf_implementation, + }, + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +@nox.parametrize( + "protobuf_implementation", + ["python", "upb"], +) +def core_deps_from_source(session, protobuf_implementation): + """Run all tests with core dependencies installed from source + rather than pulling the dependencies from PyPI. + """ + + # Install all dependencies + session.install("-e", ".") + + # Install dependencies for the unit test environment + unit_deps_all = UNIT_TEST_STANDARD_DEPENDENCIES + UNIT_TEST_EXTERNAL_DEPENDENCIES + session.install(*unit_deps_all) + + # Install dependencies for the system test environment + system_deps_all = ( + SYSTEM_TEST_STANDARD_DEPENDENCIES + + SYSTEM_TEST_EXTERNAL_DEPENDENCIES + + SYSTEM_TEST_EXTRAS + ) + session.install(*system_deps_all) + + # Because we test minimum dependency versions on the minimum Python + # version, the first version we test with in the unit tests sessions has a + # constraints file containing all dependencies and extras. + with open( + CURRENT_DIRECTORY / "testing" / f"constraints-{ALL_PYTHON[0]}.txt", + encoding="utf-8", + ) as constraints_file: + constraints_text = constraints_file.read() + + # Ignore leading whitespace and comment lines. + constraints_deps = [ + match.group(1) + for match in re.finditer( + r"^\s*(\S+)(?===\S+)", constraints_text, flags=re.MULTILINE + ) + ] + + # Install dependencies specified in `testing/constraints-X.txt`. + session.install(*constraints_deps) + + # TODO(https://github.com/googleapis/gapic-generator-python/issues/2358): `grpcio` and + # `grpcio-status` should be added to the list below so that they are installed from source, + # rather than PyPI. + # TODO(https://github.com/googleapis/gapic-generator-python/issues/2357): `protobuf` should be + # added to the list below so that it is installed from source, rather than PyPI + # Note: If a dependency is added to the `core_dependencies_from_source` list, + # the `prerel_deps` list in the `prerelease_deps` nox session should also be updated. + core_dependencies_from_source = [ + "googleapis-common-protos @ git+https://github.com/googleapis/google-cloud-python#egg=googleapis-common-protos&subdirectory=packages/googleapis-common-protos", + "google-api-core @ git+https://github.com/googleapis/python-api-core.git", + "google-auth @ git+https://github.com/googleapis/google-auth-library-python.git", + "grpc-google-iam-v1 @ git+https://github.com/googleapis/google-cloud-python#egg=grpc-google-iam-v1&subdirectory=packages/grpc-google-iam-v1", + "proto-plus @ git+https://github.com/googleapis/proto-plus-python.git", + ] + + for dep in core_dependencies_from_source: + session.install(dep, "--no-deps", "--ignore-installed") + print(f"Installed {dep}") + + session.run( + "py.test", + "tests/unit", + env={ + "PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION": protobuf_implementation, + }, + ) diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_assignment_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_assignment_async.py new file mode 100644 index 000000000000..a96d6eae668c --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_assignment_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 CreateAssignment +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_CreateAssignment_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 bigquery_reservation_v1 + + +async def sample_create_assignment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.CreateAssignmentRequest( + parent="parent_value", + ) + + # Make the request + response = await client.create_assignment(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_CreateAssignment_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_assignment_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_assignment_sync.py new file mode 100644 index 000000000000..3d3376cf7dda --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_assignment_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 CreateAssignment +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_CreateAssignment_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 bigquery_reservation_v1 + + +def sample_create_assignment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.CreateAssignmentRequest( + parent="parent_value", + ) + + # Make the request + response = client.create_assignment(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_CreateAssignment_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_capacity_commitment_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_capacity_commitment_async.py new file mode 100644 index 000000000000..0c4033711d5e --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_capacity_commitment_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 CreateCapacityCommitment +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_CreateCapacityCommitment_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 bigquery_reservation_v1 + + +async def sample_create_capacity_commitment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.CreateCapacityCommitmentRequest( + parent="parent_value", + ) + + # Make the request + response = await client.create_capacity_commitment(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_CreateCapacityCommitment_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_capacity_commitment_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_capacity_commitment_sync.py new file mode 100644 index 000000000000..ca54f48c0e85 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_capacity_commitment_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 CreateCapacityCommitment +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_CreateCapacityCommitment_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 bigquery_reservation_v1 + + +def sample_create_capacity_commitment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.CreateCapacityCommitmentRequest( + parent="parent_value", + ) + + # Make the request + response = client.create_capacity_commitment(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_CreateCapacityCommitment_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_reservation_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_reservation_async.py new file mode 100644 index 000000000000..1f823147ff48 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_reservation_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 CreateReservation +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_CreateReservation_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 bigquery_reservation_v1 + + +async def sample_create_reservation(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.CreateReservationRequest( + parent="parent_value", + ) + + # Make the request + response = await client.create_reservation(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_CreateReservation_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_reservation_group_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_reservation_group_async.py new file mode 100644 index 000000000000..67f90605b006 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_reservation_group_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 CreateReservationGroup +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_CreateReservationGroup_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 bigquery_reservation_v1 + + +async def sample_create_reservation_group(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.CreateReservationGroupRequest( + parent="parent_value", + reservation_group_id="reservation_group_id_value", + ) + + # Make the request + response = await client.create_reservation_group(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_CreateReservationGroup_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_reservation_group_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_reservation_group_sync.py new file mode 100644 index 000000000000..07280cec9a5d --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_reservation_group_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 CreateReservationGroup +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_CreateReservationGroup_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 bigquery_reservation_v1 + + +def sample_create_reservation_group(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.CreateReservationGroupRequest( + parent="parent_value", + reservation_group_id="reservation_group_id_value", + ) + + # Make the request + response = client.create_reservation_group(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_CreateReservationGroup_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_reservation_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_reservation_sync.py new file mode 100644 index 000000000000..37f1cd45adc5 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_reservation_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 CreateReservation +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_CreateReservation_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 bigquery_reservation_v1 + + +def sample_create_reservation(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.CreateReservationRequest( + parent="parent_value", + ) + + # Make the request + response = client.create_reservation(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_CreateReservation_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_assignment_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_assignment_async.py new file mode 100644 index 000000000000..7b37bedb0804 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_assignment_async.py @@ -0,0 +1,50 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 DeleteAssignment +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_DeleteAssignment_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 bigquery_reservation_v1 + + +async def sample_delete_assignment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.DeleteAssignmentRequest( + name="name_value", + ) + + # Make the request + await client.delete_assignment(request=request) + + +# [END bigqueryreservation_v1_generated_ReservationService_DeleteAssignment_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_assignment_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_assignment_sync.py new file mode 100644 index 000000000000..63ef959f4faf --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_assignment_sync.py @@ -0,0 +1,50 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 DeleteAssignment +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_DeleteAssignment_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 bigquery_reservation_v1 + + +def sample_delete_assignment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.DeleteAssignmentRequest( + name="name_value", + ) + + # Make the request + client.delete_assignment(request=request) + + +# [END bigqueryreservation_v1_generated_ReservationService_DeleteAssignment_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_capacity_commitment_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_capacity_commitment_async.py new file mode 100644 index 000000000000..28b509262b83 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_capacity_commitment_async.py @@ -0,0 +1,50 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 DeleteCapacityCommitment +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_DeleteCapacityCommitment_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 bigquery_reservation_v1 + + +async def sample_delete_capacity_commitment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.DeleteCapacityCommitmentRequest( + name="name_value", + ) + + # Make the request + await client.delete_capacity_commitment(request=request) + + +# [END bigqueryreservation_v1_generated_ReservationService_DeleteCapacityCommitment_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_capacity_commitment_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_capacity_commitment_sync.py new file mode 100644 index 000000000000..38175299d1c2 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_capacity_commitment_sync.py @@ -0,0 +1,50 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 DeleteCapacityCommitment +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_DeleteCapacityCommitment_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 bigquery_reservation_v1 + + +def sample_delete_capacity_commitment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.DeleteCapacityCommitmentRequest( + name="name_value", + ) + + # Make the request + client.delete_capacity_commitment(request=request) + + +# [END bigqueryreservation_v1_generated_ReservationService_DeleteCapacityCommitment_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_reservation_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_reservation_async.py new file mode 100644 index 000000000000..bea1b30ac9bc --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_reservation_async.py @@ -0,0 +1,50 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 DeleteReservation +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_DeleteReservation_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 bigquery_reservation_v1 + + +async def sample_delete_reservation(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.DeleteReservationRequest( + name="name_value", + ) + + # Make the request + await client.delete_reservation(request=request) + + +# [END bigqueryreservation_v1_generated_ReservationService_DeleteReservation_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_reservation_group_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_reservation_group_async.py new file mode 100644 index 000000000000..abe35d53fc7d --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_reservation_group_async.py @@ -0,0 +1,50 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 DeleteReservationGroup +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_DeleteReservationGroup_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 bigquery_reservation_v1 + + +async def sample_delete_reservation_group(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.DeleteReservationGroupRequest( + name="name_value", + ) + + # Make the request + await client.delete_reservation_group(request=request) + + +# [END bigqueryreservation_v1_generated_ReservationService_DeleteReservationGroup_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_reservation_group_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_reservation_group_sync.py new file mode 100644 index 000000000000..949130fd02eb --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_reservation_group_sync.py @@ -0,0 +1,50 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 DeleteReservationGroup +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_DeleteReservationGroup_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 bigquery_reservation_v1 + + +def sample_delete_reservation_group(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.DeleteReservationGroupRequest( + name="name_value", + ) + + # Make the request + client.delete_reservation_group(request=request) + + +# [END bigqueryreservation_v1_generated_ReservationService_DeleteReservationGroup_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_reservation_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_reservation_sync.py new file mode 100644 index 000000000000..05ce54e29176 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_reservation_sync.py @@ -0,0 +1,50 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 DeleteReservation +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_DeleteReservation_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 bigquery_reservation_v1 + + +def sample_delete_reservation(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.DeleteReservationRequest( + name="name_value", + ) + + # Make the request + client.delete_reservation(request=request) + + +# [END bigqueryreservation_v1_generated_ReservationService_DeleteReservation_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_failover_reservation_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_failover_reservation_async.py new file mode 100644 index 000000000000..065aee655552 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_failover_reservation_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 FailoverReservation +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_FailoverReservation_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 bigquery_reservation_v1 + + +async def sample_failover_reservation(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.FailoverReservationRequest( + name="name_value", + ) + + # Make the request + response = await client.failover_reservation(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_FailoverReservation_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_failover_reservation_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_failover_reservation_sync.py new file mode 100644 index 000000000000..757ecd889fd4 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_failover_reservation_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 FailoverReservation +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_FailoverReservation_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 bigquery_reservation_v1 + + +def sample_failover_reservation(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.FailoverReservationRequest( + name="name_value", + ) + + # Make the request + response = client.failover_reservation(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_FailoverReservation_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_bi_reservation_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_bi_reservation_async.py new file mode 100644 index 000000000000..9cd913867abe --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_bi_reservation_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 GetBiReservation +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_GetBiReservation_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 bigquery_reservation_v1 + + +async def sample_get_bi_reservation(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.GetBiReservationRequest( + name="name_value", + ) + + # Make the request + response = await client.get_bi_reservation(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_GetBiReservation_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_bi_reservation_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_bi_reservation_sync.py new file mode 100644 index 000000000000..55ce9a47dea1 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_bi_reservation_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 GetBiReservation +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_GetBiReservation_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 bigquery_reservation_v1 + + +def sample_get_bi_reservation(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.GetBiReservationRequest( + name="name_value", + ) + + # Make the request + response = client.get_bi_reservation(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_GetBiReservation_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_capacity_commitment_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_capacity_commitment_async.py new file mode 100644 index 000000000000..1ad990bd52a9 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_capacity_commitment_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 GetCapacityCommitment +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_GetCapacityCommitment_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 bigquery_reservation_v1 + + +async def sample_get_capacity_commitment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.GetCapacityCommitmentRequest( + name="name_value", + ) + + # Make the request + response = await client.get_capacity_commitment(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_GetCapacityCommitment_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_capacity_commitment_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_capacity_commitment_sync.py new file mode 100644 index 000000000000..ef0b5579c266 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_capacity_commitment_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 GetCapacityCommitment +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_GetCapacityCommitment_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 bigquery_reservation_v1 + + +def sample_get_capacity_commitment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.GetCapacityCommitmentRequest( + name="name_value", + ) + + # Make the request + response = client.get_capacity_commitment(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_GetCapacityCommitment_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_iam_policy_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_iam_policy_async.py new file mode 100644 index 000000000000..d1551d5fbf8f --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_iam_policy_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 GetIamPolicy +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_GetIamPolicy_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 bigquery_reservation_v1 +from google.iam.v1 import iam_policy_pb2 # type: ignore + + +async def sample_get_iam_policy(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = iam_policy_pb2.GetIamPolicyRequest( + resource="resource_value", + ) + + # Make the request + response = await client.get_iam_policy(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_GetIamPolicy_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_iam_policy_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_iam_policy_sync.py new file mode 100644 index 000000000000..d03d29ba4235 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_iam_policy_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 GetIamPolicy +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_GetIamPolicy_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 bigquery_reservation_v1 +from google.iam.v1 import iam_policy_pb2 # type: ignore + + +def sample_get_iam_policy(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = iam_policy_pb2.GetIamPolicyRequest( + resource="resource_value", + ) + + # Make the request + response = client.get_iam_policy(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_GetIamPolicy_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_reservation_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_reservation_async.py new file mode 100644 index 000000000000..c758ac5b4b7a --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_reservation_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 GetReservation +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_GetReservation_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 bigquery_reservation_v1 + + +async def sample_get_reservation(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.GetReservationRequest( + name="name_value", + ) + + # Make the request + response = await client.get_reservation(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_GetReservation_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_reservation_group_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_reservation_group_async.py new file mode 100644 index 000000000000..b224b51643c2 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_reservation_group_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 GetReservationGroup +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_GetReservationGroup_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 bigquery_reservation_v1 + + +async def sample_get_reservation_group(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.GetReservationGroupRequest( + name="name_value", + ) + + # Make the request + response = await client.get_reservation_group(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_GetReservationGroup_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_reservation_group_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_reservation_group_sync.py new file mode 100644 index 000000000000..e812a8c8b314 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_reservation_group_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 GetReservationGroup +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_GetReservationGroup_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 bigquery_reservation_v1 + + +def sample_get_reservation_group(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.GetReservationGroupRequest( + name="name_value", + ) + + # Make the request + response = client.get_reservation_group(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_GetReservationGroup_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_reservation_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_reservation_sync.py new file mode 100644 index 000000000000..3a49c1b5bd17 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_reservation_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 GetReservation +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_GetReservation_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 bigquery_reservation_v1 + + +def sample_get_reservation(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.GetReservationRequest( + name="name_value", + ) + + # Make the request + response = client.get_reservation(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_GetReservation_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_assignments_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_assignments_async.py new file mode 100644 index 000000000000..f5302c655e91 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_assignments_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 ListAssignments +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_ListAssignments_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 bigquery_reservation_v1 + + +async def sample_list_assignments(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.ListAssignmentsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_assignments(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_ListAssignments_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_assignments_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_assignments_sync.py new file mode 100644 index 000000000000..2a86f61680cd --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_assignments_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 ListAssignments +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_ListAssignments_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 bigquery_reservation_v1 + + +def sample_list_assignments(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.ListAssignmentsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_assignments(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_ListAssignments_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_capacity_commitments_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_capacity_commitments_async.py new file mode 100644 index 000000000000..cc98d875e5c4 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_capacity_commitments_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 ListCapacityCommitments +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_ListCapacityCommitments_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 bigquery_reservation_v1 + + +async def sample_list_capacity_commitments(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.ListCapacityCommitmentsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_capacity_commitments(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_ListCapacityCommitments_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_capacity_commitments_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_capacity_commitments_sync.py new file mode 100644 index 000000000000..8ead72c8369b --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_capacity_commitments_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 ListCapacityCommitments +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_ListCapacityCommitments_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 bigquery_reservation_v1 + + +def sample_list_capacity_commitments(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.ListCapacityCommitmentsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_capacity_commitments(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_ListCapacityCommitments_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_reservation_groups_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_reservation_groups_async.py new file mode 100644 index 000000000000..afe0abe68b85 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_reservation_groups_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 ListReservationGroups +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_ListReservationGroups_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 bigquery_reservation_v1 + + +async def sample_list_reservation_groups(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.ListReservationGroupsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_reservation_groups(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_ListReservationGroups_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_reservation_groups_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_reservation_groups_sync.py new file mode 100644 index 000000000000..e7b240a615d7 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_reservation_groups_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 ListReservationGroups +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_ListReservationGroups_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 bigquery_reservation_v1 + + +def sample_list_reservation_groups(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.ListReservationGroupsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_reservation_groups(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_ListReservationGroups_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_reservations_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_reservations_async.py new file mode 100644 index 000000000000..edae6d23dbc2 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_reservations_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 ListReservations +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_ListReservations_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 bigquery_reservation_v1 + + +async def sample_list_reservations(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.ListReservationsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_reservations(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_ListReservations_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_reservations_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_reservations_sync.py new file mode 100644 index 000000000000..8b2c9835e653 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_reservations_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 ListReservations +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_ListReservations_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 bigquery_reservation_v1 + + +def sample_list_reservations(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.ListReservationsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_reservations(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_ListReservations_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_merge_capacity_commitments_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_merge_capacity_commitments_async.py new file mode 100644 index 000000000000..186e97f665f7 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_merge_capacity_commitments_async.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 MergeCapacityCommitments +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_MergeCapacityCommitments_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 bigquery_reservation_v1 + + +async def sample_merge_capacity_commitments(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.MergeCapacityCommitmentsRequest( + ) + + # Make the request + response = await client.merge_capacity_commitments(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_MergeCapacityCommitments_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_merge_capacity_commitments_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_merge_capacity_commitments_sync.py new file mode 100644 index 000000000000..f2cfd806e8ec --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_merge_capacity_commitments_sync.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 MergeCapacityCommitments +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_MergeCapacityCommitments_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 bigquery_reservation_v1 + + +def sample_merge_capacity_commitments(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.MergeCapacityCommitmentsRequest( + ) + + # Make the request + response = client.merge_capacity_commitments(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_MergeCapacityCommitments_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_move_assignment_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_move_assignment_async.py new file mode 100644 index 000000000000..7d4930740c04 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_move_assignment_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 MoveAssignment +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_MoveAssignment_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 bigquery_reservation_v1 + + +async def sample_move_assignment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.MoveAssignmentRequest( + name="name_value", + ) + + # Make the request + response = await client.move_assignment(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_MoveAssignment_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_move_assignment_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_move_assignment_sync.py new file mode 100644 index 000000000000..2ad8b39c7719 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_move_assignment_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 MoveAssignment +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_MoveAssignment_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 bigquery_reservation_v1 + + +def sample_move_assignment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.MoveAssignmentRequest( + name="name_value", + ) + + # Make the request + response = client.move_assignment(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_MoveAssignment_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_search_all_assignments_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_search_all_assignments_async.py new file mode 100644 index 000000000000..1babd13e1c03 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_search_all_assignments_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 SearchAllAssignments +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_SearchAllAssignments_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 bigquery_reservation_v1 + + +async def sample_search_all_assignments(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.SearchAllAssignmentsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.search_all_assignments(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_SearchAllAssignments_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_search_all_assignments_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_search_all_assignments_sync.py new file mode 100644 index 000000000000..2fe743d7f68c --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_search_all_assignments_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 SearchAllAssignments +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_SearchAllAssignments_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 bigquery_reservation_v1 + + +def sample_search_all_assignments(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.SearchAllAssignmentsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.search_all_assignments(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_SearchAllAssignments_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_search_assignments_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_search_assignments_async.py new file mode 100644 index 000000000000..231a89f89c85 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_search_assignments_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 SearchAssignments +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_SearchAssignments_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 bigquery_reservation_v1 + + +async def sample_search_assignments(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.SearchAssignmentsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.search_assignments(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_SearchAssignments_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_search_assignments_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_search_assignments_sync.py new file mode 100644 index 000000000000..19b460ad8e2d --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_search_assignments_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 SearchAssignments +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_SearchAssignments_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 bigquery_reservation_v1 + + +def sample_search_assignments(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.SearchAssignmentsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.search_assignments(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_SearchAssignments_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_set_iam_policy_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_set_iam_policy_async.py new file mode 100644 index 000000000000..2a6c174412c3 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_set_iam_policy_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 SetIamPolicy +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_SetIamPolicy_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 bigquery_reservation_v1 +from google.iam.v1 import iam_policy_pb2 # type: ignore + + +async def sample_set_iam_policy(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = iam_policy_pb2.SetIamPolicyRequest( + resource="resource_value", + ) + + # Make the request + response = await client.set_iam_policy(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_SetIamPolicy_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_set_iam_policy_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_set_iam_policy_sync.py new file mode 100644 index 000000000000..2fd8cb712160 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_set_iam_policy_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 SetIamPolicy +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_SetIamPolicy_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 bigquery_reservation_v1 +from google.iam.v1 import iam_policy_pb2 # type: ignore + + +def sample_set_iam_policy(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = iam_policy_pb2.SetIamPolicyRequest( + resource="resource_value", + ) + + # Make the request + response = client.set_iam_policy(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_SetIamPolicy_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_split_capacity_commitment_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_split_capacity_commitment_async.py new file mode 100644 index 000000000000..c85da2e44809 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_split_capacity_commitment_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 SplitCapacityCommitment +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_SplitCapacityCommitment_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 bigquery_reservation_v1 + + +async def sample_split_capacity_commitment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.SplitCapacityCommitmentRequest( + name="name_value", + ) + + # Make the request + response = await client.split_capacity_commitment(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_SplitCapacityCommitment_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_split_capacity_commitment_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_split_capacity_commitment_sync.py new file mode 100644 index 000000000000..8495cfdb1afa --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_split_capacity_commitment_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 SplitCapacityCommitment +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_SplitCapacityCommitment_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 bigquery_reservation_v1 + + +def sample_split_capacity_commitment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.SplitCapacityCommitmentRequest( + name="name_value", + ) + + # Make the request + response = client.split_capacity_commitment(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_SplitCapacityCommitment_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_test_iam_permissions_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_test_iam_permissions_async.py new file mode 100644 index 000000000000..5e0f734f1f53 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_test_iam_permissions_async.py @@ -0,0 +1,54 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 TestIamPermissions +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_TestIamPermissions_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 bigquery_reservation_v1 +from google.iam.v1 import iam_policy_pb2 # type: ignore + + +async def sample_test_iam_permissions(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = iam_policy_pb2.TestIamPermissionsRequest( + resource="resource_value", + permissions=['permissions_value1', 'permissions_value2'], + ) + + # Make the request + response = await client.test_iam_permissions(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_TestIamPermissions_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_test_iam_permissions_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_test_iam_permissions_sync.py new file mode 100644 index 000000000000..803f313da341 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_test_iam_permissions_sync.py @@ -0,0 +1,54 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 TestIamPermissions +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_TestIamPermissions_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 bigquery_reservation_v1 +from google.iam.v1 import iam_policy_pb2 # type: ignore + + +def sample_test_iam_permissions(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = iam_policy_pb2.TestIamPermissionsRequest( + resource="resource_value", + permissions=['permissions_value1', 'permissions_value2'], + ) + + # Make the request + response = client.test_iam_permissions(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_TestIamPermissions_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_assignment_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_assignment_async.py new file mode 100644 index 000000000000..494e36bbe9fb --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_assignment_async.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 UpdateAssignment +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_UpdateAssignment_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 bigquery_reservation_v1 + + +async def sample_update_assignment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.UpdateAssignmentRequest( + ) + + # Make the request + response = await client.update_assignment(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_UpdateAssignment_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_assignment_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_assignment_sync.py new file mode 100644 index 000000000000..108f22c71655 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_assignment_sync.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 UpdateAssignment +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_UpdateAssignment_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 bigquery_reservation_v1 + + +def sample_update_assignment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.UpdateAssignmentRequest( + ) + + # Make the request + response = client.update_assignment(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_UpdateAssignment_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_bi_reservation_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_bi_reservation_async.py new file mode 100644 index 000000000000..15f16aaa91f1 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_bi_reservation_async.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 UpdateBiReservation +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_UpdateBiReservation_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 bigquery_reservation_v1 + + +async def sample_update_bi_reservation(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.UpdateBiReservationRequest( + ) + + # Make the request + response = await client.update_bi_reservation(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_UpdateBiReservation_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_bi_reservation_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_bi_reservation_sync.py new file mode 100644 index 000000000000..b0c93e53e11c --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_bi_reservation_sync.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 UpdateBiReservation +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_UpdateBiReservation_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 bigquery_reservation_v1 + + +def sample_update_bi_reservation(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.UpdateBiReservationRequest( + ) + + # Make the request + response = client.update_bi_reservation(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_UpdateBiReservation_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_capacity_commitment_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_capacity_commitment_async.py new file mode 100644 index 000000000000..6a0732562557 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_capacity_commitment_async.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 UpdateCapacityCommitment +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_UpdateCapacityCommitment_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 bigquery_reservation_v1 + + +async def sample_update_capacity_commitment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.UpdateCapacityCommitmentRequest( + ) + + # Make the request + response = await client.update_capacity_commitment(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_UpdateCapacityCommitment_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_capacity_commitment_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_capacity_commitment_sync.py new file mode 100644 index 000000000000..0c11eb103d6e --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_capacity_commitment_sync.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 UpdateCapacityCommitment +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_UpdateCapacityCommitment_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 bigquery_reservation_v1 + + +def sample_update_capacity_commitment(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.UpdateCapacityCommitmentRequest( + ) + + # Make the request + response = client.update_capacity_commitment(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_UpdateCapacityCommitment_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_reservation_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_reservation_async.py new file mode 100644 index 000000000000..2b3802e480bf --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_reservation_async.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 UpdateReservation +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_UpdateReservation_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 bigquery_reservation_v1 + + +async def sample_update_reservation(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.UpdateReservationRequest( + ) + + # Make the request + response = await client.update_reservation(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_UpdateReservation_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_reservation_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_reservation_sync.py new file mode 100644 index 000000000000..1afe72c1ca94 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_reservation_sync.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 UpdateReservation +# 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-bigquery-reservation + + +# [START bigqueryreservation_v1_generated_ReservationService_UpdateReservation_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 bigquery_reservation_v1 + + +def sample_update_reservation(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.UpdateReservationRequest( + ) + + # Make the request + response = client.update_reservation(request=request) + + # Handle the response + print(response) + +# [END bigqueryreservation_v1_generated_ReservationService_UpdateReservation_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/snippet_metadata_google.cloud.bigquery.reservation.v1.json b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/snippet_metadata_google.cloud.bigquery.reservation.v1.json new file mode 100644 index 000000000000..6c2537553261 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/snippet_metadata_google.cloud.bigquery.reservation.v1.json @@ -0,0 +1,4740 @@ +{ + "clientLibrary": { + "apis": [ + { + "id": "google.cloud.bigquery.reservation.v1", + "version": "v1" + } + ], + "language": "PYTHON", + "name": "google-cloud-bigquery-reservation", + "version": "0.1.0" + }, + "snippets": [ + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.create_assignment", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.CreateAssignment", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "CreateAssignment" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.CreateAssignmentRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "assignment", + "type": "google.cloud.bigquery_reservation_v1.types.Assignment" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.Assignment", + "shortName": "create_assignment" + }, + "description": "Sample for CreateAssignment", + "file": "bigqueryreservation_v1_generated_reservation_service_create_assignment_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_CreateAssignment_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": "bigqueryreservation_v1_generated_reservation_service_create_assignment_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.create_assignment", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.CreateAssignment", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "CreateAssignment" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.CreateAssignmentRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "assignment", + "type": "google.cloud.bigquery_reservation_v1.types.Assignment" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.Assignment", + "shortName": "create_assignment" + }, + "description": "Sample for CreateAssignment", + "file": "bigqueryreservation_v1_generated_reservation_service_create_assignment_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_CreateAssignment_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": "bigqueryreservation_v1_generated_reservation_service_create_assignment_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.create_capacity_commitment", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.CreateCapacityCommitment", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "CreateCapacityCommitment" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.CreateCapacityCommitmentRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "capacity_commitment", + "type": "google.cloud.bigquery_reservation_v1.types.CapacityCommitment" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.CapacityCommitment", + "shortName": "create_capacity_commitment" + }, + "description": "Sample for CreateCapacityCommitment", + "file": "bigqueryreservation_v1_generated_reservation_service_create_capacity_commitment_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_CreateCapacityCommitment_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": "bigqueryreservation_v1_generated_reservation_service_create_capacity_commitment_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.create_capacity_commitment", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.CreateCapacityCommitment", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "CreateCapacityCommitment" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.CreateCapacityCommitmentRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "capacity_commitment", + "type": "google.cloud.bigquery_reservation_v1.types.CapacityCommitment" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.CapacityCommitment", + "shortName": "create_capacity_commitment" + }, + "description": "Sample for CreateCapacityCommitment", + "file": "bigqueryreservation_v1_generated_reservation_service_create_capacity_commitment_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_CreateCapacityCommitment_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": "bigqueryreservation_v1_generated_reservation_service_create_capacity_commitment_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.create_reservation_group", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.CreateReservationGroup", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "CreateReservationGroup" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.CreateReservationGroupRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.ReservationGroup", + "shortName": "create_reservation_group" + }, + "description": "Sample for CreateReservationGroup", + "file": "bigqueryreservation_v1_generated_reservation_service_create_reservation_group_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_CreateReservationGroup_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "bigqueryreservation_v1_generated_reservation_service_create_reservation_group_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.create_reservation_group", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.CreateReservationGroup", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "CreateReservationGroup" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.CreateReservationGroupRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.ReservationGroup", + "shortName": "create_reservation_group" + }, + "description": "Sample for CreateReservationGroup", + "file": "bigqueryreservation_v1_generated_reservation_service_create_reservation_group_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_CreateReservationGroup_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "bigqueryreservation_v1_generated_reservation_service_create_reservation_group_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.create_reservation", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.CreateReservation", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "CreateReservation" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.CreateReservationRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "reservation", + "type": "google.cloud.bigquery_reservation_v1.types.Reservation" + }, + { + "name": "reservation_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.Reservation", + "shortName": "create_reservation" + }, + "description": "Sample for CreateReservation", + "file": "bigqueryreservation_v1_generated_reservation_service_create_reservation_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_CreateReservation_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": "bigqueryreservation_v1_generated_reservation_service_create_reservation_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.create_reservation", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.CreateReservation", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "CreateReservation" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.CreateReservationRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "reservation", + "type": "google.cloud.bigquery_reservation_v1.types.Reservation" + }, + { + "name": "reservation_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.Reservation", + "shortName": "create_reservation" + }, + "description": "Sample for CreateReservation", + "file": "bigqueryreservation_v1_generated_reservation_service_create_reservation_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_CreateReservation_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": "bigqueryreservation_v1_generated_reservation_service_create_reservation_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.delete_assignment", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.DeleteAssignment", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "DeleteAssignment" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.DeleteAssignmentRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "shortName": "delete_assignment" + }, + "description": "Sample for DeleteAssignment", + "file": "bigqueryreservation_v1_generated_reservation_service_delete_assignment_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_DeleteAssignment_async", + "segments": [ + { + "end": 49, + "start": 27, + "type": "FULL" + }, + { + "end": 49, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "bigqueryreservation_v1_generated_reservation_service_delete_assignment_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.delete_assignment", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.DeleteAssignment", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "DeleteAssignment" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.DeleteAssignmentRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "shortName": "delete_assignment" + }, + "description": "Sample for DeleteAssignment", + "file": "bigqueryreservation_v1_generated_reservation_service_delete_assignment_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_DeleteAssignment_sync", + "segments": [ + { + "end": 49, + "start": 27, + "type": "FULL" + }, + { + "end": 49, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "bigqueryreservation_v1_generated_reservation_service_delete_assignment_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.delete_capacity_commitment", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.DeleteCapacityCommitment", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "DeleteCapacityCommitment" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.DeleteCapacityCommitmentRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "shortName": "delete_capacity_commitment" + }, + "description": "Sample for DeleteCapacityCommitment", + "file": "bigqueryreservation_v1_generated_reservation_service_delete_capacity_commitment_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_DeleteCapacityCommitment_async", + "segments": [ + { + "end": 49, + "start": 27, + "type": "FULL" + }, + { + "end": 49, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "bigqueryreservation_v1_generated_reservation_service_delete_capacity_commitment_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.delete_capacity_commitment", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.DeleteCapacityCommitment", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "DeleteCapacityCommitment" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.DeleteCapacityCommitmentRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "shortName": "delete_capacity_commitment" + }, + "description": "Sample for DeleteCapacityCommitment", + "file": "bigqueryreservation_v1_generated_reservation_service_delete_capacity_commitment_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_DeleteCapacityCommitment_sync", + "segments": [ + { + "end": 49, + "start": 27, + "type": "FULL" + }, + { + "end": 49, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "bigqueryreservation_v1_generated_reservation_service_delete_capacity_commitment_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.delete_reservation_group", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservationGroup", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "DeleteReservationGroup" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.DeleteReservationGroupRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "shortName": "delete_reservation_group" + }, + "description": "Sample for DeleteReservationGroup", + "file": "bigqueryreservation_v1_generated_reservation_service_delete_reservation_group_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_DeleteReservationGroup_async", + "segments": [ + { + "end": 49, + "start": 27, + "type": "FULL" + }, + { + "end": 49, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "bigqueryreservation_v1_generated_reservation_service_delete_reservation_group_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.delete_reservation_group", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservationGroup", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "DeleteReservationGroup" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.DeleteReservationGroupRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "shortName": "delete_reservation_group" + }, + "description": "Sample for DeleteReservationGroup", + "file": "bigqueryreservation_v1_generated_reservation_service_delete_reservation_group_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_DeleteReservationGroup_sync", + "segments": [ + { + "end": 49, + "start": 27, + "type": "FULL" + }, + { + "end": 49, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "bigqueryreservation_v1_generated_reservation_service_delete_reservation_group_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.delete_reservation", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservation", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "DeleteReservation" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.DeleteReservationRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "shortName": "delete_reservation" + }, + "description": "Sample for DeleteReservation", + "file": "bigqueryreservation_v1_generated_reservation_service_delete_reservation_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_DeleteReservation_async", + "segments": [ + { + "end": 49, + "start": 27, + "type": "FULL" + }, + { + "end": 49, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "bigqueryreservation_v1_generated_reservation_service_delete_reservation_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.delete_reservation", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservation", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "DeleteReservation" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.DeleteReservationRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "shortName": "delete_reservation" + }, + "description": "Sample for DeleteReservation", + "file": "bigqueryreservation_v1_generated_reservation_service_delete_reservation_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_DeleteReservation_sync", + "segments": [ + { + "end": 49, + "start": 27, + "type": "FULL" + }, + { + "end": 49, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "bigqueryreservation_v1_generated_reservation_service_delete_reservation_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.failover_reservation", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.FailoverReservation", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "FailoverReservation" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.FailoverReservationRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.Reservation", + "shortName": "failover_reservation" + }, + "description": "Sample for FailoverReservation", + "file": "bigqueryreservation_v1_generated_reservation_service_failover_reservation_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_FailoverReservation_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": "bigqueryreservation_v1_generated_reservation_service_failover_reservation_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.failover_reservation", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.FailoverReservation", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "FailoverReservation" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.FailoverReservationRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.Reservation", + "shortName": "failover_reservation" + }, + "description": "Sample for FailoverReservation", + "file": "bigqueryreservation_v1_generated_reservation_service_failover_reservation_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_FailoverReservation_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": "bigqueryreservation_v1_generated_reservation_service_failover_reservation_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.get_bi_reservation", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetBiReservation", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "GetBiReservation" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.GetBiReservationRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.BiReservation", + "shortName": "get_bi_reservation" + }, + "description": "Sample for GetBiReservation", + "file": "bigqueryreservation_v1_generated_reservation_service_get_bi_reservation_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetBiReservation_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": "bigqueryreservation_v1_generated_reservation_service_get_bi_reservation_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.get_bi_reservation", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetBiReservation", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "GetBiReservation" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.GetBiReservationRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.BiReservation", + "shortName": "get_bi_reservation" + }, + "description": "Sample for GetBiReservation", + "file": "bigqueryreservation_v1_generated_reservation_service_get_bi_reservation_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetBiReservation_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": "bigqueryreservation_v1_generated_reservation_service_get_bi_reservation_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.get_capacity_commitment", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitment", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "GetCapacityCommitment" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.GetCapacityCommitmentRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.CapacityCommitment", + "shortName": "get_capacity_commitment" + }, + "description": "Sample for GetCapacityCommitment", + "file": "bigqueryreservation_v1_generated_reservation_service_get_capacity_commitment_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetCapacityCommitment_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": "bigqueryreservation_v1_generated_reservation_service_get_capacity_commitment_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.get_capacity_commitment", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitment", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "GetCapacityCommitment" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.GetCapacityCommitmentRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.CapacityCommitment", + "shortName": "get_capacity_commitment" + }, + "description": "Sample for GetCapacityCommitment", + "file": "bigqueryreservation_v1_generated_reservation_service_get_capacity_commitment_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetCapacityCommitment_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": "bigqueryreservation_v1_generated_reservation_service_get_capacity_commitment_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.get_iam_policy", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetIamPolicy", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "GetIamPolicy" + }, + "parameters": [ + { + "name": "request", + "type": "google.iam.v1.iam_policy_pb2.GetIamPolicyRequest" + }, + { + "name": "resource", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.iam.v1.policy_pb2.Policy", + "shortName": "get_iam_policy" + }, + "description": "Sample for GetIamPolicy", + "file": "bigqueryreservation_v1_generated_reservation_service_get_iam_policy_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetIamPolicy_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 41, + "start": 39, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 42, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "bigqueryreservation_v1_generated_reservation_service_get_iam_policy_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.get_iam_policy", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetIamPolicy", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "GetIamPolicy" + }, + "parameters": [ + { + "name": "request", + "type": "google.iam.v1.iam_policy_pb2.GetIamPolicyRequest" + }, + { + "name": "resource", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.iam.v1.policy_pb2.Policy", + "shortName": "get_iam_policy" + }, + "description": "Sample for GetIamPolicy", + "file": "bigqueryreservation_v1_generated_reservation_service_get_iam_policy_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetIamPolicy_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 41, + "start": 39, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 42, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "bigqueryreservation_v1_generated_reservation_service_get_iam_policy_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.get_reservation_group", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetReservationGroup", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "GetReservationGroup" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.GetReservationGroupRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.ReservationGroup", + "shortName": "get_reservation_group" + }, + "description": "Sample for GetReservationGroup", + "file": "bigqueryreservation_v1_generated_reservation_service_get_reservation_group_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetReservationGroup_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": "bigqueryreservation_v1_generated_reservation_service_get_reservation_group_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.get_reservation_group", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetReservationGroup", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "GetReservationGroup" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.GetReservationGroupRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.ReservationGroup", + "shortName": "get_reservation_group" + }, + "description": "Sample for GetReservationGroup", + "file": "bigqueryreservation_v1_generated_reservation_service_get_reservation_group_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetReservationGroup_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": "bigqueryreservation_v1_generated_reservation_service_get_reservation_group_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.get_reservation", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetReservation", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "GetReservation" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.GetReservationRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.Reservation", + "shortName": "get_reservation" + }, + "description": "Sample for GetReservation", + "file": "bigqueryreservation_v1_generated_reservation_service_get_reservation_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetReservation_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": "bigqueryreservation_v1_generated_reservation_service_get_reservation_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.get_reservation", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetReservation", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "GetReservation" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.GetReservationRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.Reservation", + "shortName": "get_reservation" + }, + "description": "Sample for GetReservation", + "file": "bigqueryreservation_v1_generated_reservation_service_get_reservation_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetReservation_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": "bigqueryreservation_v1_generated_reservation_service_get_reservation_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.list_assignments", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "ListAssignments" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.ListAssignmentsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListAssignmentsAsyncPager", + "shortName": "list_assignments" + }, + "description": "Sample for ListAssignments", + "file": "bigqueryreservation_v1_generated_reservation_service_list_assignments_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_ListAssignments_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": "bigqueryreservation_v1_generated_reservation_service_list_assignments_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.list_assignments", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "ListAssignments" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.ListAssignmentsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListAssignmentsPager", + "shortName": "list_assignments" + }, + "description": "Sample for ListAssignments", + "file": "bigqueryreservation_v1_generated_reservation_service_list_assignments_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_ListAssignments_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": "bigqueryreservation_v1_generated_reservation_service_list_assignments_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.list_capacity_commitments", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "ListCapacityCommitments" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListCapacityCommitmentsAsyncPager", + "shortName": "list_capacity_commitments" + }, + "description": "Sample for ListCapacityCommitments", + "file": "bigqueryreservation_v1_generated_reservation_service_list_capacity_commitments_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_ListCapacityCommitments_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": "bigqueryreservation_v1_generated_reservation_service_list_capacity_commitments_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.list_capacity_commitments", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "ListCapacityCommitments" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListCapacityCommitmentsPager", + "shortName": "list_capacity_commitments" + }, + "description": "Sample for ListCapacityCommitments", + "file": "bigqueryreservation_v1_generated_reservation_service_list_capacity_commitments_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_ListCapacityCommitments_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": "bigqueryreservation_v1_generated_reservation_service_list_capacity_commitments_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.list_reservation_groups", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.ListReservationGroups", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "ListReservationGroups" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.ListReservationGroupsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListReservationGroupsAsyncPager", + "shortName": "list_reservation_groups" + }, + "description": "Sample for ListReservationGroups", + "file": "bigqueryreservation_v1_generated_reservation_service_list_reservation_groups_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_ListReservationGroups_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": "bigqueryreservation_v1_generated_reservation_service_list_reservation_groups_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.list_reservation_groups", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.ListReservationGroups", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "ListReservationGroups" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.ListReservationGroupsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListReservationGroupsPager", + "shortName": "list_reservation_groups" + }, + "description": "Sample for ListReservationGroups", + "file": "bigqueryreservation_v1_generated_reservation_service_list_reservation_groups_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_ListReservationGroups_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": "bigqueryreservation_v1_generated_reservation_service_list_reservation_groups_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.list_reservations", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.ListReservations", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "ListReservations" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.ListReservationsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListReservationsAsyncPager", + "shortName": "list_reservations" + }, + "description": "Sample for ListReservations", + "file": "bigqueryreservation_v1_generated_reservation_service_list_reservations_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_ListReservations_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": "bigqueryreservation_v1_generated_reservation_service_list_reservations_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.list_reservations", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.ListReservations", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "ListReservations" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.ListReservationsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListReservationsPager", + "shortName": "list_reservations" + }, + "description": "Sample for ListReservations", + "file": "bigqueryreservation_v1_generated_reservation_service_list_reservations_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_ListReservations_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": "bigqueryreservation_v1_generated_reservation_service_list_reservations_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.merge_capacity_commitments", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.MergeCapacityCommitments", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "MergeCapacityCommitments" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.MergeCapacityCommitmentsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "capacity_commitment_ids", + "type": "MutableSequence[str]" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.CapacityCommitment", + "shortName": "merge_capacity_commitments" + }, + "description": "Sample for MergeCapacityCommitments", + "file": "bigqueryreservation_v1_generated_reservation_service_merge_capacity_commitments_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_MergeCapacityCommitments_async", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "bigqueryreservation_v1_generated_reservation_service_merge_capacity_commitments_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.merge_capacity_commitments", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.MergeCapacityCommitments", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "MergeCapacityCommitments" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.MergeCapacityCommitmentsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "capacity_commitment_ids", + "type": "MutableSequence[str]" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.CapacityCommitment", + "shortName": "merge_capacity_commitments" + }, + "description": "Sample for MergeCapacityCommitments", + "file": "bigqueryreservation_v1_generated_reservation_service_merge_capacity_commitments_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_MergeCapacityCommitments_sync", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "bigqueryreservation_v1_generated_reservation_service_merge_capacity_commitments_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.move_assignment", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.MoveAssignment", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "MoveAssignment" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.MoveAssignmentRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "destination_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.Assignment", + "shortName": "move_assignment" + }, + "description": "Sample for MoveAssignment", + "file": "bigqueryreservation_v1_generated_reservation_service_move_assignment_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_MoveAssignment_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": "bigqueryreservation_v1_generated_reservation_service_move_assignment_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.move_assignment", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.MoveAssignment", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "MoveAssignment" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.MoveAssignmentRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "destination_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.Assignment", + "shortName": "move_assignment" + }, + "description": "Sample for MoveAssignment", + "file": "bigqueryreservation_v1_generated_reservation_service_move_assignment_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_MoveAssignment_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": "bigqueryreservation_v1_generated_reservation_service_move_assignment_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.search_all_assignments", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "SearchAllAssignments" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "query", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.SearchAllAssignmentsAsyncPager", + "shortName": "search_all_assignments" + }, + "description": "Sample for SearchAllAssignments", + "file": "bigqueryreservation_v1_generated_reservation_service_search_all_assignments_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_SearchAllAssignments_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": "bigqueryreservation_v1_generated_reservation_service_search_all_assignments_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.search_all_assignments", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "SearchAllAssignments" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "query", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.SearchAllAssignmentsPager", + "shortName": "search_all_assignments" + }, + "description": "Sample for SearchAllAssignments", + "file": "bigqueryreservation_v1_generated_reservation_service_search_all_assignments_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_SearchAllAssignments_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": "bigqueryreservation_v1_generated_reservation_service_search_all_assignments_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.search_assignments", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "SearchAssignments" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.SearchAssignmentsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "query", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.SearchAssignmentsAsyncPager", + "shortName": "search_assignments" + }, + "description": "Sample for SearchAssignments", + "file": "bigqueryreservation_v1_generated_reservation_service_search_assignments_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_SearchAssignments_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": "bigqueryreservation_v1_generated_reservation_service_search_assignments_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.search_assignments", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "SearchAssignments" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.SearchAssignmentsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "query", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.SearchAssignmentsPager", + "shortName": "search_assignments" + }, + "description": "Sample for SearchAssignments", + "file": "bigqueryreservation_v1_generated_reservation_service_search_assignments_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_SearchAssignments_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": "bigqueryreservation_v1_generated_reservation_service_search_assignments_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.set_iam_policy", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.SetIamPolicy", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "SetIamPolicy" + }, + "parameters": [ + { + "name": "request", + "type": "google.iam.v1.iam_policy_pb2.SetIamPolicyRequest" + }, + { + "name": "resource", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.iam.v1.policy_pb2.Policy", + "shortName": "set_iam_policy" + }, + "description": "Sample for SetIamPolicy", + "file": "bigqueryreservation_v1_generated_reservation_service_set_iam_policy_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_SetIamPolicy_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 41, + "start": 39, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 42, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "bigqueryreservation_v1_generated_reservation_service_set_iam_policy_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.set_iam_policy", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.SetIamPolicy", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "SetIamPolicy" + }, + "parameters": [ + { + "name": "request", + "type": "google.iam.v1.iam_policy_pb2.SetIamPolicyRequest" + }, + { + "name": "resource", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.iam.v1.policy_pb2.Policy", + "shortName": "set_iam_policy" + }, + "description": "Sample for SetIamPolicy", + "file": "bigqueryreservation_v1_generated_reservation_service_set_iam_policy_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_SetIamPolicy_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 41, + "start": 39, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 42, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "bigqueryreservation_v1_generated_reservation_service_set_iam_policy_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.split_capacity_commitment", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "SplitCapacityCommitment" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.SplitCapacityCommitmentRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "slot_count", + "type": "int" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.SplitCapacityCommitmentResponse", + "shortName": "split_capacity_commitment" + }, + "description": "Sample for SplitCapacityCommitment", + "file": "bigqueryreservation_v1_generated_reservation_service_split_capacity_commitment_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_SplitCapacityCommitment_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": "bigqueryreservation_v1_generated_reservation_service_split_capacity_commitment_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.split_capacity_commitment", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "SplitCapacityCommitment" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.SplitCapacityCommitmentRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "slot_count", + "type": "int" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.SplitCapacityCommitmentResponse", + "shortName": "split_capacity_commitment" + }, + "description": "Sample for SplitCapacityCommitment", + "file": "bigqueryreservation_v1_generated_reservation_service_split_capacity_commitment_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_SplitCapacityCommitment_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": "bigqueryreservation_v1_generated_reservation_service_split_capacity_commitment_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.test_iam_permissions", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.TestIamPermissions", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "TestIamPermissions" + }, + "parameters": [ + { + "name": "request", + "type": "google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse", + "shortName": "test_iam_permissions" + }, + "description": "Sample for TestIamPermissions", + "file": "bigqueryreservation_v1_generated_reservation_service_test_iam_permissions_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_TestIamPermissions_async", + "segments": [ + { + "end": 53, + "start": 27, + "type": "FULL" + }, + { + "end": 53, + "start": 27, + "type": "SHORT" + }, + { + "end": 41, + "start": 39, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 47, + "start": 42, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 50, + "start": 48, + "type": "REQUEST_EXECUTION" + }, + { + "end": 54, + "start": 51, + "type": "RESPONSE_HANDLING" + } + ], + "title": "bigqueryreservation_v1_generated_reservation_service_test_iam_permissions_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.test_iam_permissions", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.TestIamPermissions", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "TestIamPermissions" + }, + "parameters": [ + { + "name": "request", + "type": "google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse", + "shortName": "test_iam_permissions" + }, + "description": "Sample for TestIamPermissions", + "file": "bigqueryreservation_v1_generated_reservation_service_test_iam_permissions_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_TestIamPermissions_sync", + "segments": [ + { + "end": 53, + "start": 27, + "type": "FULL" + }, + { + "end": 53, + "start": 27, + "type": "SHORT" + }, + { + "end": 41, + "start": 39, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 47, + "start": 42, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 50, + "start": 48, + "type": "REQUEST_EXECUTION" + }, + { + "end": 54, + "start": 51, + "type": "RESPONSE_HANDLING" + } + ], + "title": "bigqueryreservation_v1_generated_reservation_service_test_iam_permissions_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.update_assignment", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.UpdateAssignment", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "UpdateAssignment" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.UpdateAssignmentRequest" + }, + { + "name": "assignment", + "type": "google.cloud.bigquery_reservation_v1.types.Assignment" + }, + { + "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, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.Assignment", + "shortName": "update_assignment" + }, + "description": "Sample for UpdateAssignment", + "file": "bigqueryreservation_v1_generated_reservation_service_update_assignment_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_UpdateAssignment_async", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "bigqueryreservation_v1_generated_reservation_service_update_assignment_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.update_assignment", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.UpdateAssignment", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "UpdateAssignment" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.UpdateAssignmentRequest" + }, + { + "name": "assignment", + "type": "google.cloud.bigquery_reservation_v1.types.Assignment" + }, + { + "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, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.Assignment", + "shortName": "update_assignment" + }, + "description": "Sample for UpdateAssignment", + "file": "bigqueryreservation_v1_generated_reservation_service_update_assignment_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_UpdateAssignment_sync", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "bigqueryreservation_v1_generated_reservation_service_update_assignment_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.update_bi_reservation", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.UpdateBiReservation", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "UpdateBiReservation" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.UpdateBiReservationRequest" + }, + { + "name": "bi_reservation", + "type": "google.cloud.bigquery_reservation_v1.types.BiReservation" + }, + { + "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, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.BiReservation", + "shortName": "update_bi_reservation" + }, + "description": "Sample for UpdateBiReservation", + "file": "bigqueryreservation_v1_generated_reservation_service_update_bi_reservation_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_UpdateBiReservation_async", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "bigqueryreservation_v1_generated_reservation_service_update_bi_reservation_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.update_bi_reservation", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.UpdateBiReservation", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "UpdateBiReservation" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.UpdateBiReservationRequest" + }, + { + "name": "bi_reservation", + "type": "google.cloud.bigquery_reservation_v1.types.BiReservation" + }, + { + "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, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.BiReservation", + "shortName": "update_bi_reservation" + }, + "description": "Sample for UpdateBiReservation", + "file": "bigqueryreservation_v1_generated_reservation_service_update_bi_reservation_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_UpdateBiReservation_sync", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "bigqueryreservation_v1_generated_reservation_service_update_bi_reservation_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.update_capacity_commitment", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.UpdateCapacityCommitment", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "UpdateCapacityCommitment" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.UpdateCapacityCommitmentRequest" + }, + { + "name": "capacity_commitment", + "type": "google.cloud.bigquery_reservation_v1.types.CapacityCommitment" + }, + { + "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, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.CapacityCommitment", + "shortName": "update_capacity_commitment" + }, + "description": "Sample for UpdateCapacityCommitment", + "file": "bigqueryreservation_v1_generated_reservation_service_update_capacity_commitment_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_UpdateCapacityCommitment_async", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "bigqueryreservation_v1_generated_reservation_service_update_capacity_commitment_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.update_capacity_commitment", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.UpdateCapacityCommitment", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "UpdateCapacityCommitment" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.UpdateCapacityCommitmentRequest" + }, + { + "name": "capacity_commitment", + "type": "google.cloud.bigquery_reservation_v1.types.CapacityCommitment" + }, + { + "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, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.CapacityCommitment", + "shortName": "update_capacity_commitment" + }, + "description": "Sample for UpdateCapacityCommitment", + "file": "bigqueryreservation_v1_generated_reservation_service_update_capacity_commitment_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_UpdateCapacityCommitment_sync", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "bigqueryreservation_v1_generated_reservation_service_update_capacity_commitment_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.update_reservation", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.UpdateReservation", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "UpdateReservation" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.UpdateReservationRequest" + }, + { + "name": "reservation", + "type": "google.cloud.bigquery_reservation_v1.types.Reservation" + }, + { + "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, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.Reservation", + "shortName": "update_reservation" + }, + "description": "Sample for UpdateReservation", + "file": "bigqueryreservation_v1_generated_reservation_service_update_reservation_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_UpdateReservation_async", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "bigqueryreservation_v1_generated_reservation_service_update_reservation_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.update_reservation", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.UpdateReservation", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "UpdateReservation" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.UpdateReservationRequest" + }, + { + "name": "reservation", + "type": "google.cloud.bigquery_reservation_v1.types.Reservation" + }, + { + "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, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.Reservation", + "shortName": "update_reservation" + }, + "description": "Sample for UpdateReservation", + "file": "bigqueryreservation_v1_generated_reservation_service_update_reservation_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_UpdateReservation_sync", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "bigqueryreservation_v1_generated_reservation_service_update_reservation_sync.py" + } + ] +} diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/scripts/fixup_bigquery_reservation_v1_keywords.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/scripts/fixup_bigquery_reservation_v1_keywords.py new file mode 100644 index 000000000000..1bcaf6d5ab34 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/scripts/fixup_bigquery_reservation_v1_keywords.py @@ -0,0 +1,204 @@ +#! /usr/bin/env python3 +# -*- coding: utf-8 -*- +# Copyright 2025 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 bigquery_reservationCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'create_assignment': ('parent', 'assignment', 'assignment_id', ), + 'create_capacity_commitment': ('parent', 'capacity_commitment', 'enforce_single_admin_project_per_org', 'capacity_commitment_id', ), + 'create_reservation': ('parent', 'reservation_id', 'reservation', ), + 'create_reservation_group': ('parent', 'reservation_group_id', 'reservation_group', ), + 'delete_assignment': ('name', ), + 'delete_capacity_commitment': ('name', 'force', ), + 'delete_reservation': ('name', ), + 'delete_reservation_group': ('name', ), + 'failover_reservation': ('name', 'failover_mode', ), + 'get_bi_reservation': ('name', ), + 'get_capacity_commitment': ('name', ), + 'get_iam_policy': ('resource', 'options', ), + 'get_reservation': ('name', ), + 'get_reservation_group': ('name', ), + 'list_assignments': ('parent', 'page_size', 'page_token', ), + 'list_capacity_commitments': ('parent', 'page_size', 'page_token', ), + 'list_reservation_groups': ('parent', 'page_size', 'page_token', ), + 'list_reservations': ('parent', 'page_size', 'page_token', ), + 'merge_capacity_commitments': ('parent', 'capacity_commitment_ids', 'capacity_commitment_id', ), + 'move_assignment': ('name', 'destination_id', 'assignment_id', ), + 'search_all_assignments': ('parent', 'query', 'page_size', 'page_token', ), + 'search_assignments': ('parent', 'query', 'page_size', 'page_token', ), + 'set_iam_policy': ('resource', 'policy', 'update_mask', ), + 'split_capacity_commitment': ('name', 'slot_count', ), + 'test_iam_permissions': ('resource', 'permissions', ), + 'update_assignment': ('assignment', 'update_mask', ), + 'update_bi_reservation': ('bi_reservation', 'update_mask', ), + 'update_capacity_commitment': ('capacity_commitment', 'update_mask', ), + 'update_reservation': ('reservation', 'update_mask', ), + } + + 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=bigquery_reservationCallTransformer(), +): + """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 bigquery_reservation 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/google-cloud-bigquery-reservation/v1/setup.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/setup.py new file mode 100644 index 000000000000..302001c7a5df --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/setup.py @@ -0,0 +1,99 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 re + +import setuptools # type: ignore + +package_root = os.path.abspath(os.path.dirname(__file__)) + +name = 'google-cloud-bigquery-reservation' + + +description = "Google Cloud Bigquery Reservation API client library" + +version = None + +with open(os.path.join(package_root, 'google/cloud/bigquery_reservation/gapic_version.py')) as fp: + version_candidates = re.findall(r"(?<=\")\d+.\d+.\d+(?=\")", fp.read()) + assert (len(version_candidates) == 1) + version = version_candidates[0] + +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.1, <3.0.0,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*", + # Exclude incompatible versions of `google-auth` + # See https://github.com/googleapis/google-cloud-python/issues/12364 + "google-auth >= 2.14.1, <3.0.0,!=2.24.0,!=2.25.0", + "proto-plus >= 1.22.3, <2.0.0", + "proto-plus >= 1.25.0, <2.0.0; python_version >= '3.13'", + "protobuf>=3.20.2,<7.0.0,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", + "grpc-google-iam-v1 >= 0.14.0, <1.0.0", +] +extras = { +} +url = "https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-bigquery-reservation" + +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.find_namespace_packages() + if package.startswith("google") +] + +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", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.13", + "Operating System :: OS Independent", + "Topic :: Internet", + ], + platforms="Posix; MacOS X; Windows", + packages=packages, + python_requires=">=3.7", + install_requires=dependencies, + extras_require=extras, + include_package_data=True, + zip_safe=False, +) diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.10.txt b/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.10.txt new file mode 100644 index 000000000000..ad3f0fa58e2d --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.10.txt @@ -0,0 +1,7 @@ +# -*- 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 +grpc-google-iam-v1 diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.11.txt b/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.11.txt new file mode 100644 index 000000000000..ad3f0fa58e2d --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.11.txt @@ -0,0 +1,7 @@ +# -*- 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 +grpc-google-iam-v1 diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.12.txt b/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.12.txt new file mode 100644 index 000000000000..ad3f0fa58e2d --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.12.txt @@ -0,0 +1,7 @@ +# -*- 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 +grpc-google-iam-v1 diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.13.txt b/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.13.txt new file mode 100644 index 000000000000..2010e549cceb --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.13.txt @@ -0,0 +1,12 @@ +# We use the constraints file for the latest Python version +# (currently this file) to check that the latest +# major versions of dependencies are supported in setup.py. +# List all library dependencies and extras in this file. +# Require the latest major version be installed for each dependency. +# e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0", +# Then this file should have google-cloud-foo>=1 +google-api-core>=2 +google-auth>=2 +proto-plus>=1 +protobuf>=6 +grpc-google-iam-v1>=0 diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.7.txt b/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.7.txt new file mode 100644 index 000000000000..56affbd9bd75 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.7.txt @@ -0,0 +1,11 @@ +# 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.0", +# Then this file should have google-cloud-foo==1.14.0 +google-api-core==1.34.1 +google-auth==2.14.1 +proto-plus==1.22.3 +protobuf==3.20.2 +grpc-google-iam-v1==0.14.0 diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.8.txt b/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.8.txt new file mode 100644 index 000000000000..ad3f0fa58e2d --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.8.txt @@ -0,0 +1,7 @@ +# -*- 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 +grpc-google-iam-v1 diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.9.txt b/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.9.txt new file mode 100644 index 000000000000..ad3f0fa58e2d --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.9.txt @@ -0,0 +1,7 @@ +# -*- 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 +grpc-google-iam-v1 diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/tests/__init__.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/tests/__init__.py new file mode 100644 index 000000000000..191773d5572d --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/tests/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2025 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/google-cloud-bigquery-reservation/v1/tests/unit/__init__.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/tests/unit/__init__.py new file mode 100644 index 000000000000..191773d5572d --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/tests/unit/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2025 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/google-cloud-bigquery-reservation/v1/tests/unit/gapic/__init__.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/tests/unit/gapic/__init__.py new file mode 100644 index 000000000000..191773d5572d --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/tests/unit/gapic/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2025 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/google-cloud-bigquery-reservation/v1/tests/unit/gapic/bigquery_reservation_v1/__init__.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/tests/unit/gapic/bigquery_reservation_v1/__init__.py new file mode 100644 index 000000000000..191773d5572d --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/tests/unit/gapic/bigquery_reservation_v1/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2025 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/google-cloud-bigquery-reservation/v1/tests/unit/gapic/bigquery_reservation_v1/test_reservation_service.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/tests/unit/gapic/bigquery_reservation_v1/test_reservation_service.py new file mode 100644 index 000000000000..f3cfa5f09eb3 --- /dev/null +++ b/owl-bot-staging/google-cloud-bigquery-reservation/v1/tests/unit/gapic/bigquery_reservation_v1/test_reservation_service.py @@ -0,0 +1,22667 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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, AsyncIterable +from google.protobuf import json_format +import json +import math +import pytest +from google.api_core import api_core_version +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 + +try: + from google.auth.aio import credentials as ga_credentials_async + HAS_GOOGLE_AUTH_AIO = True +except ImportError: # pragma: NO COVER + HAS_GOOGLE_AUTH_AIO = False + +from google.api_core import client_options +from google.api_core import exceptions as core_exceptions +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 path_template +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.cloud.bigquery_reservation_v1.services.reservation_service import ReservationServiceAsyncClient +from google.cloud.bigquery_reservation_v1.services.reservation_service import ReservationServiceClient +from google.cloud.bigquery_reservation_v1.services.reservation_service import pagers +from google.cloud.bigquery_reservation_v1.services.reservation_service import transports +from google.cloud.bigquery_reservation_v1.types import reservation +from google.cloud.bigquery_reservation_v1.types import reservation as gcbr_reservation +from google.iam.v1 import iam_policy_pb2 # type: ignore +from google.iam.v1 import options_pb2 # type: ignore +from google.iam.v1 import policy_pb2 # type: ignore +from google.oauth2 import service_account +from google.protobuf import any_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 expr_pb2 # type: ignore +import google.auth + + + +CRED_INFO_JSON = { + "credential_source": "/path/to/file", + "credential_type": "service account credentials", + "principal": "service-account@example.com", +} +CRED_INFO_STRING = json.dumps(CRED_INFO_JSON) + + +async def mock_async_gen(data, chunk_size=1): + for i in range(0, len(data)): # pragma: NO COVER + chunk = data[i : i + chunk_size] + yield chunk.encode("utf-8") + +def client_cert_source_callback(): + return b"cert bytes", b"key bytes" + +# TODO: use async auth anon credentials by default once the minimum version of google-auth is upgraded. +# See related issue: https://github.com/googleapis/gapic-generator-python/issues/2107. +def async_anonymous_credentials(): + if HAS_GOOGLE_AUTH_AIO: + return ga_credentials_async.AnonymousCredentials() + return ga_credentials.AnonymousCredentials() + +# 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 + +# If default endpoint template is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint template so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint_template(client): + return "test.{UNIVERSE_DOMAIN}" if ("localhost" in client._DEFAULT_ENDPOINT_TEMPLATE) else client._DEFAULT_ENDPOINT_TEMPLATE + + +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 ReservationServiceClient._get_default_mtls_endpoint(None) is None + assert ReservationServiceClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + assert ReservationServiceClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint + assert ReservationServiceClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint + assert ReservationServiceClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint + assert ReservationServiceClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + +def test__read_environment_variables(): + assert ReservationServiceClient._read_environment_variables() == (False, "auto", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + assert ReservationServiceClient._read_environment_variables() == (True, "auto", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + assert ReservationServiceClient._read_environment_variables() == (False, "auto", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): + with pytest.raises(ValueError) as excinfo: + ReservationServiceClient._read_environment_variables() + assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + assert ReservationServiceClient._read_environment_variables() == (False, "never", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + assert ReservationServiceClient._read_environment_variables() == (False, "always", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}): + assert ReservationServiceClient._read_environment_variables() == (False, "auto", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError) as excinfo: + ReservationServiceClient._read_environment_variables() + assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + + with mock.patch.dict(os.environ, {"GOOGLE_CLOUD_UNIVERSE_DOMAIN": "foo.com"}): + assert ReservationServiceClient._read_environment_variables() == (False, "auto", "foo.com") + +def test__get_client_cert_source(): + mock_provided_cert_source = mock.Mock() + mock_default_cert_source = mock.Mock() + + assert ReservationServiceClient._get_client_cert_source(None, False) is None + assert ReservationServiceClient._get_client_cert_source(mock_provided_cert_source, False) is None + assert ReservationServiceClient._get_client_cert_source(mock_provided_cert_source, True) == mock_provided_cert_source + + 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_default_cert_source): + assert ReservationServiceClient._get_client_cert_source(None, True) is mock_default_cert_source + assert ReservationServiceClient._get_client_cert_source(mock_provided_cert_source, "true") is mock_provided_cert_source + +@mock.patch.object(ReservationServiceClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(ReservationServiceClient)) +@mock.patch.object(ReservationServiceAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(ReservationServiceAsyncClient)) +def test__get_api_endpoint(): + api_override = "foo.com" + mock_client_cert_source = mock.Mock() + default_universe = ReservationServiceClient._DEFAULT_UNIVERSE + default_endpoint = ReservationServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=default_universe) + mock_universe = "bar.com" + mock_endpoint = ReservationServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=mock_universe) + + assert ReservationServiceClient._get_api_endpoint(api_override, mock_client_cert_source, default_universe, "always") == api_override + assert ReservationServiceClient._get_api_endpoint(None, mock_client_cert_source, default_universe, "auto") == ReservationServiceClient.DEFAULT_MTLS_ENDPOINT + assert ReservationServiceClient._get_api_endpoint(None, None, default_universe, "auto") == default_endpoint + assert ReservationServiceClient._get_api_endpoint(None, None, default_universe, "always") == ReservationServiceClient.DEFAULT_MTLS_ENDPOINT + assert ReservationServiceClient._get_api_endpoint(None, mock_client_cert_source, default_universe, "always") == ReservationServiceClient.DEFAULT_MTLS_ENDPOINT + assert ReservationServiceClient._get_api_endpoint(None, None, mock_universe, "never") == mock_endpoint + assert ReservationServiceClient._get_api_endpoint(None, None, default_universe, "never") == default_endpoint + + with pytest.raises(MutualTLSChannelError) as excinfo: + ReservationServiceClient._get_api_endpoint(None, mock_client_cert_source, mock_universe, "auto") + assert str(excinfo.value) == "mTLS is not supported in any universe other than googleapis.com." + + +def test__get_universe_domain(): + client_universe_domain = "foo.com" + universe_domain_env = "bar.com" + + assert ReservationServiceClient._get_universe_domain(client_universe_domain, universe_domain_env) == client_universe_domain + assert ReservationServiceClient._get_universe_domain(None, universe_domain_env) == universe_domain_env + assert ReservationServiceClient._get_universe_domain(None, None) == ReservationServiceClient._DEFAULT_UNIVERSE + + with pytest.raises(ValueError) as excinfo: + ReservationServiceClient._get_universe_domain("", None) + assert str(excinfo.value) == "Universe Domain cannot be an empty string." + +@pytest.mark.parametrize("error_code,cred_info_json,show_cred_info", [ + (401, CRED_INFO_JSON, True), + (403, CRED_INFO_JSON, True), + (404, CRED_INFO_JSON, True), + (500, CRED_INFO_JSON, False), + (401, None, False), + (403, None, False), + (404, None, False), + (500, None, False) +]) +def test__add_cred_info_for_auth_errors(error_code, cred_info_json, show_cred_info): + cred = mock.Mock(["get_cred_info"]) + cred.get_cred_info = mock.Mock(return_value=cred_info_json) + client = ReservationServiceClient(credentials=cred) + client._transport._credentials = cred + + error = core_exceptions.GoogleAPICallError("message", details=["foo"]) + error.code = error_code + + client._add_cred_info_for_auth_errors(error) + if show_cred_info: + assert error.details == ["foo", CRED_INFO_STRING] + else: + assert error.details == ["foo"] + +@pytest.mark.parametrize("error_code", [401,403,404,500]) +def test__add_cred_info_for_auth_errors_no_get_cred_info(error_code): + cred = mock.Mock([]) + assert not hasattr(cred, "get_cred_info") + client = ReservationServiceClient(credentials=cred) + client._transport._credentials = cred + + error = core_exceptions.GoogleAPICallError("message", details=[]) + error.code = error_code + + client._add_cred_info_for_auth_errors(error) + assert error.details == [] + +@pytest.mark.parametrize("client_class,transport_name", [ + (ReservationServiceClient, "grpc"), + (ReservationServiceAsyncClient, "grpc_asyncio"), + (ReservationServiceClient, "rest"), +]) +def test_reservation_service_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 == ( + 'bigqueryreservation.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://bigqueryreservation.googleapis.com' + ) + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.ReservationServiceGrpcTransport, "grpc"), + (transports.ReservationServiceGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.ReservationServiceRestTransport, "rest"), +]) +def test_reservation_service_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", [ + (ReservationServiceClient, "grpc"), + (ReservationServiceAsyncClient, "grpc_asyncio"), + (ReservationServiceClient, "rest"), +]) +def test_reservation_service_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 == ( + 'bigqueryreservation.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://bigqueryreservation.googleapis.com' + ) + + +def test_reservation_service_client_get_transport_class(): + transport = ReservationServiceClient.get_transport_class() + available_transports = [ + transports.ReservationServiceGrpcTransport, + transports.ReservationServiceRestTransport, + ] + assert transport in available_transports + + transport = ReservationServiceClient.get_transport_class("grpc") + assert transport == transports.ReservationServiceGrpcTransport + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (ReservationServiceClient, transports.ReservationServiceGrpcTransport, "grpc"), + (ReservationServiceAsyncClient, transports.ReservationServiceGrpcAsyncIOTransport, "grpc_asyncio"), + (ReservationServiceClient, transports.ReservationServiceRestTransport, "rest"), +]) +@mock.patch.object(ReservationServiceClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(ReservationServiceClient)) +@mock.patch.object(ReservationServiceAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(ReservationServiceAsyncClient)) +def test_reservation_service_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(ReservationServiceClient, '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(ReservationServiceClient, '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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + 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) as excinfo: + client = client_class(transport=transport_name) + assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + + # 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) as excinfo: + client = client_class(transport=transport_name) + assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + + # 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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + 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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + 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", [ + (ReservationServiceClient, transports.ReservationServiceGrpcTransport, "grpc", "true"), + (ReservationServiceAsyncClient, transports.ReservationServiceGrpcAsyncIOTransport, "grpc_asyncio", "true"), + (ReservationServiceClient, transports.ReservationServiceGrpcTransport, "grpc", "false"), + (ReservationServiceAsyncClient, transports.ReservationServiceGrpcAsyncIOTransport, "grpc_asyncio", "false"), + (ReservationServiceClient, transports.ReservationServiceRestTransport, "rest", "true"), + (ReservationServiceClient, transports.ReservationServiceRestTransport, "rest", "false"), +]) +@mock.patch.object(ReservationServiceClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(ReservationServiceClient)) +@mock.patch.object(ReservationServiceAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(ReservationServiceAsyncClient)) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_reservation_service_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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE) + 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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE) + 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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + 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", [ + ReservationServiceClient, ReservationServiceAsyncClient +]) +@mock.patch.object(ReservationServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(ReservationServiceClient)) +@mock.patch.object(ReservationServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(ReservationServiceAsyncClient)) +def test_reservation_service_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 + + # 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) as excinfo: + client_class.get_mtls_endpoint_and_cert_source() + + assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + + # 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) as excinfo: + client_class.get_mtls_endpoint_and_cert_source() + + assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + +@pytest.mark.parametrize("client_class", [ + ReservationServiceClient, ReservationServiceAsyncClient +]) +@mock.patch.object(ReservationServiceClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(ReservationServiceClient)) +@mock.patch.object(ReservationServiceAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(ReservationServiceAsyncClient)) +def test_reservation_service_client_client_api_endpoint(client_class): + mock_client_cert_source = client_cert_source_callback + api_override = "foo.com" + default_universe = ReservationServiceClient._DEFAULT_UNIVERSE + default_endpoint = ReservationServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=default_universe) + mock_universe = "bar.com" + mock_endpoint = ReservationServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=mock_universe) + + # If ClientOptions.api_endpoint is set and GOOGLE_API_USE_CLIENT_CERTIFICATE="true", + # use ClientOptions.api_endpoint as the api endpoint regardless. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel"): + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=api_override) + client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == api_override + + # If ClientOptions.api_endpoint is not set and GOOGLE_API_USE_MTLS_ENDPOINT="never", + # use the _DEFAULT_ENDPOINT_TEMPLATE populated with GDU as the api endpoint. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + client = client_class(credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == default_endpoint + + # If ClientOptions.api_endpoint is not set and GOOGLE_API_USE_MTLS_ENDPOINT="always", + # use the DEFAULT_MTLS_ENDPOINT as the api endpoint. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + client = client_class(credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + + # If ClientOptions.api_endpoint is not set, GOOGLE_API_USE_MTLS_ENDPOINT="auto" (default), + # GOOGLE_API_USE_CLIENT_CERTIFICATE="false" (default), default cert source doesn't exist, + # and ClientOptions.universe_domain="bar.com", + # use the _DEFAULT_ENDPOINT_TEMPLATE populated with universe domain as the api endpoint. + options = client_options.ClientOptions() + universe_exists = hasattr(options, "universe_domain") + if universe_exists: + options = client_options.ClientOptions(universe_domain=mock_universe) + client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) + else: + client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == (mock_endpoint if universe_exists else default_endpoint) + assert client.universe_domain == (mock_universe if universe_exists else default_universe) + + # If ClientOptions does not have a universe domain attribute and GOOGLE_API_USE_MTLS_ENDPOINT="never", + # use the _DEFAULT_ENDPOINT_TEMPLATE populated with GDU as the api endpoint. + options = client_options.ClientOptions() + if hasattr(options, "universe_domain"): + delattr(options, "universe_domain") + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == default_endpoint + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (ReservationServiceClient, transports.ReservationServiceGrpcTransport, "grpc"), + (ReservationServiceAsyncClient, transports.ReservationServiceGrpcAsyncIOTransport, "grpc_asyncio"), + (ReservationServiceClient, transports.ReservationServiceRestTransport, "rest"), +]) +def test_reservation_service_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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + 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", [ + (ReservationServiceClient, transports.ReservationServiceGrpcTransport, "grpc", grpc_helpers), + (ReservationServiceAsyncClient, transports.ReservationServiceGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), + (ReservationServiceClient, transports.ReservationServiceRestTransport, "rest", None), +]) +def test_reservation_service_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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + 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_reservation_service_client_client_options_from_dict(): + with mock.patch('google.cloud.bigquery_reservation_v1.services.reservation_service.transports.ReservationServiceGrpcTransport.__init__') as grpc_transport: + grpc_transport.return_value = None + client = ReservationServiceClient( + 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", [ + (ReservationServiceClient, transports.ReservationServiceGrpcTransport, "grpc", grpc_helpers), + (ReservationServiceAsyncClient, transports.ReservationServiceGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), +]) +def test_reservation_service_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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + 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( + "bigqueryreservation.googleapis.com:443", + credentials=file_creds, + credentials_file=None, + quota_project_id=None, + default_scopes=( + 'https://www.googleapis.com/auth/bigquery', + 'https://www.googleapis.com/auth/cloud-platform', +), + scopes=None, + default_host="bigqueryreservation.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("request_type", [ + gcbr_reservation.CreateReservationRequest, + dict, +]) +def test_create_reservation(request_type, transport: str = 'grpc'): + client = ReservationServiceClient( + 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_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = gcbr_reservation.Reservation( + name='name_value', + slot_capacity=1391, + ignore_idle_slots=True, + concurrency=1195, + multi_region_auxiliary=True, + edition=gcbr_reservation.Edition.STANDARD, + primary_location='primary_location_value', + secondary_location='secondary_location_value', + original_primary_location='original_primary_location_value', + max_slots=986, + scaling_mode=gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + reservation_group='reservation_group_value', + ) + response = client.create_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = gcbr_reservation.CreateReservationRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, gcbr_reservation.Reservation) + assert response.name == 'name_value' + assert response.slot_capacity == 1391 + assert response.ignore_idle_slots is True + assert response.concurrency == 1195 + assert response.multi_region_auxiliary is True + assert response.edition == gcbr_reservation.Edition.STANDARD + assert response.primary_location == 'primary_location_value' + assert response.secondary_location == 'secondary_location_value' + assert response.original_primary_location == 'original_primary_location_value' + assert response.max_slots == 986 + assert response.scaling_mode == gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY + assert response.reservation_group == 'reservation_group_value' + + +def test_create_reservation_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = gcbr_reservation.CreateReservationRequest( + parent='parent_value', + reservation_id='reservation_id_value', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_reservation), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.create_reservation(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == gcbr_reservation.CreateReservationRequest( + parent='parent_value', + reservation_id='reservation_id_value', + ) + +def test_create_reservation_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.create_reservation in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.create_reservation] = mock_rpc + request = {} + client.create_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.create_reservation(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_create_reservation_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.create_reservation in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[client._client._transport.create_reservation] = mock_rpc + + request = {} + await client.create_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.create_reservation(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_create_reservation_async(transport: str = 'grpc_asyncio', request_type=gcbr_reservation.CreateReservationRequest): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + 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_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(gcbr_reservation.Reservation( + name='name_value', + slot_capacity=1391, + ignore_idle_slots=True, + concurrency=1195, + multi_region_auxiliary=True, + edition=gcbr_reservation.Edition.STANDARD, + primary_location='primary_location_value', + secondary_location='secondary_location_value', + original_primary_location='original_primary_location_value', + max_slots=986, + scaling_mode=gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + reservation_group='reservation_group_value', + )) + response = await client.create_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = gcbr_reservation.CreateReservationRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, gcbr_reservation.Reservation) + assert response.name == 'name_value' + assert response.slot_capacity == 1391 + assert response.ignore_idle_slots is True + assert response.concurrency == 1195 + assert response.multi_region_auxiliary is True + assert response.edition == gcbr_reservation.Edition.STANDARD + assert response.primary_location == 'primary_location_value' + assert response.secondary_location == 'secondary_location_value' + assert response.original_primary_location == 'original_primary_location_value' + assert response.max_slots == 986 + assert response.scaling_mode == gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY + assert response.reservation_group == 'reservation_group_value' + + +@pytest.mark.asyncio +async def test_create_reservation_async_from_dict(): + await test_create_reservation_async(request_type=dict) + +def test_create_reservation_field_headers(): + client = ReservationServiceClient( + 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 = gcbr_reservation.CreateReservationRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_reservation), + '__call__') as call: + call.return_value = gcbr_reservation.Reservation() + client.create_reservation(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_reservation_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # 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 = gcbr_reservation.CreateReservationRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_reservation), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(gcbr_reservation.Reservation()) + await client.create_reservation(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_reservation_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = gcbr_reservation.Reservation() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_reservation( + parent='parent_value', + reservation=gcbr_reservation.Reservation(name='name_value'), + reservation_id='reservation_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].reservation + mock_val = gcbr_reservation.Reservation(name='name_value') + assert arg == mock_val + arg = args[0].reservation_id + mock_val = 'reservation_id_value' + assert arg == mock_val + + +def test_create_reservation_flattened_error(): + client = ReservationServiceClient( + 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_reservation( + gcbr_reservation.CreateReservationRequest(), + parent='parent_value', + reservation=gcbr_reservation.Reservation(name='name_value'), + reservation_id='reservation_id_value', + ) + +@pytest.mark.asyncio +async def test_create_reservation_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = gcbr_reservation.Reservation() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(gcbr_reservation.Reservation()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_reservation( + parent='parent_value', + reservation=gcbr_reservation.Reservation(name='name_value'), + reservation_id='reservation_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].reservation + mock_val = gcbr_reservation.Reservation(name='name_value') + assert arg == mock_val + arg = args[0].reservation_id + mock_val = 'reservation_id_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_create_reservation_flattened_error_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.create_reservation( + gcbr_reservation.CreateReservationRequest(), + parent='parent_value', + reservation=gcbr_reservation.Reservation(name='name_value'), + reservation_id='reservation_id_value', + ) + + +@pytest.mark.parametrize("request_type", [ + reservation.ListReservationsRequest, + dict, +]) +def test_list_reservations(request_type, transport: str = 'grpc'): + client = ReservationServiceClient( + 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_reservations), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.ListReservationsResponse( + next_page_token='next_page_token_value', + ) + response = client.list_reservations(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = reservation.ListReservationsRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListReservationsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_reservations_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = reservation.ListReservationsRequest( + parent='parent_value', + page_token='page_token_value', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_reservations), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.list_reservations(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.ListReservationsRequest( + parent='parent_value', + page_token='page_token_value', + ) + +def test_list_reservations_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.list_reservations in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.list_reservations] = mock_rpc + request = {} + client.list_reservations(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.list_reservations(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_list_reservations_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.list_reservations in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[client._client._transport.list_reservations] = mock_rpc + + request = {} + await client.list_reservations(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.list_reservations(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_list_reservations_async(transport: str = 'grpc_asyncio', request_type=reservation.ListReservationsRequest): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + 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_reservations), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListReservationsResponse( + next_page_token='next_page_token_value', + )) + response = await client.list_reservations(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = reservation.ListReservationsRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListReservationsAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_list_reservations_async_from_dict(): + await test_list_reservations_async(request_type=dict) + +def test_list_reservations_field_headers(): + client = ReservationServiceClient( + 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 = reservation.ListReservationsRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_reservations), + '__call__') as call: + call.return_value = reservation.ListReservationsResponse() + client.list_reservations(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_reservations_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # 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 = reservation.ListReservationsRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_reservations), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListReservationsResponse()) + await client.list_reservations(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_reservations_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_reservations), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.ListReservationsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_reservations( + 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_reservations_flattened_error(): + client = ReservationServiceClient( + 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_reservations( + reservation.ListReservationsRequest(), + parent='parent_value', + ) + +@pytest.mark.asyncio +async def test_list_reservations_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_reservations), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.ListReservationsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListReservationsResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_reservations( + 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_reservations_flattened_error_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_reservations( + reservation.ListReservationsRequest(), + parent='parent_value', + ) + + +def test_list_reservations_pager(transport_name: str = "grpc"): + client = ReservationServiceClient( + 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_reservations), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.ListReservationsResponse( + reservations=[ + reservation.Reservation(), + reservation.Reservation(), + reservation.Reservation(), + ], + next_page_token='abc', + ), + reservation.ListReservationsResponse( + reservations=[], + next_page_token='def', + ), + reservation.ListReservationsResponse( + reservations=[ + reservation.Reservation(), + ], + next_page_token='ghi', + ), + reservation.ListReservationsResponse( + reservations=[ + reservation.Reservation(), + reservation.Reservation(), + ], + ), + RuntimeError, + ) + + expected_metadata = () + retry = retries.Retry() + timeout = 5 + expected_metadata = tuple(expected_metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_reservations(request={}, retry=retry, timeout=timeout) + + assert pager._metadata == expected_metadata + assert pager._retry == retry + assert pager._timeout == timeout + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, reservation.Reservation) + for i in results) +def test_list_reservations_pages(transport_name: str = "grpc"): + client = ReservationServiceClient( + 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_reservations), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.ListReservationsResponse( + reservations=[ + reservation.Reservation(), + reservation.Reservation(), + reservation.Reservation(), + ], + next_page_token='abc', + ), + reservation.ListReservationsResponse( + reservations=[], + next_page_token='def', + ), + reservation.ListReservationsResponse( + reservations=[ + reservation.Reservation(), + ], + next_page_token='ghi', + ), + reservation.ListReservationsResponse( + reservations=[ + reservation.Reservation(), + reservation.Reservation(), + ], + ), + RuntimeError, + ) + pages = list(client.list_reservations(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_reservations_async_pager(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_reservations), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.ListReservationsResponse( + reservations=[ + reservation.Reservation(), + reservation.Reservation(), + reservation.Reservation(), + ], + next_page_token='abc', + ), + reservation.ListReservationsResponse( + reservations=[], + next_page_token='def', + ), + reservation.ListReservationsResponse( + reservations=[ + reservation.Reservation(), + ], + next_page_token='ghi', + ), + reservation.ListReservationsResponse( + reservations=[ + reservation.Reservation(), + reservation.Reservation(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_reservations(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, reservation.Reservation) + for i in responses) + + +@pytest.mark.asyncio +async def test_list_reservations_async_pages(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_reservations), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.ListReservationsResponse( + reservations=[ + reservation.Reservation(), + reservation.Reservation(), + reservation.Reservation(), + ], + next_page_token='abc', + ), + reservation.ListReservationsResponse( + reservations=[], + next_page_token='def', + ), + reservation.ListReservationsResponse( + reservations=[ + reservation.Reservation(), + ], + next_page_token='ghi', + ), + reservation.ListReservationsResponse( + reservations=[ + reservation.Reservation(), + reservation.Reservation(), + ], + ), + RuntimeError, + ) + pages = [] + # Workaround issue in python 3.9 related to code coverage by adding `# pragma: no branch` + # See https://github.com/googleapis/gapic-generator-python/pull/1174#issuecomment-1025132372 + async for page_ in ( # pragma: no branch + await client.list_reservations(request={}) + ).pages: + 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", [ + reservation.GetReservationRequest, + dict, +]) +def test_get_reservation(request_type, transport: str = 'grpc'): + client = ReservationServiceClient( + 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_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.Reservation( + name='name_value', + slot_capacity=1391, + ignore_idle_slots=True, + concurrency=1195, + multi_region_auxiliary=True, + edition=reservation.Edition.STANDARD, + primary_location='primary_location_value', + secondary_location='secondary_location_value', + original_primary_location='original_primary_location_value', + max_slots=986, + scaling_mode=reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + reservation_group='reservation_group_value', + ) + response = client.get_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = reservation.GetReservationRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.Reservation) + assert response.name == 'name_value' + assert response.slot_capacity == 1391 + assert response.ignore_idle_slots is True + assert response.concurrency == 1195 + assert response.multi_region_auxiliary is True + assert response.edition == reservation.Edition.STANDARD + assert response.primary_location == 'primary_location_value' + assert response.secondary_location == 'secondary_location_value' + assert response.original_primary_location == 'original_primary_location_value' + assert response.max_slots == 986 + assert response.scaling_mode == reservation.Reservation.ScalingMode.AUTOSCALE_ONLY + assert response.reservation_group == 'reservation_group_value' + + +def test_get_reservation_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = reservation.GetReservationRequest( + name='name_value', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_reservation), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.get_reservation(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.GetReservationRequest( + name='name_value', + ) + +def test_get_reservation_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.get_reservation in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.get_reservation] = mock_rpc + request = {} + client.get_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.get_reservation(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_get_reservation_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.get_reservation in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[client._client._transport.get_reservation] = mock_rpc + + request = {} + await client.get_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.get_reservation(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_get_reservation_async(transport: str = 'grpc_asyncio', request_type=reservation.GetReservationRequest): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + 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_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.Reservation( + name='name_value', + slot_capacity=1391, + ignore_idle_slots=True, + concurrency=1195, + multi_region_auxiliary=True, + edition=reservation.Edition.STANDARD, + primary_location='primary_location_value', + secondary_location='secondary_location_value', + original_primary_location='original_primary_location_value', + max_slots=986, + scaling_mode=reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + reservation_group='reservation_group_value', + )) + response = await client.get_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = reservation.GetReservationRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.Reservation) + assert response.name == 'name_value' + assert response.slot_capacity == 1391 + assert response.ignore_idle_slots is True + assert response.concurrency == 1195 + assert response.multi_region_auxiliary is True + assert response.edition == reservation.Edition.STANDARD + assert response.primary_location == 'primary_location_value' + assert response.secondary_location == 'secondary_location_value' + assert response.original_primary_location == 'original_primary_location_value' + assert response.max_slots == 986 + assert response.scaling_mode == reservation.Reservation.ScalingMode.AUTOSCALE_ONLY + assert response.reservation_group == 'reservation_group_value' + + +@pytest.mark.asyncio +async def test_get_reservation_async_from_dict(): + await test_get_reservation_async(request_type=dict) + +def test_get_reservation_field_headers(): + client = ReservationServiceClient( + 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 = reservation.GetReservationRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_reservation), + '__call__') as call: + call.return_value = reservation.Reservation() + client.get_reservation(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_reservation_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # 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 = reservation.GetReservationRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_reservation), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Reservation()) + await client.get_reservation(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_reservation_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.Reservation() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_reservation( + 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_reservation_flattened_error(): + client = ReservationServiceClient( + 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_reservation( + reservation.GetReservationRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_get_reservation_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.Reservation() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Reservation()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_reservation( + 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_reservation_flattened_error_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_reservation( + reservation.GetReservationRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + reservation.DeleteReservationRequest, + dict, +]) +def test_delete_reservation(request_type, transport: str = 'grpc'): + client = ReservationServiceClient( + 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_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.delete_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = reservation.DeleteReservationRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_reservation_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = reservation.DeleteReservationRequest( + name='name_value', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_reservation), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.delete_reservation(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.DeleteReservationRequest( + name='name_value', + ) + +def test_delete_reservation_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.delete_reservation in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.delete_reservation] = mock_rpc + request = {} + client.delete_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.delete_reservation(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_delete_reservation_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.delete_reservation in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[client._client._transport.delete_reservation] = mock_rpc + + request = {} + await client.delete_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.delete_reservation(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_delete_reservation_async(transport: str = 'grpc_asyncio', request_type=reservation.DeleteReservationRequest): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + 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_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.delete_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = reservation.DeleteReservationRequest() + 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_reservation_async_from_dict(): + await test_delete_reservation_async(request_type=dict) + +def test_delete_reservation_field_headers(): + client = ReservationServiceClient( + 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 = reservation.DeleteReservationRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_reservation), + '__call__') as call: + call.return_value = None + client.delete_reservation(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_reservation_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # 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 = reservation.DeleteReservationRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_reservation), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_reservation(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_reservation_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.delete_reservation( + 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_reservation_flattened_error(): + client = ReservationServiceClient( + 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_reservation( + reservation.DeleteReservationRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_delete_reservation_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.delete_reservation( + 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_reservation_flattened_error_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.delete_reservation( + reservation.DeleteReservationRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + gcbr_reservation.UpdateReservationRequest, + dict, +]) +def test_update_reservation(request_type, transport: str = 'grpc'): + client = ReservationServiceClient( + 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_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = gcbr_reservation.Reservation( + name='name_value', + slot_capacity=1391, + ignore_idle_slots=True, + concurrency=1195, + multi_region_auxiliary=True, + edition=gcbr_reservation.Edition.STANDARD, + primary_location='primary_location_value', + secondary_location='secondary_location_value', + original_primary_location='original_primary_location_value', + max_slots=986, + scaling_mode=gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + reservation_group='reservation_group_value', + ) + response = client.update_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = gcbr_reservation.UpdateReservationRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, gcbr_reservation.Reservation) + assert response.name == 'name_value' + assert response.slot_capacity == 1391 + assert response.ignore_idle_slots is True + assert response.concurrency == 1195 + assert response.multi_region_auxiliary is True + assert response.edition == gcbr_reservation.Edition.STANDARD + assert response.primary_location == 'primary_location_value' + assert response.secondary_location == 'secondary_location_value' + assert response.original_primary_location == 'original_primary_location_value' + assert response.max_slots == 986 + assert response.scaling_mode == gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY + assert response.reservation_group == 'reservation_group_value' + + +def test_update_reservation_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = gcbr_reservation.UpdateReservationRequest( + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_reservation), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.update_reservation(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == gcbr_reservation.UpdateReservationRequest( + ) + +def test_update_reservation_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.update_reservation in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.update_reservation] = mock_rpc + request = {} + client.update_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.update_reservation(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_update_reservation_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.update_reservation in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[client._client._transport.update_reservation] = mock_rpc + + request = {} + await client.update_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.update_reservation(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_update_reservation_async(transport: str = 'grpc_asyncio', request_type=gcbr_reservation.UpdateReservationRequest): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + 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_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(gcbr_reservation.Reservation( + name='name_value', + slot_capacity=1391, + ignore_idle_slots=True, + concurrency=1195, + multi_region_auxiliary=True, + edition=gcbr_reservation.Edition.STANDARD, + primary_location='primary_location_value', + secondary_location='secondary_location_value', + original_primary_location='original_primary_location_value', + max_slots=986, + scaling_mode=gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + reservation_group='reservation_group_value', + )) + response = await client.update_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = gcbr_reservation.UpdateReservationRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, gcbr_reservation.Reservation) + assert response.name == 'name_value' + assert response.slot_capacity == 1391 + assert response.ignore_idle_slots is True + assert response.concurrency == 1195 + assert response.multi_region_auxiliary is True + assert response.edition == gcbr_reservation.Edition.STANDARD + assert response.primary_location == 'primary_location_value' + assert response.secondary_location == 'secondary_location_value' + assert response.original_primary_location == 'original_primary_location_value' + assert response.max_slots == 986 + assert response.scaling_mode == gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY + assert response.reservation_group == 'reservation_group_value' + + +@pytest.mark.asyncio +async def test_update_reservation_async_from_dict(): + await test_update_reservation_async(request_type=dict) + +def test_update_reservation_field_headers(): + client = ReservationServiceClient( + 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 = gcbr_reservation.UpdateReservationRequest() + + request.reservation.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_reservation), + '__call__') as call: + call.return_value = gcbr_reservation.Reservation() + client.update_reservation(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', + 'reservation.name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_reservation_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # 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 = gcbr_reservation.UpdateReservationRequest() + + request.reservation.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_reservation), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(gcbr_reservation.Reservation()) + await client.update_reservation(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', + 'reservation.name=name_value', + ) in kw['metadata'] + + +def test_update_reservation_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = gcbr_reservation.Reservation() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_reservation( + reservation=gcbr_reservation.Reservation(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].reservation + mock_val = gcbr_reservation.Reservation(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_reservation_flattened_error(): + client = ReservationServiceClient( + 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_reservation( + gcbr_reservation.UpdateReservationRequest(), + reservation=gcbr_reservation.Reservation(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + +@pytest.mark.asyncio +async def test_update_reservation_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = gcbr_reservation.Reservation() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(gcbr_reservation.Reservation()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_reservation( + reservation=gcbr_reservation.Reservation(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].reservation + mock_val = gcbr_reservation.Reservation(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_reservation_flattened_error_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.update_reservation( + gcbr_reservation.UpdateReservationRequest(), + reservation=gcbr_reservation.Reservation(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.parametrize("request_type", [ + reservation.FailoverReservationRequest, + dict, +]) +def test_failover_reservation(request_type, transport: str = 'grpc'): + client = ReservationServiceClient( + 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.failover_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.Reservation( + name='name_value', + slot_capacity=1391, + ignore_idle_slots=True, + concurrency=1195, + multi_region_auxiliary=True, + edition=reservation.Edition.STANDARD, + primary_location='primary_location_value', + secondary_location='secondary_location_value', + original_primary_location='original_primary_location_value', + max_slots=986, + scaling_mode=reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + reservation_group='reservation_group_value', + ) + response = client.failover_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = reservation.FailoverReservationRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.Reservation) + assert response.name == 'name_value' + assert response.slot_capacity == 1391 + assert response.ignore_idle_slots is True + assert response.concurrency == 1195 + assert response.multi_region_auxiliary is True + assert response.edition == reservation.Edition.STANDARD + assert response.primary_location == 'primary_location_value' + assert response.secondary_location == 'secondary_location_value' + assert response.original_primary_location == 'original_primary_location_value' + assert response.max_slots == 986 + assert response.scaling_mode == reservation.Reservation.ScalingMode.AUTOSCALE_ONLY + assert response.reservation_group == 'reservation_group_value' + + +def test_failover_reservation_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = reservation.FailoverReservationRequest( + name='name_value', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.failover_reservation), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.failover_reservation(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.FailoverReservationRequest( + name='name_value', + ) + +def test_failover_reservation_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.failover_reservation in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.failover_reservation] = mock_rpc + request = {} + client.failover_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.failover_reservation(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_failover_reservation_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.failover_reservation in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[client._client._transport.failover_reservation] = mock_rpc + + request = {} + await client.failover_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.failover_reservation(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_failover_reservation_async(transport: str = 'grpc_asyncio', request_type=reservation.FailoverReservationRequest): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + 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.failover_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.Reservation( + name='name_value', + slot_capacity=1391, + ignore_idle_slots=True, + concurrency=1195, + multi_region_auxiliary=True, + edition=reservation.Edition.STANDARD, + primary_location='primary_location_value', + secondary_location='secondary_location_value', + original_primary_location='original_primary_location_value', + max_slots=986, + scaling_mode=reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + reservation_group='reservation_group_value', + )) + response = await client.failover_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = reservation.FailoverReservationRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.Reservation) + assert response.name == 'name_value' + assert response.slot_capacity == 1391 + assert response.ignore_idle_slots is True + assert response.concurrency == 1195 + assert response.multi_region_auxiliary is True + assert response.edition == reservation.Edition.STANDARD + assert response.primary_location == 'primary_location_value' + assert response.secondary_location == 'secondary_location_value' + assert response.original_primary_location == 'original_primary_location_value' + assert response.max_slots == 986 + assert response.scaling_mode == reservation.Reservation.ScalingMode.AUTOSCALE_ONLY + assert response.reservation_group == 'reservation_group_value' + + +@pytest.mark.asyncio +async def test_failover_reservation_async_from_dict(): + await test_failover_reservation_async(request_type=dict) + +def test_failover_reservation_field_headers(): + client = ReservationServiceClient( + 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 = reservation.FailoverReservationRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.failover_reservation), + '__call__') as call: + call.return_value = reservation.Reservation() + client.failover_reservation(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_failover_reservation_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # 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 = reservation.FailoverReservationRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.failover_reservation), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Reservation()) + await client.failover_reservation(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", [ + reservation.CreateCapacityCommitmentRequest, + dict, +]) +def test_create_capacity_commitment(request_type, transport: str = 'grpc'): + client = ReservationServiceClient( + 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_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.CapacityCommitment( + name='name_value', + slot_count=1098, + plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + state=reservation.CapacityCommitment.State.PENDING, + renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + multi_region_auxiliary=True, + edition=reservation.Edition.STANDARD, + is_flat_rate=True, + ) + response = client.create_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = reservation.CreateCapacityCommitmentRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.CapacityCommitment) + assert response.name == 'name_value' + assert response.slot_count == 1098 + assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.state == reservation.CapacityCommitment.State.PENDING + assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.multi_region_auxiliary is True + assert response.edition == reservation.Edition.STANDARD + assert response.is_flat_rate is True + + +def test_create_capacity_commitment_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = reservation.CreateCapacityCommitmentRequest( + parent='parent_value', + capacity_commitment_id='capacity_commitment_id_value', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_capacity_commitment), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.create_capacity_commitment(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.CreateCapacityCommitmentRequest( + parent='parent_value', + capacity_commitment_id='capacity_commitment_id_value', + ) + +def test_create_capacity_commitment_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.create_capacity_commitment in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.create_capacity_commitment] = mock_rpc + request = {} + client.create_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.create_capacity_commitment(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_create_capacity_commitment_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.create_capacity_commitment in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[client._client._transport.create_capacity_commitment] = mock_rpc + + request = {} + await client.create_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.create_capacity_commitment(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_create_capacity_commitment_async(transport: str = 'grpc_asyncio', request_type=reservation.CreateCapacityCommitmentRequest): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + 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_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment( + name='name_value', + slot_count=1098, + plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + state=reservation.CapacityCommitment.State.PENDING, + renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + multi_region_auxiliary=True, + edition=reservation.Edition.STANDARD, + is_flat_rate=True, + )) + response = await client.create_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = reservation.CreateCapacityCommitmentRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.CapacityCommitment) + assert response.name == 'name_value' + assert response.slot_count == 1098 + assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.state == reservation.CapacityCommitment.State.PENDING + assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.multi_region_auxiliary is True + assert response.edition == reservation.Edition.STANDARD + assert response.is_flat_rate is True + + +@pytest.mark.asyncio +async def test_create_capacity_commitment_async_from_dict(): + await test_create_capacity_commitment_async(request_type=dict) + +def test_create_capacity_commitment_field_headers(): + client = ReservationServiceClient( + 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 = reservation.CreateCapacityCommitmentRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_capacity_commitment), + '__call__') as call: + call.return_value = reservation.CapacityCommitment() + client.create_capacity_commitment(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_capacity_commitment_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # 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 = reservation.CreateCapacityCommitmentRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_capacity_commitment), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment()) + await client.create_capacity_commitment(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_capacity_commitment_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.CapacityCommitment() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_capacity_commitment( + parent='parent_value', + capacity_commitment=reservation.CapacityCommitment(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].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].capacity_commitment + mock_val = reservation.CapacityCommitment(name='name_value') + assert arg == mock_val + + +def test_create_capacity_commitment_flattened_error(): + client = ReservationServiceClient( + 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_capacity_commitment( + reservation.CreateCapacityCommitmentRequest(), + parent='parent_value', + capacity_commitment=reservation.CapacityCommitment(name='name_value'), + ) + +@pytest.mark.asyncio +async def test_create_capacity_commitment_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.CapacityCommitment() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_capacity_commitment( + parent='parent_value', + capacity_commitment=reservation.CapacityCommitment(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].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].capacity_commitment + mock_val = reservation.CapacityCommitment(name='name_value') + assert arg == mock_val + +@pytest.mark.asyncio +async def test_create_capacity_commitment_flattened_error_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.create_capacity_commitment( + reservation.CreateCapacityCommitmentRequest(), + parent='parent_value', + capacity_commitment=reservation.CapacityCommitment(name='name_value'), + ) + + +@pytest.mark.parametrize("request_type", [ + reservation.ListCapacityCommitmentsRequest, + dict, +]) +def test_list_capacity_commitments(request_type, transport: str = 'grpc'): + client = ReservationServiceClient( + 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_capacity_commitments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.ListCapacityCommitmentsResponse( + next_page_token='next_page_token_value', + ) + response = client.list_capacity_commitments(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = reservation.ListCapacityCommitmentsRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListCapacityCommitmentsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_capacity_commitments_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = reservation.ListCapacityCommitmentsRequest( + parent='parent_value', + page_token='page_token_value', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_capacity_commitments), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.list_capacity_commitments(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.ListCapacityCommitmentsRequest( + parent='parent_value', + page_token='page_token_value', + ) + +def test_list_capacity_commitments_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.list_capacity_commitments in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.list_capacity_commitments] = mock_rpc + request = {} + client.list_capacity_commitments(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.list_capacity_commitments(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_list_capacity_commitments_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.list_capacity_commitments in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[client._client._transport.list_capacity_commitments] = mock_rpc + + request = {} + await client.list_capacity_commitments(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.list_capacity_commitments(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_list_capacity_commitments_async(transport: str = 'grpc_asyncio', request_type=reservation.ListCapacityCommitmentsRequest): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + 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_capacity_commitments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListCapacityCommitmentsResponse( + next_page_token='next_page_token_value', + )) + response = await client.list_capacity_commitments(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = reservation.ListCapacityCommitmentsRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListCapacityCommitmentsAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_list_capacity_commitments_async_from_dict(): + await test_list_capacity_commitments_async(request_type=dict) + +def test_list_capacity_commitments_field_headers(): + client = ReservationServiceClient( + 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 = reservation.ListCapacityCommitmentsRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_capacity_commitments), + '__call__') as call: + call.return_value = reservation.ListCapacityCommitmentsResponse() + client.list_capacity_commitments(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_capacity_commitments_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # 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 = reservation.ListCapacityCommitmentsRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_capacity_commitments), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListCapacityCommitmentsResponse()) + await client.list_capacity_commitments(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_capacity_commitments_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_capacity_commitments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.ListCapacityCommitmentsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_capacity_commitments( + 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_capacity_commitments_flattened_error(): + client = ReservationServiceClient( + 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_capacity_commitments( + reservation.ListCapacityCommitmentsRequest(), + parent='parent_value', + ) + +@pytest.mark.asyncio +async def test_list_capacity_commitments_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_capacity_commitments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.ListCapacityCommitmentsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListCapacityCommitmentsResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_capacity_commitments( + 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_capacity_commitments_flattened_error_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_capacity_commitments( + reservation.ListCapacityCommitmentsRequest(), + parent='parent_value', + ) + + +def test_list_capacity_commitments_pager(transport_name: str = "grpc"): + client = ReservationServiceClient( + 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_capacity_commitments), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[ + reservation.CapacityCommitment(), + reservation.CapacityCommitment(), + reservation.CapacityCommitment(), + ], + next_page_token='abc', + ), + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[], + next_page_token='def', + ), + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[ + reservation.CapacityCommitment(), + ], + next_page_token='ghi', + ), + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[ + reservation.CapacityCommitment(), + reservation.CapacityCommitment(), + ], + ), + RuntimeError, + ) + + expected_metadata = () + retry = retries.Retry() + timeout = 5 + expected_metadata = tuple(expected_metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_capacity_commitments(request={}, retry=retry, timeout=timeout) + + assert pager._metadata == expected_metadata + assert pager._retry == retry + assert pager._timeout == timeout + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, reservation.CapacityCommitment) + for i in results) +def test_list_capacity_commitments_pages(transport_name: str = "grpc"): + client = ReservationServiceClient( + 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_capacity_commitments), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[ + reservation.CapacityCommitment(), + reservation.CapacityCommitment(), + reservation.CapacityCommitment(), + ], + next_page_token='abc', + ), + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[], + next_page_token='def', + ), + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[ + reservation.CapacityCommitment(), + ], + next_page_token='ghi', + ), + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[ + reservation.CapacityCommitment(), + reservation.CapacityCommitment(), + ], + ), + RuntimeError, + ) + pages = list(client.list_capacity_commitments(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_capacity_commitments_async_pager(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_capacity_commitments), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[ + reservation.CapacityCommitment(), + reservation.CapacityCommitment(), + reservation.CapacityCommitment(), + ], + next_page_token='abc', + ), + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[], + next_page_token='def', + ), + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[ + reservation.CapacityCommitment(), + ], + next_page_token='ghi', + ), + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[ + reservation.CapacityCommitment(), + reservation.CapacityCommitment(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_capacity_commitments(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, reservation.CapacityCommitment) + for i in responses) + + +@pytest.mark.asyncio +async def test_list_capacity_commitments_async_pages(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_capacity_commitments), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[ + reservation.CapacityCommitment(), + reservation.CapacityCommitment(), + reservation.CapacityCommitment(), + ], + next_page_token='abc', + ), + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[], + next_page_token='def', + ), + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[ + reservation.CapacityCommitment(), + ], + next_page_token='ghi', + ), + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[ + reservation.CapacityCommitment(), + reservation.CapacityCommitment(), + ], + ), + RuntimeError, + ) + pages = [] + # Workaround issue in python 3.9 related to code coverage by adding `# pragma: no branch` + # See https://github.com/googleapis/gapic-generator-python/pull/1174#issuecomment-1025132372 + async for page_ in ( # pragma: no branch + await client.list_capacity_commitments(request={}) + ).pages: + 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", [ + reservation.GetCapacityCommitmentRequest, + dict, +]) +def test_get_capacity_commitment(request_type, transport: str = 'grpc'): + client = ReservationServiceClient( + 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_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.CapacityCommitment( + name='name_value', + slot_count=1098, + plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + state=reservation.CapacityCommitment.State.PENDING, + renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + multi_region_auxiliary=True, + edition=reservation.Edition.STANDARD, + is_flat_rate=True, + ) + response = client.get_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = reservation.GetCapacityCommitmentRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.CapacityCommitment) + assert response.name == 'name_value' + assert response.slot_count == 1098 + assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.state == reservation.CapacityCommitment.State.PENDING + assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.multi_region_auxiliary is True + assert response.edition == reservation.Edition.STANDARD + assert response.is_flat_rate is True + + +def test_get_capacity_commitment_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = reservation.GetCapacityCommitmentRequest( + name='name_value', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_capacity_commitment), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.get_capacity_commitment(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.GetCapacityCommitmentRequest( + name='name_value', + ) + +def test_get_capacity_commitment_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.get_capacity_commitment in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.get_capacity_commitment] = mock_rpc + request = {} + client.get_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.get_capacity_commitment(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_get_capacity_commitment_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.get_capacity_commitment in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[client._client._transport.get_capacity_commitment] = mock_rpc + + request = {} + await client.get_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.get_capacity_commitment(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_get_capacity_commitment_async(transport: str = 'grpc_asyncio', request_type=reservation.GetCapacityCommitmentRequest): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + 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_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment( + name='name_value', + slot_count=1098, + plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + state=reservation.CapacityCommitment.State.PENDING, + renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + multi_region_auxiliary=True, + edition=reservation.Edition.STANDARD, + is_flat_rate=True, + )) + response = await client.get_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = reservation.GetCapacityCommitmentRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.CapacityCommitment) + assert response.name == 'name_value' + assert response.slot_count == 1098 + assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.state == reservation.CapacityCommitment.State.PENDING + assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.multi_region_auxiliary is True + assert response.edition == reservation.Edition.STANDARD + assert response.is_flat_rate is True + + +@pytest.mark.asyncio +async def test_get_capacity_commitment_async_from_dict(): + await test_get_capacity_commitment_async(request_type=dict) + +def test_get_capacity_commitment_field_headers(): + client = ReservationServiceClient( + 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 = reservation.GetCapacityCommitmentRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_capacity_commitment), + '__call__') as call: + call.return_value = reservation.CapacityCommitment() + client.get_capacity_commitment(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_capacity_commitment_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # 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 = reservation.GetCapacityCommitmentRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_capacity_commitment), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment()) + await client.get_capacity_commitment(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_capacity_commitment_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.CapacityCommitment() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_capacity_commitment( + 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_capacity_commitment_flattened_error(): + client = ReservationServiceClient( + 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_capacity_commitment( + reservation.GetCapacityCommitmentRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_get_capacity_commitment_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.CapacityCommitment() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_capacity_commitment( + 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_capacity_commitment_flattened_error_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_capacity_commitment( + reservation.GetCapacityCommitmentRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + reservation.DeleteCapacityCommitmentRequest, + dict, +]) +def test_delete_capacity_commitment(request_type, transport: str = 'grpc'): + client = ReservationServiceClient( + 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_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.delete_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = reservation.DeleteCapacityCommitmentRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_capacity_commitment_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = reservation.DeleteCapacityCommitmentRequest( + name='name_value', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_capacity_commitment), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.delete_capacity_commitment(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.DeleteCapacityCommitmentRequest( + name='name_value', + ) + +def test_delete_capacity_commitment_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.delete_capacity_commitment in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.delete_capacity_commitment] = mock_rpc + request = {} + client.delete_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.delete_capacity_commitment(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_delete_capacity_commitment_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.delete_capacity_commitment in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[client._client._transport.delete_capacity_commitment] = mock_rpc + + request = {} + await client.delete_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.delete_capacity_commitment(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_delete_capacity_commitment_async(transport: str = 'grpc_asyncio', request_type=reservation.DeleteCapacityCommitmentRequest): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + 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_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.delete_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = reservation.DeleteCapacityCommitmentRequest() + 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_capacity_commitment_async_from_dict(): + await test_delete_capacity_commitment_async(request_type=dict) + +def test_delete_capacity_commitment_field_headers(): + client = ReservationServiceClient( + 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 = reservation.DeleteCapacityCommitmentRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_capacity_commitment), + '__call__') as call: + call.return_value = None + client.delete_capacity_commitment(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_capacity_commitment_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # 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 = reservation.DeleteCapacityCommitmentRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_capacity_commitment), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_capacity_commitment(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_capacity_commitment_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.delete_capacity_commitment( + 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_capacity_commitment_flattened_error(): + client = ReservationServiceClient( + 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_capacity_commitment( + reservation.DeleteCapacityCommitmentRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_delete_capacity_commitment_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.delete_capacity_commitment( + 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_capacity_commitment_flattened_error_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.delete_capacity_commitment( + reservation.DeleteCapacityCommitmentRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + reservation.UpdateCapacityCommitmentRequest, + dict, +]) +def test_update_capacity_commitment(request_type, transport: str = 'grpc'): + client = ReservationServiceClient( + 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_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.CapacityCommitment( + name='name_value', + slot_count=1098, + plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + state=reservation.CapacityCommitment.State.PENDING, + renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + multi_region_auxiliary=True, + edition=reservation.Edition.STANDARD, + is_flat_rate=True, + ) + response = client.update_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = reservation.UpdateCapacityCommitmentRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.CapacityCommitment) + assert response.name == 'name_value' + assert response.slot_count == 1098 + assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.state == reservation.CapacityCommitment.State.PENDING + assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.multi_region_auxiliary is True + assert response.edition == reservation.Edition.STANDARD + assert response.is_flat_rate is True + + +def test_update_capacity_commitment_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = reservation.UpdateCapacityCommitmentRequest( + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_capacity_commitment), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.update_capacity_commitment(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.UpdateCapacityCommitmentRequest( + ) + +def test_update_capacity_commitment_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.update_capacity_commitment in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.update_capacity_commitment] = mock_rpc + request = {} + client.update_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.update_capacity_commitment(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_update_capacity_commitment_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.update_capacity_commitment in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[client._client._transport.update_capacity_commitment] = mock_rpc + + request = {} + await client.update_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.update_capacity_commitment(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_update_capacity_commitment_async(transport: str = 'grpc_asyncio', request_type=reservation.UpdateCapacityCommitmentRequest): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + 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_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment( + name='name_value', + slot_count=1098, + plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + state=reservation.CapacityCommitment.State.PENDING, + renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + multi_region_auxiliary=True, + edition=reservation.Edition.STANDARD, + is_flat_rate=True, + )) + response = await client.update_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = reservation.UpdateCapacityCommitmentRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.CapacityCommitment) + assert response.name == 'name_value' + assert response.slot_count == 1098 + assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.state == reservation.CapacityCommitment.State.PENDING + assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.multi_region_auxiliary is True + assert response.edition == reservation.Edition.STANDARD + assert response.is_flat_rate is True + + +@pytest.mark.asyncio +async def test_update_capacity_commitment_async_from_dict(): + await test_update_capacity_commitment_async(request_type=dict) + +def test_update_capacity_commitment_field_headers(): + client = ReservationServiceClient( + 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 = reservation.UpdateCapacityCommitmentRequest() + + request.capacity_commitment.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_capacity_commitment), + '__call__') as call: + call.return_value = reservation.CapacityCommitment() + client.update_capacity_commitment(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', + 'capacity_commitment.name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_capacity_commitment_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # 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 = reservation.UpdateCapacityCommitmentRequest() + + request.capacity_commitment.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_capacity_commitment), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment()) + await client.update_capacity_commitment(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', + 'capacity_commitment.name=name_value', + ) in kw['metadata'] + + +def test_update_capacity_commitment_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.CapacityCommitment() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_capacity_commitment( + capacity_commitment=reservation.CapacityCommitment(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].capacity_commitment + mock_val = reservation.CapacityCommitment(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_capacity_commitment_flattened_error(): + client = ReservationServiceClient( + 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_capacity_commitment( + reservation.UpdateCapacityCommitmentRequest(), + capacity_commitment=reservation.CapacityCommitment(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + +@pytest.mark.asyncio +async def test_update_capacity_commitment_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.CapacityCommitment() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_capacity_commitment( + capacity_commitment=reservation.CapacityCommitment(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].capacity_commitment + mock_val = reservation.CapacityCommitment(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_capacity_commitment_flattened_error_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.update_capacity_commitment( + reservation.UpdateCapacityCommitmentRequest(), + capacity_commitment=reservation.CapacityCommitment(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.parametrize("request_type", [ + reservation.SplitCapacityCommitmentRequest, + dict, +]) +def test_split_capacity_commitment(request_type, transport: str = 'grpc'): + client = ReservationServiceClient( + 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.split_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.SplitCapacityCommitmentResponse( + ) + response = client.split_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = reservation.SplitCapacityCommitmentRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.SplitCapacityCommitmentResponse) + + +def test_split_capacity_commitment_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = reservation.SplitCapacityCommitmentRequest( + name='name_value', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.split_capacity_commitment), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.split_capacity_commitment(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.SplitCapacityCommitmentRequest( + name='name_value', + ) + +def test_split_capacity_commitment_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.split_capacity_commitment in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.split_capacity_commitment] = mock_rpc + request = {} + client.split_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.split_capacity_commitment(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_split_capacity_commitment_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.split_capacity_commitment in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[client._client._transport.split_capacity_commitment] = mock_rpc + + request = {} + await client.split_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.split_capacity_commitment(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_split_capacity_commitment_async(transport: str = 'grpc_asyncio', request_type=reservation.SplitCapacityCommitmentRequest): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + 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.split_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.SplitCapacityCommitmentResponse( + )) + response = await client.split_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = reservation.SplitCapacityCommitmentRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.SplitCapacityCommitmentResponse) + + +@pytest.mark.asyncio +async def test_split_capacity_commitment_async_from_dict(): + await test_split_capacity_commitment_async(request_type=dict) + +def test_split_capacity_commitment_field_headers(): + client = ReservationServiceClient( + 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 = reservation.SplitCapacityCommitmentRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.split_capacity_commitment), + '__call__') as call: + call.return_value = reservation.SplitCapacityCommitmentResponse() + client.split_capacity_commitment(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_split_capacity_commitment_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # 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 = reservation.SplitCapacityCommitmentRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.split_capacity_commitment), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.SplitCapacityCommitmentResponse()) + await client.split_capacity_commitment(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_split_capacity_commitment_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.split_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.SplitCapacityCommitmentResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.split_capacity_commitment( + name='name_value', + slot_count=1098, + ) + + # 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 + arg = args[0].slot_count + mock_val = 1098 + assert arg == mock_val + + +def test_split_capacity_commitment_flattened_error(): + client = ReservationServiceClient( + 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.split_capacity_commitment( + reservation.SplitCapacityCommitmentRequest(), + name='name_value', + slot_count=1098, + ) + +@pytest.mark.asyncio +async def test_split_capacity_commitment_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.split_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.SplitCapacityCommitmentResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.SplitCapacityCommitmentResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.split_capacity_commitment( + name='name_value', + slot_count=1098, + ) + + # 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 + arg = args[0].slot_count + mock_val = 1098 + assert arg == mock_val + +@pytest.mark.asyncio +async def test_split_capacity_commitment_flattened_error_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.split_capacity_commitment( + reservation.SplitCapacityCommitmentRequest(), + name='name_value', + slot_count=1098, + ) + + +@pytest.mark.parametrize("request_type", [ + reservation.MergeCapacityCommitmentsRequest, + dict, +]) +def test_merge_capacity_commitments(request_type, transport: str = 'grpc'): + client = ReservationServiceClient( + 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.merge_capacity_commitments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.CapacityCommitment( + name='name_value', + slot_count=1098, + plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + state=reservation.CapacityCommitment.State.PENDING, + renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + multi_region_auxiliary=True, + edition=reservation.Edition.STANDARD, + is_flat_rate=True, + ) + response = client.merge_capacity_commitments(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = reservation.MergeCapacityCommitmentsRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.CapacityCommitment) + assert response.name == 'name_value' + assert response.slot_count == 1098 + assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.state == reservation.CapacityCommitment.State.PENDING + assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.multi_region_auxiliary is True + assert response.edition == reservation.Edition.STANDARD + assert response.is_flat_rate is True + + +def test_merge_capacity_commitments_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = reservation.MergeCapacityCommitmentsRequest( + parent='parent_value', + capacity_commitment_id='capacity_commitment_id_value', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.merge_capacity_commitments), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.merge_capacity_commitments(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.MergeCapacityCommitmentsRequest( + parent='parent_value', + capacity_commitment_id='capacity_commitment_id_value', + ) + +def test_merge_capacity_commitments_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.merge_capacity_commitments in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.merge_capacity_commitments] = mock_rpc + request = {} + client.merge_capacity_commitments(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.merge_capacity_commitments(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_merge_capacity_commitments_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.merge_capacity_commitments in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[client._client._transport.merge_capacity_commitments] = mock_rpc + + request = {} + await client.merge_capacity_commitments(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.merge_capacity_commitments(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_merge_capacity_commitments_async(transport: str = 'grpc_asyncio', request_type=reservation.MergeCapacityCommitmentsRequest): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + 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.merge_capacity_commitments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment( + name='name_value', + slot_count=1098, + plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + state=reservation.CapacityCommitment.State.PENDING, + renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + multi_region_auxiliary=True, + edition=reservation.Edition.STANDARD, + is_flat_rate=True, + )) + response = await client.merge_capacity_commitments(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = reservation.MergeCapacityCommitmentsRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.CapacityCommitment) + assert response.name == 'name_value' + assert response.slot_count == 1098 + assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.state == reservation.CapacityCommitment.State.PENDING + assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.multi_region_auxiliary is True + assert response.edition == reservation.Edition.STANDARD + assert response.is_flat_rate is True + + +@pytest.mark.asyncio +async def test_merge_capacity_commitments_async_from_dict(): + await test_merge_capacity_commitments_async(request_type=dict) + +def test_merge_capacity_commitments_field_headers(): + client = ReservationServiceClient( + 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 = reservation.MergeCapacityCommitmentsRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.merge_capacity_commitments), + '__call__') as call: + call.return_value = reservation.CapacityCommitment() + client.merge_capacity_commitments(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_merge_capacity_commitments_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # 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 = reservation.MergeCapacityCommitmentsRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.merge_capacity_commitments), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment()) + await client.merge_capacity_commitments(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_merge_capacity_commitments_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.merge_capacity_commitments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.CapacityCommitment() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.merge_capacity_commitments( + parent='parent_value', + capacity_commitment_ids=['capacity_commitment_ids_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].capacity_commitment_ids + mock_val = ['capacity_commitment_ids_value'] + assert arg == mock_val + + +def test_merge_capacity_commitments_flattened_error(): + client = ReservationServiceClient( + 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.merge_capacity_commitments( + reservation.MergeCapacityCommitmentsRequest(), + parent='parent_value', + capacity_commitment_ids=['capacity_commitment_ids_value'], + ) + +@pytest.mark.asyncio +async def test_merge_capacity_commitments_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.merge_capacity_commitments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.CapacityCommitment() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.merge_capacity_commitments( + parent='parent_value', + capacity_commitment_ids=['capacity_commitment_ids_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].capacity_commitment_ids + mock_val = ['capacity_commitment_ids_value'] + assert arg == mock_val + +@pytest.mark.asyncio +async def test_merge_capacity_commitments_flattened_error_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.merge_capacity_commitments( + reservation.MergeCapacityCommitmentsRequest(), + parent='parent_value', + capacity_commitment_ids=['capacity_commitment_ids_value'], + ) + + +@pytest.mark.parametrize("request_type", [ + reservation.CreateAssignmentRequest, + dict, +]) +def test_create_assignment(request_type, transport: str = 'grpc'): + client = ReservationServiceClient( + 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_assignment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.Assignment( + name='name_value', + assignee='assignee_value', + job_type=reservation.Assignment.JobType.PIPELINE, + state=reservation.Assignment.State.PENDING, + enable_gemini_in_bigquery=True, + ) + response = client.create_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = reservation.CreateAssignmentRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.Assignment) + assert response.name == 'name_value' + assert response.assignee == 'assignee_value' + assert response.job_type == reservation.Assignment.JobType.PIPELINE + assert response.state == reservation.Assignment.State.PENDING + assert response.enable_gemini_in_bigquery is True + + +def test_create_assignment_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = reservation.CreateAssignmentRequest( + parent='parent_value', + assignment_id='assignment_id_value', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_assignment), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.create_assignment(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.CreateAssignmentRequest( + parent='parent_value', + assignment_id='assignment_id_value', + ) + +def test_create_assignment_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.create_assignment in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.create_assignment] = mock_rpc + request = {} + client.create_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.create_assignment(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_create_assignment_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.create_assignment in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[client._client._transport.create_assignment] = mock_rpc + + request = {} + await client.create_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.create_assignment(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_create_assignment_async(transport: str = 'grpc_asyncio', request_type=reservation.CreateAssignmentRequest): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + 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_assignment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment( + name='name_value', + assignee='assignee_value', + job_type=reservation.Assignment.JobType.PIPELINE, + state=reservation.Assignment.State.PENDING, + enable_gemini_in_bigquery=True, + )) + response = await client.create_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = reservation.CreateAssignmentRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.Assignment) + assert response.name == 'name_value' + assert response.assignee == 'assignee_value' + assert response.job_type == reservation.Assignment.JobType.PIPELINE + assert response.state == reservation.Assignment.State.PENDING + assert response.enable_gemini_in_bigquery is True + + +@pytest.mark.asyncio +async def test_create_assignment_async_from_dict(): + await test_create_assignment_async(request_type=dict) + +def test_create_assignment_field_headers(): + client = ReservationServiceClient( + 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 = reservation.CreateAssignmentRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_assignment), + '__call__') as call: + call.return_value = reservation.Assignment() + client.create_assignment(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_assignment_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # 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 = reservation.CreateAssignmentRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_assignment), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment()) + await client.create_assignment(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_assignment_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_assignment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.Assignment() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_assignment( + parent='parent_value', + assignment=reservation.Assignment(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].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].assignment + mock_val = reservation.Assignment(name='name_value') + assert arg == mock_val + + +def test_create_assignment_flattened_error(): + client = ReservationServiceClient( + 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_assignment( + reservation.CreateAssignmentRequest(), + parent='parent_value', + assignment=reservation.Assignment(name='name_value'), + ) + +@pytest.mark.asyncio +async def test_create_assignment_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_assignment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.Assignment() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_assignment( + parent='parent_value', + assignment=reservation.Assignment(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].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].assignment + mock_val = reservation.Assignment(name='name_value') + assert arg == mock_val + +@pytest.mark.asyncio +async def test_create_assignment_flattened_error_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.create_assignment( + reservation.CreateAssignmentRequest(), + parent='parent_value', + assignment=reservation.Assignment(name='name_value'), + ) + + +@pytest.mark.parametrize("request_type", [ + reservation.ListAssignmentsRequest, + dict, +]) +def test_list_assignments(request_type, transport: str = 'grpc'): + client = ReservationServiceClient( + 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_assignments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.ListAssignmentsResponse( + next_page_token='next_page_token_value', + ) + response = client.list_assignments(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = reservation.ListAssignmentsRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListAssignmentsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_assignments_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = reservation.ListAssignmentsRequest( + parent='parent_value', + page_token='page_token_value', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_assignments), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.list_assignments(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.ListAssignmentsRequest( + parent='parent_value', + page_token='page_token_value', + ) + +def test_list_assignments_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.list_assignments in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.list_assignments] = mock_rpc + request = {} + client.list_assignments(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.list_assignments(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_list_assignments_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.list_assignments in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[client._client._transport.list_assignments] = mock_rpc + + request = {} + await client.list_assignments(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.list_assignments(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_list_assignments_async(transport: str = 'grpc_asyncio', request_type=reservation.ListAssignmentsRequest): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + 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_assignments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListAssignmentsResponse( + next_page_token='next_page_token_value', + )) + response = await client.list_assignments(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = reservation.ListAssignmentsRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListAssignmentsAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_list_assignments_async_from_dict(): + await test_list_assignments_async(request_type=dict) + +def test_list_assignments_field_headers(): + client = ReservationServiceClient( + 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 = reservation.ListAssignmentsRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_assignments), + '__call__') as call: + call.return_value = reservation.ListAssignmentsResponse() + client.list_assignments(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_assignments_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # 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 = reservation.ListAssignmentsRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_assignments), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListAssignmentsResponse()) + await client.list_assignments(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_assignments_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_assignments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.ListAssignmentsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_assignments( + 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_assignments_flattened_error(): + client = ReservationServiceClient( + 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_assignments( + reservation.ListAssignmentsRequest(), + parent='parent_value', + ) + +@pytest.mark.asyncio +async def test_list_assignments_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_assignments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.ListAssignmentsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListAssignmentsResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_assignments( + 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_assignments_flattened_error_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_assignments( + reservation.ListAssignmentsRequest(), + parent='parent_value', + ) + + +def test_list_assignments_pager(transport_name: str = "grpc"): + client = ReservationServiceClient( + 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_assignments), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.ListAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + reservation.Assignment(), + ], + next_page_token='abc', + ), + reservation.ListAssignmentsResponse( + assignments=[], + next_page_token='def', + ), + reservation.ListAssignmentsResponse( + assignments=[ + reservation.Assignment(), + ], + next_page_token='ghi', + ), + reservation.ListAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + ], + ), + RuntimeError, + ) + + expected_metadata = () + retry = retries.Retry() + timeout = 5 + expected_metadata = tuple(expected_metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_assignments(request={}, retry=retry, timeout=timeout) + + assert pager._metadata == expected_metadata + assert pager._retry == retry + assert pager._timeout == timeout + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, reservation.Assignment) + for i in results) +def test_list_assignments_pages(transport_name: str = "grpc"): + client = ReservationServiceClient( + 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_assignments), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.ListAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + reservation.Assignment(), + ], + next_page_token='abc', + ), + reservation.ListAssignmentsResponse( + assignments=[], + next_page_token='def', + ), + reservation.ListAssignmentsResponse( + assignments=[ + reservation.Assignment(), + ], + next_page_token='ghi', + ), + reservation.ListAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + ], + ), + RuntimeError, + ) + pages = list(client.list_assignments(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_assignments_async_pager(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_assignments), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.ListAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + reservation.Assignment(), + ], + next_page_token='abc', + ), + reservation.ListAssignmentsResponse( + assignments=[], + next_page_token='def', + ), + reservation.ListAssignmentsResponse( + assignments=[ + reservation.Assignment(), + ], + next_page_token='ghi', + ), + reservation.ListAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_assignments(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, reservation.Assignment) + for i in responses) + + +@pytest.mark.asyncio +async def test_list_assignments_async_pages(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_assignments), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.ListAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + reservation.Assignment(), + ], + next_page_token='abc', + ), + reservation.ListAssignmentsResponse( + assignments=[], + next_page_token='def', + ), + reservation.ListAssignmentsResponse( + assignments=[ + reservation.Assignment(), + ], + next_page_token='ghi', + ), + reservation.ListAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + ], + ), + RuntimeError, + ) + pages = [] + # Workaround issue in python 3.9 related to code coverage by adding `# pragma: no branch` + # See https://github.com/googleapis/gapic-generator-python/pull/1174#issuecomment-1025132372 + async for page_ in ( # pragma: no branch + await client.list_assignments(request={}) + ).pages: + 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", [ + reservation.DeleteAssignmentRequest, + dict, +]) +def test_delete_assignment(request_type, transport: str = 'grpc'): + client = ReservationServiceClient( + 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_assignment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.delete_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = reservation.DeleteAssignmentRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_assignment_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = reservation.DeleteAssignmentRequest( + name='name_value', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_assignment), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.delete_assignment(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.DeleteAssignmentRequest( + name='name_value', + ) + +def test_delete_assignment_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.delete_assignment in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.delete_assignment] = mock_rpc + request = {} + client.delete_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.delete_assignment(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_delete_assignment_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.delete_assignment in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[client._client._transport.delete_assignment] = mock_rpc + + request = {} + await client.delete_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.delete_assignment(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_delete_assignment_async(transport: str = 'grpc_asyncio', request_type=reservation.DeleteAssignmentRequest): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + 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_assignment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.delete_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = reservation.DeleteAssignmentRequest() + 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_assignment_async_from_dict(): + await test_delete_assignment_async(request_type=dict) + +def test_delete_assignment_field_headers(): + client = ReservationServiceClient( + 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 = reservation.DeleteAssignmentRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_assignment), + '__call__') as call: + call.return_value = None + client.delete_assignment(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_assignment_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # 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 = reservation.DeleteAssignmentRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_assignment), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_assignment(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_assignment_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_assignment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.delete_assignment( + 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_assignment_flattened_error(): + client = ReservationServiceClient( + 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_assignment( + reservation.DeleteAssignmentRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_delete_assignment_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_assignment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.delete_assignment( + 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_assignment_flattened_error_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.delete_assignment( + reservation.DeleteAssignmentRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + reservation.SearchAssignmentsRequest, + dict, +]) +def test_search_assignments(request_type, transport: str = 'grpc'): + client = ReservationServiceClient( + 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.search_assignments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.SearchAssignmentsResponse( + next_page_token='next_page_token_value', + ) + response = client.search_assignments(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = reservation.SearchAssignmentsRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.SearchAssignmentsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_search_assignments_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = reservation.SearchAssignmentsRequest( + parent='parent_value', + query='query_value', + page_token='page_token_value', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_assignments), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.search_assignments(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.SearchAssignmentsRequest( + parent='parent_value', + query='query_value', + page_token='page_token_value', + ) + +def test_search_assignments_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.search_assignments in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.search_assignments] = mock_rpc + request = {} + client.search_assignments(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.search_assignments(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_search_assignments_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.search_assignments in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[client._client._transport.search_assignments] = mock_rpc + + request = {} + await client.search_assignments(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.search_assignments(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_search_assignments_async(transport: str = 'grpc_asyncio', request_type=reservation.SearchAssignmentsRequest): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + 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.search_assignments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.SearchAssignmentsResponse( + next_page_token='next_page_token_value', + )) + response = await client.search_assignments(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = reservation.SearchAssignmentsRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.SearchAssignmentsAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_search_assignments_async_from_dict(): + await test_search_assignments_async(request_type=dict) + +def test_search_assignments_field_headers(): + client = ReservationServiceClient( + 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 = reservation.SearchAssignmentsRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_assignments), + '__call__') as call: + call.return_value = reservation.SearchAssignmentsResponse() + client.search_assignments(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_search_assignments_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # 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 = reservation.SearchAssignmentsRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_assignments), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.SearchAssignmentsResponse()) + await client.search_assignments(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_search_assignments_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_assignments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.SearchAssignmentsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.search_assignments( + parent='parent_value', + query='query_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].query + mock_val = 'query_value' + assert arg == mock_val + + +def test_search_assignments_flattened_error(): + client = ReservationServiceClient( + 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.search_assignments( + reservation.SearchAssignmentsRequest(), + parent='parent_value', + query='query_value', + ) + +@pytest.mark.asyncio +async def test_search_assignments_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_assignments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.SearchAssignmentsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.SearchAssignmentsResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.search_assignments( + parent='parent_value', + query='query_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].query + mock_val = 'query_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_search_assignments_flattened_error_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.search_assignments( + reservation.SearchAssignmentsRequest(), + parent='parent_value', + query='query_value', + ) + + +def test_search_assignments_pager(transport_name: str = "grpc"): + client = ReservationServiceClient( + 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.search_assignments), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.SearchAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + reservation.Assignment(), + ], + next_page_token='abc', + ), + reservation.SearchAssignmentsResponse( + assignments=[], + next_page_token='def', + ), + reservation.SearchAssignmentsResponse( + assignments=[ + reservation.Assignment(), + ], + next_page_token='ghi', + ), + reservation.SearchAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + ], + ), + RuntimeError, + ) + + expected_metadata = () + retry = retries.Retry() + timeout = 5 + expected_metadata = tuple(expected_metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.search_assignments(request={}, retry=retry, timeout=timeout) + + assert pager._metadata == expected_metadata + assert pager._retry == retry + assert pager._timeout == timeout + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, reservation.Assignment) + for i in results) +def test_search_assignments_pages(transport_name: str = "grpc"): + client = ReservationServiceClient( + 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.search_assignments), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.SearchAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + reservation.Assignment(), + ], + next_page_token='abc', + ), + reservation.SearchAssignmentsResponse( + assignments=[], + next_page_token='def', + ), + reservation.SearchAssignmentsResponse( + assignments=[ + reservation.Assignment(), + ], + next_page_token='ghi', + ), + reservation.SearchAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + ], + ), + RuntimeError, + ) + pages = list(client.search_assignments(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_search_assignments_async_pager(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_assignments), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.SearchAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + reservation.Assignment(), + ], + next_page_token='abc', + ), + reservation.SearchAssignmentsResponse( + assignments=[], + next_page_token='def', + ), + reservation.SearchAssignmentsResponse( + assignments=[ + reservation.Assignment(), + ], + next_page_token='ghi', + ), + reservation.SearchAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + ], + ), + RuntimeError, + ) + async_pager = await client.search_assignments(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, reservation.Assignment) + for i in responses) + + +@pytest.mark.asyncio +async def test_search_assignments_async_pages(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_assignments), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.SearchAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + reservation.Assignment(), + ], + next_page_token='abc', + ), + reservation.SearchAssignmentsResponse( + assignments=[], + next_page_token='def', + ), + reservation.SearchAssignmentsResponse( + assignments=[ + reservation.Assignment(), + ], + next_page_token='ghi', + ), + reservation.SearchAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + ], + ), + RuntimeError, + ) + pages = [] + # Workaround issue in python 3.9 related to code coverage by adding `# pragma: no branch` + # See https://github.com/googleapis/gapic-generator-python/pull/1174#issuecomment-1025132372 + async for page_ in ( # pragma: no branch + await client.search_assignments(request={}) + ).pages: + 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", [ + reservation.SearchAllAssignmentsRequest, + dict, +]) +def test_search_all_assignments(request_type, transport: str = 'grpc'): + client = ReservationServiceClient( + 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.search_all_assignments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.SearchAllAssignmentsResponse( + next_page_token='next_page_token_value', + ) + response = client.search_all_assignments(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = reservation.SearchAllAssignmentsRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.SearchAllAssignmentsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_search_all_assignments_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = reservation.SearchAllAssignmentsRequest( + parent='parent_value', + query='query_value', + page_token='page_token_value', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_all_assignments), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.search_all_assignments(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.SearchAllAssignmentsRequest( + parent='parent_value', + query='query_value', + page_token='page_token_value', + ) + +def test_search_all_assignments_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.search_all_assignments in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.search_all_assignments] = mock_rpc + request = {} + client.search_all_assignments(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.search_all_assignments(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_search_all_assignments_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.search_all_assignments in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[client._client._transport.search_all_assignments] = mock_rpc + + request = {} + await client.search_all_assignments(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.search_all_assignments(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_search_all_assignments_async(transport: str = 'grpc_asyncio', request_type=reservation.SearchAllAssignmentsRequest): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + 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.search_all_assignments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.SearchAllAssignmentsResponse( + next_page_token='next_page_token_value', + )) + response = await client.search_all_assignments(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = reservation.SearchAllAssignmentsRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.SearchAllAssignmentsAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_search_all_assignments_async_from_dict(): + await test_search_all_assignments_async(request_type=dict) + +def test_search_all_assignments_field_headers(): + client = ReservationServiceClient( + 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 = reservation.SearchAllAssignmentsRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_all_assignments), + '__call__') as call: + call.return_value = reservation.SearchAllAssignmentsResponse() + client.search_all_assignments(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_search_all_assignments_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # 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 = reservation.SearchAllAssignmentsRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_all_assignments), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.SearchAllAssignmentsResponse()) + await client.search_all_assignments(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_search_all_assignments_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_all_assignments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.SearchAllAssignmentsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.search_all_assignments( + parent='parent_value', + query='query_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].query + mock_val = 'query_value' + assert arg == mock_val + + +def test_search_all_assignments_flattened_error(): + client = ReservationServiceClient( + 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.search_all_assignments( + reservation.SearchAllAssignmentsRequest(), + parent='parent_value', + query='query_value', + ) + +@pytest.mark.asyncio +async def test_search_all_assignments_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_all_assignments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.SearchAllAssignmentsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.SearchAllAssignmentsResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.search_all_assignments( + parent='parent_value', + query='query_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].query + mock_val = 'query_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_search_all_assignments_flattened_error_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.search_all_assignments( + reservation.SearchAllAssignmentsRequest(), + parent='parent_value', + query='query_value', + ) + + +def test_search_all_assignments_pager(transport_name: str = "grpc"): + client = ReservationServiceClient( + 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.search_all_assignments), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.SearchAllAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + reservation.Assignment(), + ], + next_page_token='abc', + ), + reservation.SearchAllAssignmentsResponse( + assignments=[], + next_page_token='def', + ), + reservation.SearchAllAssignmentsResponse( + assignments=[ + reservation.Assignment(), + ], + next_page_token='ghi', + ), + reservation.SearchAllAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + ], + ), + RuntimeError, + ) + + expected_metadata = () + retry = retries.Retry() + timeout = 5 + expected_metadata = tuple(expected_metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.search_all_assignments(request={}, retry=retry, timeout=timeout) + + assert pager._metadata == expected_metadata + assert pager._retry == retry + assert pager._timeout == timeout + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, reservation.Assignment) + for i in results) +def test_search_all_assignments_pages(transport_name: str = "grpc"): + client = ReservationServiceClient( + 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.search_all_assignments), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.SearchAllAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + reservation.Assignment(), + ], + next_page_token='abc', + ), + reservation.SearchAllAssignmentsResponse( + assignments=[], + next_page_token='def', + ), + reservation.SearchAllAssignmentsResponse( + assignments=[ + reservation.Assignment(), + ], + next_page_token='ghi', + ), + reservation.SearchAllAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + ], + ), + RuntimeError, + ) + pages = list(client.search_all_assignments(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_search_all_assignments_async_pager(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_all_assignments), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.SearchAllAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + reservation.Assignment(), + ], + next_page_token='abc', + ), + reservation.SearchAllAssignmentsResponse( + assignments=[], + next_page_token='def', + ), + reservation.SearchAllAssignmentsResponse( + assignments=[ + reservation.Assignment(), + ], + next_page_token='ghi', + ), + reservation.SearchAllAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + ], + ), + RuntimeError, + ) + async_pager = await client.search_all_assignments(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, reservation.Assignment) + for i in responses) + + +@pytest.mark.asyncio +async def test_search_all_assignments_async_pages(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.search_all_assignments), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.SearchAllAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + reservation.Assignment(), + ], + next_page_token='abc', + ), + reservation.SearchAllAssignmentsResponse( + assignments=[], + next_page_token='def', + ), + reservation.SearchAllAssignmentsResponse( + assignments=[ + reservation.Assignment(), + ], + next_page_token='ghi', + ), + reservation.SearchAllAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + ], + ), + RuntimeError, + ) + pages = [] + # Workaround issue in python 3.9 related to code coverage by adding `# pragma: no branch` + # See https://github.com/googleapis/gapic-generator-python/pull/1174#issuecomment-1025132372 + async for page_ in ( # pragma: no branch + await client.search_all_assignments(request={}) + ).pages: + 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", [ + reservation.MoveAssignmentRequest, + dict, +]) +def test_move_assignment(request_type, transport: str = 'grpc'): + client = ReservationServiceClient( + 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.move_assignment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.Assignment( + name='name_value', + assignee='assignee_value', + job_type=reservation.Assignment.JobType.PIPELINE, + state=reservation.Assignment.State.PENDING, + enable_gemini_in_bigquery=True, + ) + response = client.move_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = reservation.MoveAssignmentRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.Assignment) + assert response.name == 'name_value' + assert response.assignee == 'assignee_value' + assert response.job_type == reservation.Assignment.JobType.PIPELINE + assert response.state == reservation.Assignment.State.PENDING + assert response.enable_gemini_in_bigquery is True + + +def test_move_assignment_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = reservation.MoveAssignmentRequest( + name='name_value', + destination_id='destination_id_value', + assignment_id='assignment_id_value', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.move_assignment), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.move_assignment(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.MoveAssignmentRequest( + name='name_value', + destination_id='destination_id_value', + assignment_id='assignment_id_value', + ) + +def test_move_assignment_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.move_assignment in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.move_assignment] = mock_rpc + request = {} + client.move_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.move_assignment(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_move_assignment_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.move_assignment in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[client._client._transport.move_assignment] = mock_rpc + + request = {} + await client.move_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.move_assignment(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_move_assignment_async(transport: str = 'grpc_asyncio', request_type=reservation.MoveAssignmentRequest): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + 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.move_assignment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment( + name='name_value', + assignee='assignee_value', + job_type=reservation.Assignment.JobType.PIPELINE, + state=reservation.Assignment.State.PENDING, + enable_gemini_in_bigquery=True, + )) + response = await client.move_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = reservation.MoveAssignmentRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.Assignment) + assert response.name == 'name_value' + assert response.assignee == 'assignee_value' + assert response.job_type == reservation.Assignment.JobType.PIPELINE + assert response.state == reservation.Assignment.State.PENDING + assert response.enable_gemini_in_bigquery is True + + +@pytest.mark.asyncio +async def test_move_assignment_async_from_dict(): + await test_move_assignment_async(request_type=dict) + +def test_move_assignment_field_headers(): + client = ReservationServiceClient( + 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 = reservation.MoveAssignmentRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.move_assignment), + '__call__') as call: + call.return_value = reservation.Assignment() + client.move_assignment(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_move_assignment_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # 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 = reservation.MoveAssignmentRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.move_assignment), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment()) + await client.move_assignment(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_move_assignment_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.move_assignment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.Assignment() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.move_assignment( + name='name_value', + destination_id='destination_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].name + mock_val = 'name_value' + assert arg == mock_val + arg = args[0].destination_id + mock_val = 'destination_id_value' + assert arg == mock_val + + +def test_move_assignment_flattened_error(): + client = ReservationServiceClient( + 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.move_assignment( + reservation.MoveAssignmentRequest(), + name='name_value', + destination_id='destination_id_value', + ) + +@pytest.mark.asyncio +async def test_move_assignment_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.move_assignment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.Assignment() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.move_assignment( + name='name_value', + destination_id='destination_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].name + mock_val = 'name_value' + assert arg == mock_val + arg = args[0].destination_id + mock_val = 'destination_id_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_move_assignment_flattened_error_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.move_assignment( + reservation.MoveAssignmentRequest(), + name='name_value', + destination_id='destination_id_value', + ) + + +@pytest.mark.parametrize("request_type", [ + reservation.UpdateAssignmentRequest, + dict, +]) +def test_update_assignment(request_type, transport: str = 'grpc'): + client = ReservationServiceClient( + 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_assignment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.Assignment( + name='name_value', + assignee='assignee_value', + job_type=reservation.Assignment.JobType.PIPELINE, + state=reservation.Assignment.State.PENDING, + enable_gemini_in_bigquery=True, + ) + response = client.update_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = reservation.UpdateAssignmentRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.Assignment) + assert response.name == 'name_value' + assert response.assignee == 'assignee_value' + assert response.job_type == reservation.Assignment.JobType.PIPELINE + assert response.state == reservation.Assignment.State.PENDING + assert response.enable_gemini_in_bigquery is True + + +def test_update_assignment_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = reservation.UpdateAssignmentRequest( + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_assignment), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.update_assignment(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.UpdateAssignmentRequest( + ) + +def test_update_assignment_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.update_assignment in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.update_assignment] = mock_rpc + request = {} + client.update_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.update_assignment(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_update_assignment_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.update_assignment in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[client._client._transport.update_assignment] = mock_rpc + + request = {} + await client.update_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.update_assignment(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_update_assignment_async(transport: str = 'grpc_asyncio', request_type=reservation.UpdateAssignmentRequest): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + 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_assignment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment( + name='name_value', + assignee='assignee_value', + job_type=reservation.Assignment.JobType.PIPELINE, + state=reservation.Assignment.State.PENDING, + enable_gemini_in_bigquery=True, + )) + response = await client.update_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = reservation.UpdateAssignmentRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.Assignment) + assert response.name == 'name_value' + assert response.assignee == 'assignee_value' + assert response.job_type == reservation.Assignment.JobType.PIPELINE + assert response.state == reservation.Assignment.State.PENDING + assert response.enable_gemini_in_bigquery is True + + +@pytest.mark.asyncio +async def test_update_assignment_async_from_dict(): + await test_update_assignment_async(request_type=dict) + +def test_update_assignment_field_headers(): + client = ReservationServiceClient( + 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 = reservation.UpdateAssignmentRequest() + + request.assignment.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_assignment), + '__call__') as call: + call.return_value = reservation.Assignment() + client.update_assignment(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', + 'assignment.name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_assignment_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # 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 = reservation.UpdateAssignmentRequest() + + request.assignment.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_assignment), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment()) + await client.update_assignment(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', + 'assignment.name=name_value', + ) in kw['metadata'] + + +def test_update_assignment_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_assignment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.Assignment() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_assignment( + assignment=reservation.Assignment(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].assignment + mock_val = reservation.Assignment(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_assignment_flattened_error(): + client = ReservationServiceClient( + 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_assignment( + reservation.UpdateAssignmentRequest(), + assignment=reservation.Assignment(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + +@pytest.mark.asyncio +async def test_update_assignment_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_assignment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.Assignment() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_assignment( + assignment=reservation.Assignment(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].assignment + mock_val = reservation.Assignment(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_assignment_flattened_error_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.update_assignment( + reservation.UpdateAssignmentRequest(), + assignment=reservation.Assignment(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.parametrize("request_type", [ + reservation.GetBiReservationRequest, + dict, +]) +def test_get_bi_reservation(request_type, transport: str = 'grpc'): + client = ReservationServiceClient( + 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_bi_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.BiReservation( + name='name_value', + size=443, + ) + response = client.get_bi_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = reservation.GetBiReservationRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.BiReservation) + assert response.name == 'name_value' + assert response.size == 443 + + +def test_get_bi_reservation_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = reservation.GetBiReservationRequest( + name='name_value', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_bi_reservation), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.get_bi_reservation(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.GetBiReservationRequest( + name='name_value', + ) + +def test_get_bi_reservation_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.get_bi_reservation in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.get_bi_reservation] = mock_rpc + request = {} + client.get_bi_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.get_bi_reservation(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_get_bi_reservation_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.get_bi_reservation in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[client._client._transport.get_bi_reservation] = mock_rpc + + request = {} + await client.get_bi_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.get_bi_reservation(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_get_bi_reservation_async(transport: str = 'grpc_asyncio', request_type=reservation.GetBiReservationRequest): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + 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_bi_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.BiReservation( + name='name_value', + size=443, + )) + response = await client.get_bi_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = reservation.GetBiReservationRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.BiReservation) + assert response.name == 'name_value' + assert response.size == 443 + + +@pytest.mark.asyncio +async def test_get_bi_reservation_async_from_dict(): + await test_get_bi_reservation_async(request_type=dict) + +def test_get_bi_reservation_field_headers(): + client = ReservationServiceClient( + 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 = reservation.GetBiReservationRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_bi_reservation), + '__call__') as call: + call.return_value = reservation.BiReservation() + client.get_bi_reservation(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_bi_reservation_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # 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 = reservation.GetBiReservationRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_bi_reservation), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.BiReservation()) + await client.get_bi_reservation(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_bi_reservation_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_bi_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.BiReservation() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_bi_reservation( + 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_bi_reservation_flattened_error(): + client = ReservationServiceClient( + 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_bi_reservation( + reservation.GetBiReservationRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_get_bi_reservation_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_bi_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.BiReservation() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.BiReservation()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_bi_reservation( + 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_bi_reservation_flattened_error_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_bi_reservation( + reservation.GetBiReservationRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + reservation.UpdateBiReservationRequest, + dict, +]) +def test_update_bi_reservation(request_type, transport: str = 'grpc'): + client = ReservationServiceClient( + 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_bi_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.BiReservation( + name='name_value', + size=443, + ) + response = client.update_bi_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = reservation.UpdateBiReservationRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.BiReservation) + assert response.name == 'name_value' + assert response.size == 443 + + +def test_update_bi_reservation_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = reservation.UpdateBiReservationRequest( + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_bi_reservation), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.update_bi_reservation(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.UpdateBiReservationRequest( + ) + +def test_update_bi_reservation_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.update_bi_reservation in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.update_bi_reservation] = mock_rpc + request = {} + client.update_bi_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.update_bi_reservation(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_update_bi_reservation_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.update_bi_reservation in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[client._client._transport.update_bi_reservation] = mock_rpc + + request = {} + await client.update_bi_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.update_bi_reservation(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_update_bi_reservation_async(transport: str = 'grpc_asyncio', request_type=reservation.UpdateBiReservationRequest): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + 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_bi_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.BiReservation( + name='name_value', + size=443, + )) + response = await client.update_bi_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = reservation.UpdateBiReservationRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.BiReservation) + assert response.name == 'name_value' + assert response.size == 443 + + +@pytest.mark.asyncio +async def test_update_bi_reservation_async_from_dict(): + await test_update_bi_reservation_async(request_type=dict) + +def test_update_bi_reservation_field_headers(): + client = ReservationServiceClient( + 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 = reservation.UpdateBiReservationRequest() + + request.bi_reservation.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_bi_reservation), + '__call__') as call: + call.return_value = reservation.BiReservation() + client.update_bi_reservation(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', + 'bi_reservation.name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_bi_reservation_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # 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 = reservation.UpdateBiReservationRequest() + + request.bi_reservation.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_bi_reservation), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.BiReservation()) + await client.update_bi_reservation(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', + 'bi_reservation.name=name_value', + ) in kw['metadata'] + + +def test_update_bi_reservation_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_bi_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.BiReservation() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_bi_reservation( + bi_reservation=reservation.BiReservation(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].bi_reservation + mock_val = reservation.BiReservation(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_bi_reservation_flattened_error(): + client = ReservationServiceClient( + 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_bi_reservation( + reservation.UpdateBiReservationRequest(), + bi_reservation=reservation.BiReservation(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + +@pytest.mark.asyncio +async def test_update_bi_reservation_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_bi_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.BiReservation() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.BiReservation()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_bi_reservation( + bi_reservation=reservation.BiReservation(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].bi_reservation + mock_val = reservation.BiReservation(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_bi_reservation_flattened_error_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.update_bi_reservation( + reservation.UpdateBiReservationRequest(), + bi_reservation=reservation.BiReservation(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.parametrize("request_type", [ + iam_policy_pb2.GetIamPolicyRequest, + dict, +]) +def test_get_iam_policy(request_type, transport: str = 'grpc'): + client = ReservationServiceClient( + 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_iam_policy), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = policy_pb2.Policy( + version=774, + etag=b'etag_blob', + ) + response = client.get_iam_policy(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = iam_policy_pb2.GetIamPolicyRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, policy_pb2.Policy) + assert response.version == 774 + assert response.etag == b'etag_blob' + + +def test_get_iam_policy_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = iam_policy_pb2.GetIamPolicyRequest( + resource='resource_value', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_iam_policy), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.get_iam_policy(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == iam_policy_pb2.GetIamPolicyRequest( + resource='resource_value', + ) + +def test_get_iam_policy_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.get_iam_policy in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.get_iam_policy] = mock_rpc + request = {} + client.get_iam_policy(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.get_iam_policy(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_get_iam_policy_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.get_iam_policy in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[client._client._transport.get_iam_policy] = mock_rpc + + request = {} + await client.get_iam_policy(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.get_iam_policy(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_get_iam_policy_async(transport: str = 'grpc_asyncio', request_type=iam_policy_pb2.GetIamPolicyRequest): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + 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_iam_policy), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy( + version=774, + etag=b'etag_blob', + )) + response = await client.get_iam_policy(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = iam_policy_pb2.GetIamPolicyRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, policy_pb2.Policy) + assert response.version == 774 + assert response.etag == b'etag_blob' + + +@pytest.mark.asyncio +async def test_get_iam_policy_async_from_dict(): + await test_get_iam_policy_async(request_type=dict) + +def test_get_iam_policy_field_headers(): + client = ReservationServiceClient( + 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 = iam_policy_pb2.GetIamPolicyRequest() + + request.resource = 'resource_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_iam_policy), + '__call__') as call: + call.return_value = policy_pb2.Policy() + client.get_iam_policy(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', + 'resource=resource_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_get_iam_policy_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # 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 = iam_policy_pb2.GetIamPolicyRequest() + + request.resource = 'resource_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_iam_policy), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy()) + await client.get_iam_policy(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', + 'resource=resource_value', + ) in kw['metadata'] + +def test_get_iam_policy_from_dict_foreign(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_iam_policy), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = policy_pb2.Policy() + response = client.get_iam_policy(request={ + 'resource': 'resource_value', + 'options': options_pb2.GetPolicyOptions(requested_policy_version=2598), + } + ) + call.assert_called() + + +def test_get_iam_policy_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_iam_policy), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = policy_pb2.Policy() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_iam_policy( + resource='resource_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].resource + mock_val = 'resource_value' + assert arg == mock_val + + +def test_get_iam_policy_flattened_error(): + client = ReservationServiceClient( + 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_iam_policy( + iam_policy_pb2.GetIamPolicyRequest(), + resource='resource_value', + ) + +@pytest.mark.asyncio +async def test_get_iam_policy_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_iam_policy), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = policy_pb2.Policy() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_iam_policy( + resource='resource_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].resource + mock_val = 'resource_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_get_iam_policy_flattened_error_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_iam_policy( + iam_policy_pb2.GetIamPolicyRequest(), + resource='resource_value', + ) + + +@pytest.mark.parametrize("request_type", [ + iam_policy_pb2.SetIamPolicyRequest, + dict, +]) +def test_set_iam_policy(request_type, transport: str = 'grpc'): + client = ReservationServiceClient( + 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.set_iam_policy), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = policy_pb2.Policy( + version=774, + etag=b'etag_blob', + ) + response = client.set_iam_policy(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = iam_policy_pb2.SetIamPolicyRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, policy_pb2.Policy) + assert response.version == 774 + assert response.etag == b'etag_blob' + + +def test_set_iam_policy_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = iam_policy_pb2.SetIamPolicyRequest( + resource='resource_value', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.set_iam_policy), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.set_iam_policy(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == iam_policy_pb2.SetIamPolicyRequest( + resource='resource_value', + ) + +def test_set_iam_policy_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.set_iam_policy in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.set_iam_policy] = mock_rpc + request = {} + client.set_iam_policy(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.set_iam_policy(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_set_iam_policy_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.set_iam_policy in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[client._client._transport.set_iam_policy] = mock_rpc + + request = {} + await client.set_iam_policy(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.set_iam_policy(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_set_iam_policy_async(transport: str = 'grpc_asyncio', request_type=iam_policy_pb2.SetIamPolicyRequest): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + 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.set_iam_policy), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy( + version=774, + etag=b'etag_blob', + )) + response = await client.set_iam_policy(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = iam_policy_pb2.SetIamPolicyRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, policy_pb2.Policy) + assert response.version == 774 + assert response.etag == b'etag_blob' + + +@pytest.mark.asyncio +async def test_set_iam_policy_async_from_dict(): + await test_set_iam_policy_async(request_type=dict) + +def test_set_iam_policy_field_headers(): + client = ReservationServiceClient( + 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 = iam_policy_pb2.SetIamPolicyRequest() + + request.resource = 'resource_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.set_iam_policy), + '__call__') as call: + call.return_value = policy_pb2.Policy() + client.set_iam_policy(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', + 'resource=resource_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_set_iam_policy_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # 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 = iam_policy_pb2.SetIamPolicyRequest() + + request.resource = 'resource_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.set_iam_policy), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy()) + await client.set_iam_policy(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', + 'resource=resource_value', + ) in kw['metadata'] + +def test_set_iam_policy_from_dict_foreign(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.set_iam_policy), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = policy_pb2.Policy() + response = client.set_iam_policy(request={ + 'resource': 'resource_value', + 'policy': policy_pb2.Policy(version=774), + 'update_mask': field_mask_pb2.FieldMask(paths=['paths_value']), + } + ) + call.assert_called() + + +def test_set_iam_policy_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.set_iam_policy), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = policy_pb2.Policy() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.set_iam_policy( + resource='resource_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].resource + mock_val = 'resource_value' + assert arg == mock_val + + +def test_set_iam_policy_flattened_error(): + client = ReservationServiceClient( + 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.set_iam_policy( + iam_policy_pb2.SetIamPolicyRequest(), + resource='resource_value', + ) + +@pytest.mark.asyncio +async def test_set_iam_policy_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.set_iam_policy), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = policy_pb2.Policy() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.set_iam_policy( + resource='resource_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].resource + mock_val = 'resource_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_set_iam_policy_flattened_error_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.set_iam_policy( + iam_policy_pb2.SetIamPolicyRequest(), + resource='resource_value', + ) + + +@pytest.mark.parametrize("request_type", [ + iam_policy_pb2.TestIamPermissionsRequest, + dict, +]) +def test_test_iam_permissions(request_type, transport: str = 'grpc'): + client = ReservationServiceClient( + 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.test_iam_permissions), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = iam_policy_pb2.TestIamPermissionsResponse( + permissions=['permissions_value'], + ) + response = client.test_iam_permissions(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = iam_policy_pb2.TestIamPermissionsRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, iam_policy_pb2.TestIamPermissionsResponse) + assert response.permissions == ['permissions_value'] + + +def test_test_iam_permissions_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = iam_policy_pb2.TestIamPermissionsRequest( + resource='resource_value', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.test_iam_permissions), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.test_iam_permissions(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == iam_policy_pb2.TestIamPermissionsRequest( + resource='resource_value', + ) + +def test_test_iam_permissions_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.test_iam_permissions in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.test_iam_permissions] = mock_rpc + request = {} + client.test_iam_permissions(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.test_iam_permissions(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_test_iam_permissions_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.test_iam_permissions in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[client._client._transport.test_iam_permissions] = mock_rpc + + request = {} + await client.test_iam_permissions(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.test_iam_permissions(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_test_iam_permissions_async(transport: str = 'grpc_asyncio', request_type=iam_policy_pb2.TestIamPermissionsRequest): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + 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.test_iam_permissions), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(iam_policy_pb2.TestIamPermissionsResponse( + permissions=['permissions_value'], + )) + response = await client.test_iam_permissions(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = iam_policy_pb2.TestIamPermissionsRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, iam_policy_pb2.TestIamPermissionsResponse) + assert response.permissions == ['permissions_value'] + + +@pytest.mark.asyncio +async def test_test_iam_permissions_async_from_dict(): + await test_test_iam_permissions_async(request_type=dict) + +def test_test_iam_permissions_field_headers(): + client = ReservationServiceClient( + 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 = iam_policy_pb2.TestIamPermissionsRequest() + + request.resource = 'resource_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.test_iam_permissions), + '__call__') as call: + call.return_value = iam_policy_pb2.TestIamPermissionsResponse() + client.test_iam_permissions(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', + 'resource=resource_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_test_iam_permissions_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # 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 = iam_policy_pb2.TestIamPermissionsRequest() + + request.resource = 'resource_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.test_iam_permissions), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(iam_policy_pb2.TestIamPermissionsResponse()) + await client.test_iam_permissions(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', + 'resource=resource_value', + ) in kw['metadata'] + +def test_test_iam_permissions_from_dict_foreign(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.test_iam_permissions), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = iam_policy_pb2.TestIamPermissionsResponse() + response = client.test_iam_permissions(request={ + 'resource': 'resource_value', + 'permissions': ['permissions_value'], + } + ) + call.assert_called() + + +@pytest.mark.parametrize("request_type", [ + reservation.CreateReservationGroupRequest, + dict, +]) +def test_create_reservation_group(request_type, transport: str = 'grpc'): + client = ReservationServiceClient( + 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_reservation_group), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.ReservationGroup( + name='name_value', + ) + response = client.create_reservation_group(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = reservation.CreateReservationGroupRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.ReservationGroup) + assert response.name == 'name_value' + + +def test_create_reservation_group_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = reservation.CreateReservationGroupRequest( + parent='parent_value', + reservation_group_id='reservation_group_id_value', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_reservation_group), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.create_reservation_group(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.CreateReservationGroupRequest( + parent='parent_value', + reservation_group_id='reservation_group_id_value', + ) + +def test_create_reservation_group_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.create_reservation_group in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.create_reservation_group] = mock_rpc + request = {} + client.create_reservation_group(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.create_reservation_group(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_create_reservation_group_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.create_reservation_group in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[client._client._transport.create_reservation_group] = mock_rpc + + request = {} + await client.create_reservation_group(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.create_reservation_group(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_create_reservation_group_async(transport: str = 'grpc_asyncio', request_type=reservation.CreateReservationGroupRequest): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + 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_reservation_group), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.ReservationGroup( + name='name_value', + )) + response = await client.create_reservation_group(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = reservation.CreateReservationGroupRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.ReservationGroup) + assert response.name == 'name_value' + + +@pytest.mark.asyncio +async def test_create_reservation_group_async_from_dict(): + await test_create_reservation_group_async(request_type=dict) + +def test_create_reservation_group_field_headers(): + client = ReservationServiceClient( + 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 = reservation.CreateReservationGroupRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_reservation_group), + '__call__') as call: + call.return_value = reservation.ReservationGroup() + client.create_reservation_group(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_reservation_group_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # 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 = reservation.CreateReservationGroupRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_reservation_group), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ReservationGroup()) + await client.create_reservation_group(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", [ + reservation.GetReservationGroupRequest, + dict, +]) +def test_get_reservation_group(request_type, transport: str = 'grpc'): + client = ReservationServiceClient( + 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_reservation_group), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.ReservationGroup( + name='name_value', + ) + response = client.get_reservation_group(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = reservation.GetReservationGroupRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.ReservationGroup) + assert response.name == 'name_value' + + +def test_get_reservation_group_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = reservation.GetReservationGroupRequest( + name='name_value', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_reservation_group), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.get_reservation_group(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.GetReservationGroupRequest( + name='name_value', + ) + +def test_get_reservation_group_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.get_reservation_group in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.get_reservation_group] = mock_rpc + request = {} + client.get_reservation_group(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.get_reservation_group(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_get_reservation_group_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.get_reservation_group in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[client._client._transport.get_reservation_group] = mock_rpc + + request = {} + await client.get_reservation_group(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.get_reservation_group(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_get_reservation_group_async(transport: str = 'grpc_asyncio', request_type=reservation.GetReservationGroupRequest): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + 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_reservation_group), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.ReservationGroup( + name='name_value', + )) + response = await client.get_reservation_group(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = reservation.GetReservationGroupRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.ReservationGroup) + assert response.name == 'name_value' + + +@pytest.mark.asyncio +async def test_get_reservation_group_async_from_dict(): + await test_get_reservation_group_async(request_type=dict) + +def test_get_reservation_group_field_headers(): + client = ReservationServiceClient( + 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 = reservation.GetReservationGroupRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_reservation_group), + '__call__') as call: + call.return_value = reservation.ReservationGroup() + client.get_reservation_group(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_reservation_group_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # 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 = reservation.GetReservationGroupRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_reservation_group), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ReservationGroup()) + await client.get_reservation_group(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_reservation_group_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_reservation_group), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.ReservationGroup() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_reservation_group( + 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_reservation_group_flattened_error(): + client = ReservationServiceClient( + 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_reservation_group( + reservation.GetReservationGroupRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_get_reservation_group_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_reservation_group), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.ReservationGroup() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ReservationGroup()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_reservation_group( + 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_reservation_group_flattened_error_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_reservation_group( + reservation.GetReservationGroupRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + reservation.DeleteReservationGroupRequest, + dict, +]) +def test_delete_reservation_group(request_type, transport: str = 'grpc'): + client = ReservationServiceClient( + 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_reservation_group), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.delete_reservation_group(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = reservation.DeleteReservationGroupRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_reservation_group_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = reservation.DeleteReservationGroupRequest( + name='name_value', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_reservation_group), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.delete_reservation_group(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.DeleteReservationGroupRequest( + name='name_value', + ) + +def test_delete_reservation_group_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.delete_reservation_group in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.delete_reservation_group] = mock_rpc + request = {} + client.delete_reservation_group(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.delete_reservation_group(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_delete_reservation_group_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.delete_reservation_group in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[client._client._transport.delete_reservation_group] = mock_rpc + + request = {} + await client.delete_reservation_group(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.delete_reservation_group(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_delete_reservation_group_async(transport: str = 'grpc_asyncio', request_type=reservation.DeleteReservationGroupRequest): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + 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_reservation_group), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.delete_reservation_group(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = reservation.DeleteReservationGroupRequest() + 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_reservation_group_async_from_dict(): + await test_delete_reservation_group_async(request_type=dict) + +def test_delete_reservation_group_field_headers(): + client = ReservationServiceClient( + 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 = reservation.DeleteReservationGroupRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_reservation_group), + '__call__') as call: + call.return_value = None + client.delete_reservation_group(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_reservation_group_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # 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 = reservation.DeleteReservationGroupRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_reservation_group), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_reservation_group(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_reservation_group_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_reservation_group), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.delete_reservation_group( + 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_reservation_group_flattened_error(): + client = ReservationServiceClient( + 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_reservation_group( + reservation.DeleteReservationGroupRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_delete_reservation_group_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_reservation_group), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.delete_reservation_group( + 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_reservation_group_flattened_error_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.delete_reservation_group( + reservation.DeleteReservationGroupRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + reservation.ListReservationGroupsRequest, + dict, +]) +def test_list_reservation_groups(request_type, transport: str = 'grpc'): + client = ReservationServiceClient( + 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_reservation_groups), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.ListReservationGroupsResponse( + next_page_token='next_page_token_value', + ) + response = client.list_reservation_groups(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = reservation.ListReservationGroupsRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListReservationGroupsPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_reservation_groups_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = reservation.ListReservationGroupsRequest( + parent='parent_value', + page_token='page_token_value', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_reservation_groups), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.list_reservation_groups(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.ListReservationGroupsRequest( + parent='parent_value', + page_token='page_token_value', + ) + +def test_list_reservation_groups_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.list_reservation_groups in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.list_reservation_groups] = mock_rpc + request = {} + client.list_reservation_groups(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.list_reservation_groups(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_list_reservation_groups_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.list_reservation_groups in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[client._client._transport.list_reservation_groups] = mock_rpc + + request = {} + await client.list_reservation_groups(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.list_reservation_groups(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_list_reservation_groups_async(transport: str = 'grpc_asyncio', request_type=reservation.ListReservationGroupsRequest): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + 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_reservation_groups), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListReservationGroupsResponse( + next_page_token='next_page_token_value', + )) + response = await client.list_reservation_groups(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = reservation.ListReservationGroupsRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListReservationGroupsAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_list_reservation_groups_async_from_dict(): + await test_list_reservation_groups_async(request_type=dict) + +def test_list_reservation_groups_field_headers(): + client = ReservationServiceClient( + 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 = reservation.ListReservationGroupsRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_reservation_groups), + '__call__') as call: + call.return_value = reservation.ListReservationGroupsResponse() + client.list_reservation_groups(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_reservation_groups_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # 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 = reservation.ListReservationGroupsRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_reservation_groups), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListReservationGroupsResponse()) + await client.list_reservation_groups(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_reservation_groups_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_reservation_groups), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.ListReservationGroupsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_reservation_groups( + 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_reservation_groups_flattened_error(): + client = ReservationServiceClient( + 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_reservation_groups( + reservation.ListReservationGroupsRequest(), + parent='parent_value', + ) + +@pytest.mark.asyncio +async def test_list_reservation_groups_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_reservation_groups), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.ListReservationGroupsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListReservationGroupsResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_reservation_groups( + 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_reservation_groups_flattened_error_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_reservation_groups( + reservation.ListReservationGroupsRequest(), + parent='parent_value', + ) + + +def test_list_reservation_groups_pager(transport_name: str = "grpc"): + client = ReservationServiceClient( + 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_reservation_groups), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.ListReservationGroupsResponse( + reservation_groups=[ + reservation.ReservationGroup(), + reservation.ReservationGroup(), + reservation.ReservationGroup(), + ], + next_page_token='abc', + ), + reservation.ListReservationGroupsResponse( + reservation_groups=[], + next_page_token='def', + ), + reservation.ListReservationGroupsResponse( + reservation_groups=[ + reservation.ReservationGroup(), + ], + next_page_token='ghi', + ), + reservation.ListReservationGroupsResponse( + reservation_groups=[ + reservation.ReservationGroup(), + reservation.ReservationGroup(), + ], + ), + RuntimeError, + ) + + expected_metadata = () + retry = retries.Retry() + timeout = 5 + expected_metadata = tuple(expected_metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_reservation_groups(request={}, retry=retry, timeout=timeout) + + assert pager._metadata == expected_metadata + assert pager._retry == retry + assert pager._timeout == timeout + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, reservation.ReservationGroup) + for i in results) +def test_list_reservation_groups_pages(transport_name: str = "grpc"): + client = ReservationServiceClient( + 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_reservation_groups), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.ListReservationGroupsResponse( + reservation_groups=[ + reservation.ReservationGroup(), + reservation.ReservationGroup(), + reservation.ReservationGroup(), + ], + next_page_token='abc', + ), + reservation.ListReservationGroupsResponse( + reservation_groups=[], + next_page_token='def', + ), + reservation.ListReservationGroupsResponse( + reservation_groups=[ + reservation.ReservationGroup(), + ], + next_page_token='ghi', + ), + reservation.ListReservationGroupsResponse( + reservation_groups=[ + reservation.ReservationGroup(), + reservation.ReservationGroup(), + ], + ), + RuntimeError, + ) + pages = list(client.list_reservation_groups(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_reservation_groups_async_pager(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_reservation_groups), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.ListReservationGroupsResponse( + reservation_groups=[ + reservation.ReservationGroup(), + reservation.ReservationGroup(), + reservation.ReservationGroup(), + ], + next_page_token='abc', + ), + reservation.ListReservationGroupsResponse( + reservation_groups=[], + next_page_token='def', + ), + reservation.ListReservationGroupsResponse( + reservation_groups=[ + reservation.ReservationGroup(), + ], + next_page_token='ghi', + ), + reservation.ListReservationGroupsResponse( + reservation_groups=[ + reservation.ReservationGroup(), + reservation.ReservationGroup(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_reservation_groups(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, reservation.ReservationGroup) + for i in responses) + + +@pytest.mark.asyncio +async def test_list_reservation_groups_async_pages(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_reservation_groups), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.ListReservationGroupsResponse( + reservation_groups=[ + reservation.ReservationGroup(), + reservation.ReservationGroup(), + reservation.ReservationGroup(), + ], + next_page_token='abc', + ), + reservation.ListReservationGroupsResponse( + reservation_groups=[], + next_page_token='def', + ), + reservation.ListReservationGroupsResponse( + reservation_groups=[ + reservation.ReservationGroup(), + ], + next_page_token='ghi', + ), + reservation.ListReservationGroupsResponse( + reservation_groups=[ + reservation.ReservationGroup(), + reservation.ReservationGroup(), + ], + ), + RuntimeError, + ) + pages = [] + # Workaround issue in python 3.9 related to code coverage by adding `# pragma: no branch` + # See https://github.com/googleapis/gapic-generator-python/pull/1174#issuecomment-1025132372 + async for page_ in ( # pragma: no branch + await client.list_reservation_groups(request={}) + ).pages: + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + + +def test_create_reservation_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.create_reservation in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.create_reservation] = mock_rpc + + request = {} + client.create_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.create_reservation(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_create_reservation_rest_required_fields(request_type=gcbr_reservation.CreateReservationRequest): + transport_class = transports.ReservationServiceRestTransport + + 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, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_reservation._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_reservation._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("reservation_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 = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = gcbr_reservation.Reservation() + # 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 + + # Convert return value to protobuf type + return_value = gcbr_reservation.Reservation.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.create_reservation(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_create_reservation_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.create_reservation._get_unset_required_fields({}) + assert set(unset_fields) == (set(("reservationId", )) & set(("parent", ))) + + +def test_create_reservation_rest_flattened(): + client = ReservationServiceClient( + 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 = gcbr_reservation.Reservation() + + # 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', + reservation=gcbr_reservation.Reservation(name='name_value'), + reservation_id='reservation_id_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = gcbr_reservation.Reservation.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.create_reservation(**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/v1/{parent=projects/*/locations/*}/reservations" % client.transport._host, args[1]) + + +def test_create_reservation_rest_flattened_error(transport: str = 'rest'): + client = ReservationServiceClient( + 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_reservation( + gcbr_reservation.CreateReservationRequest(), + parent='parent_value', + reservation=gcbr_reservation.Reservation(name='name_value'), + reservation_id='reservation_id_value', + ) + + +def test_list_reservations_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.list_reservations in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.list_reservations] = mock_rpc + + request = {} + client.list_reservations(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.list_reservations(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_list_reservations_rest_required_fields(request_type=reservation.ListReservationsRequest): + transport_class = transports.ReservationServiceRestTransport + + 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, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_reservations._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_reservations._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 = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = reservation.ListReservationsResponse() + # 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 + + # Convert return value to protobuf type + return_value = reservation.ListReservationsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.list_reservations(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_list_reservations_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.list_reservations._get_unset_required_fields({}) + assert set(unset_fields) == (set(("pageSize", "pageToken", )) & set(("parent", ))) + + +def test_list_reservations_rest_flattened(): + client = ReservationServiceClient( + 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 = reservation.ListReservationsResponse() + + # 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 + # Convert return value to protobuf type + return_value = reservation.ListReservationsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.list_reservations(**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/v1/{parent=projects/*/locations/*}/reservations" % client.transport._host, args[1]) + + +def test_list_reservations_rest_flattened_error(transport: str = 'rest'): + client = ReservationServiceClient( + 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_reservations( + reservation.ListReservationsRequest(), + parent='parent_value', + ) + + +def test_list_reservations_rest_pager(transport: str = 'rest'): + client = ReservationServiceClient( + 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 = ( + reservation.ListReservationsResponse( + reservations=[ + reservation.Reservation(), + reservation.Reservation(), + reservation.Reservation(), + ], + next_page_token='abc', + ), + reservation.ListReservationsResponse( + reservations=[], + next_page_token='def', + ), + reservation.ListReservationsResponse( + reservations=[ + reservation.Reservation(), + ], + next_page_token='ghi', + ), + reservation.ListReservationsResponse( + reservations=[ + reservation.Reservation(), + reservation.Reservation(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple(reservation.ListReservationsResponse.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_reservations(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, reservation.Reservation) + for i in results) + + pages = list(client.list_reservations(request=sample_request).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + + +def test_get_reservation_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.get_reservation in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.get_reservation] = mock_rpc + + request = {} + client.get_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.get_reservation(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_get_reservation_rest_required_fields(request_type=reservation.GetReservationRequest): + transport_class = transports.ReservationServiceRestTransport + + 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, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_reservation._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_reservation._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 = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = reservation.Reservation() + # 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 + + # Convert return value to protobuf type + return_value = reservation.Reservation.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.get_reservation(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_get_reservation_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.get_reservation._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +def test_get_reservation_rest_flattened(): + client = ReservationServiceClient( + 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 = reservation.Reservation() + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/reservations/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 + # Convert return value to protobuf type + return_value = reservation.Reservation.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.get_reservation(**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/v1/{name=projects/*/locations/*/reservations/*}" % client.transport._host, args[1]) + + +def test_get_reservation_rest_flattened_error(transport: str = 'rest'): + client = ReservationServiceClient( + 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_reservation( + reservation.GetReservationRequest(), + name='name_value', + ) + + +def test_delete_reservation_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.delete_reservation in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.delete_reservation] = mock_rpc + + request = {} + client.delete_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.delete_reservation(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_delete_reservation_rest_required_fields(request_type=reservation.DeleteReservationRequest): + transport_class = transports.ReservationServiceRestTransport + + 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, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_reservation._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_reservation._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 = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # 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 = '' + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.delete_reservation(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_delete_reservation_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.delete_reservation._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +def test_delete_reservation_rest_flattened(): + client = ReservationServiceClient( + 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 = None + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/reservations/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 = '' + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.delete_reservation(**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/v1/{name=projects/*/locations/*/reservations/*}" % client.transport._host, args[1]) + + +def test_delete_reservation_rest_flattened_error(transport: str = 'rest'): + client = ReservationServiceClient( + 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_reservation( + reservation.DeleteReservationRequest(), + name='name_value', + ) + + +def test_update_reservation_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.update_reservation in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.update_reservation] = mock_rpc + + request = {} + client.update_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.update_reservation(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_update_reservation_rest_flattened(): + client = ReservationServiceClient( + 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 = gcbr_reservation.Reservation() + + # get arguments that satisfy an http rule for this method + sample_request = {'reservation': {'name': 'projects/sample1/locations/sample2/reservations/sample3'}} + + # get truthy value for each flattened field + mock_args = dict( + reservation=gcbr_reservation.Reservation(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 + # Convert return value to protobuf type + return_value = gcbr_reservation.Reservation.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.update_reservation(**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/v1/{reservation.name=projects/*/locations/*/reservations/*}" % client.transport._host, args[1]) + + +def test_update_reservation_rest_flattened_error(transport: str = 'rest'): + client = ReservationServiceClient( + 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_reservation( + gcbr_reservation.UpdateReservationRequest(), + reservation=gcbr_reservation.Reservation(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +def test_failover_reservation_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.failover_reservation in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.failover_reservation] = mock_rpc + + request = {} + client.failover_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.failover_reservation(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_failover_reservation_rest_required_fields(request_type=reservation.FailoverReservationRequest): + transport_class = transports.ReservationServiceRestTransport + + 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, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).failover_reservation._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()).failover_reservation._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 = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = reservation.Reservation() + # 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 + + # Convert return value to protobuf type + return_value = reservation.Reservation.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.failover_reservation(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_failover_reservation_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.failover_reservation._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +def test_create_capacity_commitment_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.create_capacity_commitment in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.create_capacity_commitment] = mock_rpc + + request = {} + client.create_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.create_capacity_commitment(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_create_capacity_commitment_rest_required_fields(request_type=reservation.CreateCapacityCommitmentRequest): + transport_class = transports.ReservationServiceRestTransport + + 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, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_capacity_commitment._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_capacity_commitment._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("capacity_commitment_id", "enforce_single_admin_project_per_org", )) + 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 = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = reservation.CapacityCommitment() + # 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 + + # Convert return value to protobuf type + return_value = reservation.CapacityCommitment.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.create_capacity_commitment(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_create_capacity_commitment_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.create_capacity_commitment._get_unset_required_fields({}) + assert set(unset_fields) == (set(("capacityCommitmentId", "enforceSingleAdminProjectPerOrg", )) & set(("parent", ))) + + +def test_create_capacity_commitment_rest_flattened(): + client = ReservationServiceClient( + 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 = reservation.CapacityCommitment() + + # 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', + capacity_commitment=reservation.CapacityCommitment(name='name_value'), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = reservation.CapacityCommitment.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.create_capacity_commitment(**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/v1/{parent=projects/*/locations/*}/capacityCommitments" % client.transport._host, args[1]) + + +def test_create_capacity_commitment_rest_flattened_error(transport: str = 'rest'): + client = ReservationServiceClient( + 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_capacity_commitment( + reservation.CreateCapacityCommitmentRequest(), + parent='parent_value', + capacity_commitment=reservation.CapacityCommitment(name='name_value'), + ) + + +def test_list_capacity_commitments_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.list_capacity_commitments in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.list_capacity_commitments] = mock_rpc + + request = {} + client.list_capacity_commitments(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.list_capacity_commitments(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_list_capacity_commitments_rest_required_fields(request_type=reservation.ListCapacityCommitmentsRequest): + transport_class = transports.ReservationServiceRestTransport + + 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, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_capacity_commitments._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_capacity_commitments._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 = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = reservation.ListCapacityCommitmentsResponse() + # 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 + + # Convert return value to protobuf type + return_value = reservation.ListCapacityCommitmentsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.list_capacity_commitments(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_list_capacity_commitments_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.list_capacity_commitments._get_unset_required_fields({}) + assert set(unset_fields) == (set(("pageSize", "pageToken", )) & set(("parent", ))) + + +def test_list_capacity_commitments_rest_flattened(): + client = ReservationServiceClient( + 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 = reservation.ListCapacityCommitmentsResponse() + + # 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 + # Convert return value to protobuf type + return_value = reservation.ListCapacityCommitmentsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.list_capacity_commitments(**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/v1/{parent=projects/*/locations/*}/capacityCommitments" % client.transport._host, args[1]) + + +def test_list_capacity_commitments_rest_flattened_error(transport: str = 'rest'): + client = ReservationServiceClient( + 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_capacity_commitments( + reservation.ListCapacityCommitmentsRequest(), + parent='parent_value', + ) + + +def test_list_capacity_commitments_rest_pager(transport: str = 'rest'): + client = ReservationServiceClient( + 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 = ( + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[ + reservation.CapacityCommitment(), + reservation.CapacityCommitment(), + reservation.CapacityCommitment(), + ], + next_page_token='abc', + ), + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[], + next_page_token='def', + ), + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[ + reservation.CapacityCommitment(), + ], + next_page_token='ghi', + ), + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[ + reservation.CapacityCommitment(), + reservation.CapacityCommitment(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple(reservation.ListCapacityCommitmentsResponse.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_capacity_commitments(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, reservation.CapacityCommitment) + for i in results) + + pages = list(client.list_capacity_commitments(request=sample_request).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + + +def test_get_capacity_commitment_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.get_capacity_commitment in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.get_capacity_commitment] = mock_rpc + + request = {} + client.get_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.get_capacity_commitment(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_get_capacity_commitment_rest_required_fields(request_type=reservation.GetCapacityCommitmentRequest): + transport_class = transports.ReservationServiceRestTransport + + 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, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_capacity_commitment._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_capacity_commitment._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 = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = reservation.CapacityCommitment() + # 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 + + # Convert return value to protobuf type + return_value = reservation.CapacityCommitment.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.get_capacity_commitment(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_get_capacity_commitment_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.get_capacity_commitment._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +def test_get_capacity_commitment_rest_flattened(): + client = ReservationServiceClient( + 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 = reservation.CapacityCommitment() + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/capacityCommitments/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 + # Convert return value to protobuf type + return_value = reservation.CapacityCommitment.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.get_capacity_commitment(**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/v1/{name=projects/*/locations/*/capacityCommitments/*}" % client.transport._host, args[1]) + + +def test_get_capacity_commitment_rest_flattened_error(transport: str = 'rest'): + client = ReservationServiceClient( + 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_capacity_commitment( + reservation.GetCapacityCommitmentRequest(), + name='name_value', + ) + + +def test_delete_capacity_commitment_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.delete_capacity_commitment in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.delete_capacity_commitment] = mock_rpc + + request = {} + client.delete_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.delete_capacity_commitment(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_delete_capacity_commitment_rest_required_fields(request_type=reservation.DeleteCapacityCommitmentRequest): + transport_class = transports.ReservationServiceRestTransport + + 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, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_capacity_commitment._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_capacity_commitment._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("force", )) + 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 = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # 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 = '' + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.delete_capacity_commitment(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_delete_capacity_commitment_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.delete_capacity_commitment._get_unset_required_fields({}) + assert set(unset_fields) == (set(("force", )) & set(("name", ))) + + +def test_delete_capacity_commitment_rest_flattened(): + client = ReservationServiceClient( + 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 = None + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/capacityCommitments/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 = '' + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.delete_capacity_commitment(**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/v1/{name=projects/*/locations/*/capacityCommitments/*}" % client.transport._host, args[1]) + + +def test_delete_capacity_commitment_rest_flattened_error(transport: str = 'rest'): + client = ReservationServiceClient( + 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_capacity_commitment( + reservation.DeleteCapacityCommitmentRequest(), + name='name_value', + ) + + +def test_update_capacity_commitment_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.update_capacity_commitment in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.update_capacity_commitment] = mock_rpc + + request = {} + client.update_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.update_capacity_commitment(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_update_capacity_commitment_rest_flattened(): + client = ReservationServiceClient( + 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 = reservation.CapacityCommitment() + + # get arguments that satisfy an http rule for this method + sample_request = {'capacity_commitment': {'name': 'projects/sample1/locations/sample2/capacityCommitments/sample3'}} + + # get truthy value for each flattened field + mock_args = dict( + capacity_commitment=reservation.CapacityCommitment(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 + # Convert return value to protobuf type + return_value = reservation.CapacityCommitment.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.update_capacity_commitment(**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/v1/{capacity_commitment.name=projects/*/locations/*/capacityCommitments/*}" % client.transport._host, args[1]) + + +def test_update_capacity_commitment_rest_flattened_error(transport: str = 'rest'): + client = ReservationServiceClient( + 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_capacity_commitment( + reservation.UpdateCapacityCommitmentRequest(), + capacity_commitment=reservation.CapacityCommitment(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +def test_split_capacity_commitment_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.split_capacity_commitment in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.split_capacity_commitment] = mock_rpc + + request = {} + client.split_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.split_capacity_commitment(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_split_capacity_commitment_rest_required_fields(request_type=reservation.SplitCapacityCommitmentRequest): + transport_class = transports.ReservationServiceRestTransport + + 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, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).split_capacity_commitment._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()).split_capacity_commitment._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 = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = reservation.SplitCapacityCommitmentResponse() + # 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 + + # Convert return value to protobuf type + return_value = reservation.SplitCapacityCommitmentResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.split_capacity_commitment(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_split_capacity_commitment_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.split_capacity_commitment._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +def test_split_capacity_commitment_rest_flattened(): + client = ReservationServiceClient( + 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 = reservation.SplitCapacityCommitmentResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/capacityCommitments/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + slot_count=1098, + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = reservation.SplitCapacityCommitmentResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.split_capacity_commitment(**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/v1/{name=projects/*/locations/*/capacityCommitments/*}:split" % client.transport._host, args[1]) + + +def test_split_capacity_commitment_rest_flattened_error(transport: str = 'rest'): + client = ReservationServiceClient( + 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.split_capacity_commitment( + reservation.SplitCapacityCommitmentRequest(), + name='name_value', + slot_count=1098, + ) + + +def test_merge_capacity_commitments_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.merge_capacity_commitments in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.merge_capacity_commitments] = mock_rpc + + request = {} + client.merge_capacity_commitments(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.merge_capacity_commitments(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_merge_capacity_commitments_rest_flattened(): + client = ReservationServiceClient( + 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 = reservation.CapacityCommitment() + + # 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', + capacity_commitment_ids=['capacity_commitment_ids_value'], + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = reservation.CapacityCommitment.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.merge_capacity_commitments(**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/v1/{parent=projects/*/locations/*}/capacityCommitments:merge" % client.transport._host, args[1]) + + +def test_merge_capacity_commitments_rest_flattened_error(transport: str = 'rest'): + client = ReservationServiceClient( + 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.merge_capacity_commitments( + reservation.MergeCapacityCommitmentsRequest(), + parent='parent_value', + capacity_commitment_ids=['capacity_commitment_ids_value'], + ) + + +def test_create_assignment_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.create_assignment in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.create_assignment] = mock_rpc + + request = {} + client.create_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.create_assignment(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_create_assignment_rest_required_fields(request_type=reservation.CreateAssignmentRequest): + transport_class = transports.ReservationServiceRestTransport + + 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, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_assignment._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_assignment._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("assignment_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 = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = reservation.Assignment() + # 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 + + # Convert return value to protobuf type + return_value = reservation.Assignment.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.create_assignment(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_create_assignment_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.create_assignment._get_unset_required_fields({}) + assert set(unset_fields) == (set(("assignmentId", )) & set(("parent", ))) + + +def test_create_assignment_rest_flattened(): + client = ReservationServiceClient( + 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 = reservation.Assignment() + + # get arguments that satisfy an http rule for this method + sample_request = {'parent': 'projects/sample1/locations/sample2/reservations/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + parent='parent_value', + assignment=reservation.Assignment(name='name_value'), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = reservation.Assignment.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.create_assignment(**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/v1/{parent=projects/*/locations/*/reservations/*}/assignments" % client.transport._host, args[1]) + + +def test_create_assignment_rest_flattened_error(transport: str = 'rest'): + client = ReservationServiceClient( + 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_assignment( + reservation.CreateAssignmentRequest(), + parent='parent_value', + assignment=reservation.Assignment(name='name_value'), + ) + + +def test_list_assignments_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.list_assignments in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.list_assignments] = mock_rpc + + request = {} + client.list_assignments(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.list_assignments(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_list_assignments_rest_required_fields(request_type=reservation.ListAssignmentsRequest): + transport_class = transports.ReservationServiceRestTransport + + 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, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_assignments._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_assignments._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 = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = reservation.ListAssignmentsResponse() + # 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 + + # Convert return value to protobuf type + return_value = reservation.ListAssignmentsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.list_assignments(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_list_assignments_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.list_assignments._get_unset_required_fields({}) + assert set(unset_fields) == (set(("pageSize", "pageToken", )) & set(("parent", ))) + + +def test_list_assignments_rest_flattened(): + client = ReservationServiceClient( + 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 = reservation.ListAssignmentsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'parent': 'projects/sample1/locations/sample2/reservations/sample3'} + + # 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 + # Convert return value to protobuf type + return_value = reservation.ListAssignmentsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.list_assignments(**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/v1/{parent=projects/*/locations/*/reservations/*}/assignments" % client.transport._host, args[1]) + + +def test_list_assignments_rest_flattened_error(transport: str = 'rest'): + client = ReservationServiceClient( + 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_assignments( + reservation.ListAssignmentsRequest(), + parent='parent_value', + ) + + +def test_list_assignments_rest_pager(transport: str = 'rest'): + client = ReservationServiceClient( + 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 = ( + reservation.ListAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + reservation.Assignment(), + ], + next_page_token='abc', + ), + reservation.ListAssignmentsResponse( + assignments=[], + next_page_token='def', + ), + reservation.ListAssignmentsResponse( + assignments=[ + reservation.Assignment(), + ], + next_page_token='ghi', + ), + reservation.ListAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple(reservation.ListAssignmentsResponse.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/reservations/sample3'} + + pager = client.list_assignments(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, reservation.Assignment) + for i in results) + + pages = list(client.list_assignments(request=sample_request).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + + +def test_delete_assignment_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.delete_assignment in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.delete_assignment] = mock_rpc + + request = {} + client.delete_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.delete_assignment(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_delete_assignment_rest_required_fields(request_type=reservation.DeleteAssignmentRequest): + transport_class = transports.ReservationServiceRestTransport + + 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, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_assignment._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_assignment._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 = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # 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 = '' + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.delete_assignment(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_delete_assignment_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.delete_assignment._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +def test_delete_assignment_rest_flattened(): + client = ReservationServiceClient( + 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 = None + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/reservations/sample3/assignments/sample4'} + + # 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 = '' + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.delete_assignment(**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/v1/{name=projects/*/locations/*/reservations/*/assignments/*}" % client.transport._host, args[1]) + + +def test_delete_assignment_rest_flattened_error(transport: str = 'rest'): + client = ReservationServiceClient( + 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_assignment( + reservation.DeleteAssignmentRequest(), + name='name_value', + ) + + +def test_search_assignments_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.search_assignments in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.search_assignments] = mock_rpc + + request = {} + client.search_assignments(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.search_assignments(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_search_assignments_rest_required_fields(request_type=reservation.SearchAssignmentsRequest): + transport_class = transports.ReservationServiceRestTransport + + 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, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).search_assignments._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()).search_assignments._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", "query", )) + 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 = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = reservation.SearchAssignmentsResponse() + # 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 + + # Convert return value to protobuf type + return_value = reservation.SearchAssignmentsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.search_assignments(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_search_assignments_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.search_assignments._get_unset_required_fields({}) + assert set(unset_fields) == (set(("pageSize", "pageToken", "query", )) & set(("parent", ))) + + +def test_search_assignments_rest_flattened(): + client = ReservationServiceClient( + 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 = reservation.SearchAssignmentsResponse() + + # 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', + query='query_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = reservation.SearchAssignmentsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.search_assignments(**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/v1/{parent=projects/*/locations/*}:searchAssignments" % client.transport._host, args[1]) + + +def test_search_assignments_rest_flattened_error(transport: str = 'rest'): + client = ReservationServiceClient( + 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.search_assignments( + reservation.SearchAssignmentsRequest(), + parent='parent_value', + query='query_value', + ) + + +def test_search_assignments_rest_pager(transport: str = 'rest'): + client = ReservationServiceClient( + 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 = ( + reservation.SearchAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + reservation.Assignment(), + ], + next_page_token='abc', + ), + reservation.SearchAssignmentsResponse( + assignments=[], + next_page_token='def', + ), + reservation.SearchAssignmentsResponse( + assignments=[ + reservation.Assignment(), + ], + next_page_token='ghi', + ), + reservation.SearchAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple(reservation.SearchAssignmentsResponse.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.search_assignments(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, reservation.Assignment) + for i in results) + + pages = list(client.search_assignments(request=sample_request).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + + +def test_search_all_assignments_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.search_all_assignments in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.search_all_assignments] = mock_rpc + + request = {} + client.search_all_assignments(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.search_all_assignments(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_search_all_assignments_rest_required_fields(request_type=reservation.SearchAllAssignmentsRequest): + transport_class = transports.ReservationServiceRestTransport + + 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, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).search_all_assignments._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()).search_all_assignments._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", "query", )) + 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 = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = reservation.SearchAllAssignmentsResponse() + # 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 + + # Convert return value to protobuf type + return_value = reservation.SearchAllAssignmentsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.search_all_assignments(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_search_all_assignments_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.search_all_assignments._get_unset_required_fields({}) + assert set(unset_fields) == (set(("pageSize", "pageToken", "query", )) & set(("parent", ))) + + +def test_search_all_assignments_rest_flattened(): + client = ReservationServiceClient( + 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 = reservation.SearchAllAssignmentsResponse() + + # 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', + query='query_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = reservation.SearchAllAssignmentsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.search_all_assignments(**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/v1/{parent=projects/*/locations/*}:searchAllAssignments" % client.transport._host, args[1]) + + +def test_search_all_assignments_rest_flattened_error(transport: str = 'rest'): + client = ReservationServiceClient( + 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.search_all_assignments( + reservation.SearchAllAssignmentsRequest(), + parent='parent_value', + query='query_value', + ) + + +def test_search_all_assignments_rest_pager(transport: str = 'rest'): + client = ReservationServiceClient( + 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 = ( + reservation.SearchAllAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + reservation.Assignment(), + ], + next_page_token='abc', + ), + reservation.SearchAllAssignmentsResponse( + assignments=[], + next_page_token='def', + ), + reservation.SearchAllAssignmentsResponse( + assignments=[ + reservation.Assignment(), + ], + next_page_token='ghi', + ), + reservation.SearchAllAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple(reservation.SearchAllAssignmentsResponse.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.search_all_assignments(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, reservation.Assignment) + for i in results) + + pages = list(client.search_all_assignments(request=sample_request).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + + +def test_move_assignment_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.move_assignment in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.move_assignment] = mock_rpc + + request = {} + client.move_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.move_assignment(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_move_assignment_rest_required_fields(request_type=reservation.MoveAssignmentRequest): + transport_class = transports.ReservationServiceRestTransport + + 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, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).move_assignment._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()).move_assignment._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 = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = reservation.Assignment() + # 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 + + # Convert return value to protobuf type + return_value = reservation.Assignment.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.move_assignment(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_move_assignment_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.move_assignment._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +def test_move_assignment_rest_flattened(): + client = ReservationServiceClient( + 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 = reservation.Assignment() + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/reservations/sample3/assignments/sample4'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + destination_id='destination_id_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = reservation.Assignment.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.move_assignment(**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/v1/{name=projects/*/locations/*/reservations/*/assignments/*}:move" % client.transport._host, args[1]) + + +def test_move_assignment_rest_flattened_error(transport: str = 'rest'): + client = ReservationServiceClient( + 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.move_assignment( + reservation.MoveAssignmentRequest(), + name='name_value', + destination_id='destination_id_value', + ) + + +def test_update_assignment_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.update_assignment in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.update_assignment] = mock_rpc + + request = {} + client.update_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.update_assignment(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_update_assignment_rest_flattened(): + client = ReservationServiceClient( + 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 = reservation.Assignment() + + # get arguments that satisfy an http rule for this method + sample_request = {'assignment': {'name': 'projects/sample1/locations/sample2/reservations/sample3/assignments/sample4'}} + + # get truthy value for each flattened field + mock_args = dict( + assignment=reservation.Assignment(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 + # Convert return value to protobuf type + return_value = reservation.Assignment.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.update_assignment(**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/v1/{assignment.name=projects/*/locations/*/reservations/*/assignments/*}" % client.transport._host, args[1]) + + +def test_update_assignment_rest_flattened_error(transport: str = 'rest'): + client = ReservationServiceClient( + 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_assignment( + reservation.UpdateAssignmentRequest(), + assignment=reservation.Assignment(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +def test_get_bi_reservation_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.get_bi_reservation in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.get_bi_reservation] = mock_rpc + + request = {} + client.get_bi_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.get_bi_reservation(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_get_bi_reservation_rest_required_fields(request_type=reservation.GetBiReservationRequest): + transport_class = transports.ReservationServiceRestTransport + + 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, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_bi_reservation._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_bi_reservation._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 = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = reservation.BiReservation() + # 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 + + # Convert return value to protobuf type + return_value = reservation.BiReservation.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.get_bi_reservation(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_get_bi_reservation_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.get_bi_reservation._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +def test_get_bi_reservation_rest_flattened(): + client = ReservationServiceClient( + 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 = reservation.BiReservation() + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/biReservation'} + + # 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 + # Convert return value to protobuf type + return_value = reservation.BiReservation.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.get_bi_reservation(**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/v1/{name=projects/*/locations/*/biReservation}" % client.transport._host, args[1]) + + +def test_get_bi_reservation_rest_flattened_error(transport: str = 'rest'): + client = ReservationServiceClient( + 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_bi_reservation( + reservation.GetBiReservationRequest(), + name='name_value', + ) + + +def test_update_bi_reservation_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.update_bi_reservation in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.update_bi_reservation] = mock_rpc + + request = {} + client.update_bi_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.update_bi_reservation(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_update_bi_reservation_rest_flattened(): + client = ReservationServiceClient( + 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 = reservation.BiReservation() + + # get arguments that satisfy an http rule for this method + sample_request = {'bi_reservation': {'name': 'projects/sample1/locations/sample2/biReservation'}} + + # get truthy value for each flattened field + mock_args = dict( + bi_reservation=reservation.BiReservation(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 + # Convert return value to protobuf type + return_value = reservation.BiReservation.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.update_bi_reservation(**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/v1/{bi_reservation.name=projects/*/locations/*/biReservation}" % client.transport._host, args[1]) + + +def test_update_bi_reservation_rest_flattened_error(transport: str = 'rest'): + client = ReservationServiceClient( + 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_bi_reservation( + reservation.UpdateBiReservationRequest(), + bi_reservation=reservation.BiReservation(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +def test_get_iam_policy_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.get_iam_policy in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.get_iam_policy] = mock_rpc + + request = {} + client.get_iam_policy(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.get_iam_policy(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_get_iam_policy_rest_required_fields(request_type=iam_policy_pb2.GetIamPolicyRequest): + transport_class = transports.ReservationServiceRestTransport + + request_init = {} + request_init["resource"] = "" + request = request_type(**request_init) + pb_request = request + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_iam_policy._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["resource"] = 'resource_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_iam_policy._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("options", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "resource" in jsonified_request + assert jsonified_request["resource"] == 'resource_value' + + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = policy_pb2.Policy() + # 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 + 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 + + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.get_iam_policy(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_get_iam_policy_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.get_iam_policy._get_unset_required_fields({}) + assert set(unset_fields) == (set(("options", )) & set(("resource", ))) + + +def test_get_iam_policy_rest_flattened(): + client = ReservationServiceClient( + 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 = policy_pb2.Policy() + + # get arguments that satisfy an http rule for this method + sample_request = {'resource': 'projects/sample1/locations/sample2/reservations/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + resource='resource_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 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.get_iam_policy(**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/v1/{resource=projects/*/locations/*/reservations/*}:getIamPolicy" % client.transport._host, args[1]) + + +def test_get_iam_policy_rest_flattened_error(transport: str = 'rest'): + client = ReservationServiceClient( + 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_iam_policy( + iam_policy_pb2.GetIamPolicyRequest(), + resource='resource_value', + ) + + +def test_set_iam_policy_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.set_iam_policy in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.set_iam_policy] = mock_rpc + + request = {} + client.set_iam_policy(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.set_iam_policy(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_set_iam_policy_rest_required_fields(request_type=iam_policy_pb2.SetIamPolicyRequest): + transport_class = transports.ReservationServiceRestTransport + + request_init = {} + request_init["resource"] = "" + request = request_type(**request_init) + pb_request = request + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).set_iam_policy._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["resource"] = 'resource_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).set_iam_policy._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "resource" in jsonified_request + assert jsonified_request["resource"] == 'resource_value' + + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = policy_pb2.Policy() + # 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 + 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 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.set_iam_policy(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_set_iam_policy_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.set_iam_policy._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("resource", "policy", ))) + + +def test_set_iam_policy_rest_flattened(): + client = ReservationServiceClient( + 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 = policy_pb2.Policy() + + # get arguments that satisfy an http rule for this method + sample_request = {'resource': 'projects/sample1/locations/sample2/reservations/sample3'} + + # get truthy value for each flattened field + mock_args = dict( + resource='resource_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 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.set_iam_policy(**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/v1/{resource=projects/*/locations/*/reservations/*}:setIamPolicy" % client.transport._host, args[1]) + + +def test_set_iam_policy_rest_flattened_error(transport: str = 'rest'): + client = ReservationServiceClient( + 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.set_iam_policy( + iam_policy_pb2.SetIamPolicyRequest(), + resource='resource_value', + ) + + +def test_test_iam_permissions_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.test_iam_permissions in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.test_iam_permissions] = mock_rpc + + request = {} + client.test_iam_permissions(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.test_iam_permissions(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_test_iam_permissions_rest_required_fields(request_type=iam_policy_pb2.TestIamPermissionsRequest): + transport_class = transports.ReservationServiceRestTransport + + request_init = {} + request_init["resource"] = "" + request_init["permissions"] = "" + request = request_type(**request_init) + pb_request = request + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).test_iam_permissions._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["resource"] = 'resource_value' + jsonified_request["permissions"] = 'permissions_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).test_iam_permissions._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "resource" in jsonified_request + assert jsonified_request["resource"] == 'resource_value' + assert "permissions" in jsonified_request + assert jsonified_request["permissions"] == 'permissions_value' + + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = iam_policy_pb2.TestIamPermissionsResponse() + # 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 + 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 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.test_iam_permissions(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_test_iam_permissions_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.test_iam_permissions._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("resource", "permissions", ))) + + +def test_create_reservation_group_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.create_reservation_group in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.create_reservation_group] = mock_rpc + + request = {} + client.create_reservation_group(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.create_reservation_group(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_create_reservation_group_rest_required_fields(request_type=reservation.CreateReservationGroupRequest): + transport_class = transports.ReservationServiceRestTransport + + request_init = {} + request_init["parent"] = "" + request_init["reservation_group_id"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + assert "reservationGroupId" not in jsonified_request + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_reservation_group._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "reservationGroupId" in jsonified_request + assert jsonified_request["reservationGroupId"] == request_init["reservation_group_id"] + + jsonified_request["parent"] = 'parent_value' + jsonified_request["reservationGroupId"] = 'reservation_group_id_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_reservation_group._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("reservation_group_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' + assert "reservationGroupId" in jsonified_request + assert jsonified_request["reservationGroupId"] == 'reservation_group_id_value' + + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = reservation.ReservationGroup() + # 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 + + # Convert return value to protobuf type + return_value = reservation.ReservationGroup.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.create_reservation_group(request) + + expected_params = [ + ( + "reservationGroupId", + "", + ), + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_create_reservation_group_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.create_reservation_group._get_unset_required_fields({}) + assert set(unset_fields) == (set(("reservationGroupId", )) & set(("parent", "reservationGroupId", "reservationGroup", ))) + + +def test_get_reservation_group_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.get_reservation_group in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.get_reservation_group] = mock_rpc + + request = {} + client.get_reservation_group(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.get_reservation_group(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_get_reservation_group_rest_required_fields(request_type=reservation.GetReservationGroupRequest): + transport_class = transports.ReservationServiceRestTransport + + 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, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_reservation_group._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_reservation_group._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 = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = reservation.ReservationGroup() + # 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 + + # Convert return value to protobuf type + return_value = reservation.ReservationGroup.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.get_reservation_group(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_get_reservation_group_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.get_reservation_group._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +def test_get_reservation_group_rest_flattened(): + client = ReservationServiceClient( + 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 = reservation.ReservationGroup() + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/reservationGroups/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 + # Convert return value to protobuf type + return_value = reservation.ReservationGroup.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.get_reservation_group(**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/v1/{name=projects/*/locations/*/reservationGroups/*}" % client.transport._host, args[1]) + + +def test_get_reservation_group_rest_flattened_error(transport: str = 'rest'): + client = ReservationServiceClient( + 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_reservation_group( + reservation.GetReservationGroupRequest(), + name='name_value', + ) + + +def test_delete_reservation_group_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.delete_reservation_group in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.delete_reservation_group] = mock_rpc + + request = {} + client.delete_reservation_group(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.delete_reservation_group(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_delete_reservation_group_rest_required_fields(request_type=reservation.DeleteReservationGroupRequest): + transport_class = transports.ReservationServiceRestTransport + + 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, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_reservation_group._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_reservation_group._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 = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # 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 = '' + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.delete_reservation_group(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_delete_reservation_group_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.delete_reservation_group._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +def test_delete_reservation_group_rest_flattened(): + client = ReservationServiceClient( + 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 = None + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'projects/sample1/locations/sample2/reservationGroups/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 = '' + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.delete_reservation_group(**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/v1/{name=projects/*/locations/*/reservationGroups/*}" % client.transport._host, args[1]) + + +def test_delete_reservation_group_rest_flattened_error(transport: str = 'rest'): + client = ReservationServiceClient( + 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_reservation_group( + reservation.DeleteReservationGroupRequest(), + name='name_value', + ) + + +def test_list_reservation_groups_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.list_reservation_groups in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.list_reservation_groups] = mock_rpc + + request = {} + client.list_reservation_groups(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.list_reservation_groups(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_list_reservation_groups_rest_required_fields(request_type=reservation.ListReservationGroupsRequest): + transport_class = transports.ReservationServiceRestTransport + + 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, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_reservation_groups._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_reservation_groups._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 = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = reservation.ListReservationGroupsResponse() + # 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 + + # Convert return value to protobuf type + return_value = reservation.ListReservationGroupsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.list_reservation_groups(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_list_reservation_groups_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.list_reservation_groups._get_unset_required_fields({}) + assert set(unset_fields) == (set(("pageSize", "pageToken", )) & set(("parent", ))) + + +def test_list_reservation_groups_rest_flattened(): + client = ReservationServiceClient( + 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 = reservation.ListReservationGroupsResponse() + + # 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 + # Convert return value to protobuf type + return_value = reservation.ListReservationGroupsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.list_reservation_groups(**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/v1/{parent=projects/*/locations/*}/reservationGroups" % client.transport._host, args[1]) + + +def test_list_reservation_groups_rest_flattened_error(transport: str = 'rest'): + client = ReservationServiceClient( + 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_reservation_groups( + reservation.ListReservationGroupsRequest(), + parent='parent_value', + ) + + +def test_list_reservation_groups_rest_pager(transport: str = 'rest'): + client = ReservationServiceClient( + 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 = ( + reservation.ListReservationGroupsResponse( + reservation_groups=[ + reservation.ReservationGroup(), + reservation.ReservationGroup(), + reservation.ReservationGroup(), + ], + next_page_token='abc', + ), + reservation.ListReservationGroupsResponse( + reservation_groups=[], + next_page_token='def', + ), + reservation.ListReservationGroupsResponse( + reservation_groups=[ + reservation.ReservationGroup(), + ], + next_page_token='ghi', + ), + reservation.ListReservationGroupsResponse( + reservation_groups=[ + reservation.ReservationGroup(), + reservation.ReservationGroup(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple(reservation.ListReservationGroupsResponse.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_reservation_groups(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, reservation.ReservationGroup) + for i in results) + + pages = list(client.list_reservation_groups(request=sample_request).pages) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.ReservationServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.ReservationServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = ReservationServiceClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.ReservationServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = ReservationServiceClient( + client_options=options, + transport=transport, + ) + + # It is an error to provide an api_key and a credential. + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = ReservationServiceClient( + client_options=options, + credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.ReservationServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = ReservationServiceClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.ReservationServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = ReservationServiceClient(transport=transport) + assert client.transport is transport + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.ReservationServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.ReservationServiceGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.ReservationServiceGrpcTransport, + transports.ReservationServiceGrpcAsyncIOTransport, + transports.ReservationServiceRestTransport, +]) +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() + +def test_transport_kind_grpc(): + transport = ReservationServiceClient.get_transport_class("grpc")( + credentials=ga_credentials.AnonymousCredentials() + ) + assert transport.kind == "grpc" + + +def test_initialize_client_w_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc" + ) + assert client is not None + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_create_reservation_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.create_reservation), + '__call__') as call: + call.return_value = gcbr_reservation.Reservation() + client.create_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = gcbr_reservation.CreateReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_list_reservations_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_reservations), + '__call__') as call: + call.return_value = reservation.ListReservationsResponse() + client.list_reservations(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.ListReservationsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_get_reservation_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_reservation), + '__call__') as call: + call.return_value = reservation.Reservation() + client.get_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.GetReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_delete_reservation_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.delete_reservation), + '__call__') as call: + call.return_value = None + client.delete_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.DeleteReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_update_reservation_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.update_reservation), + '__call__') as call: + call.return_value = gcbr_reservation.Reservation() + client.update_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = gcbr_reservation.UpdateReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_failover_reservation_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.failover_reservation), + '__call__') as call: + call.return_value = reservation.Reservation() + client.failover_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.FailoverReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_create_capacity_commitment_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.create_capacity_commitment), + '__call__') as call: + call.return_value = reservation.CapacityCommitment() + client.create_capacity_commitment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.CreateCapacityCommitmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_list_capacity_commitments_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_capacity_commitments), + '__call__') as call: + call.return_value = reservation.ListCapacityCommitmentsResponse() + client.list_capacity_commitments(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.ListCapacityCommitmentsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_get_capacity_commitment_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_capacity_commitment), + '__call__') as call: + call.return_value = reservation.CapacityCommitment() + client.get_capacity_commitment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.GetCapacityCommitmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_delete_capacity_commitment_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.delete_capacity_commitment), + '__call__') as call: + call.return_value = None + client.delete_capacity_commitment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.DeleteCapacityCommitmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_update_capacity_commitment_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.update_capacity_commitment), + '__call__') as call: + call.return_value = reservation.CapacityCommitment() + client.update_capacity_commitment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.UpdateCapacityCommitmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_split_capacity_commitment_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.split_capacity_commitment), + '__call__') as call: + call.return_value = reservation.SplitCapacityCommitmentResponse() + client.split_capacity_commitment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.SplitCapacityCommitmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_merge_capacity_commitments_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.merge_capacity_commitments), + '__call__') as call: + call.return_value = reservation.CapacityCommitment() + client.merge_capacity_commitments(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.MergeCapacityCommitmentsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_create_assignment_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.create_assignment), + '__call__') as call: + call.return_value = reservation.Assignment() + client.create_assignment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.CreateAssignmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_list_assignments_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_assignments), + '__call__') as call: + call.return_value = reservation.ListAssignmentsResponse() + client.list_assignments(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.ListAssignmentsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_delete_assignment_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.delete_assignment), + '__call__') as call: + call.return_value = None + client.delete_assignment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.DeleteAssignmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_search_assignments_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.search_assignments), + '__call__') as call: + call.return_value = reservation.SearchAssignmentsResponse() + client.search_assignments(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.SearchAssignmentsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_search_all_assignments_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.search_all_assignments), + '__call__') as call: + call.return_value = reservation.SearchAllAssignmentsResponse() + client.search_all_assignments(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.SearchAllAssignmentsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_move_assignment_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.move_assignment), + '__call__') as call: + call.return_value = reservation.Assignment() + client.move_assignment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.MoveAssignmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_update_assignment_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.update_assignment), + '__call__') as call: + call.return_value = reservation.Assignment() + client.update_assignment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.UpdateAssignmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_get_bi_reservation_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_bi_reservation), + '__call__') as call: + call.return_value = reservation.BiReservation() + client.get_bi_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.GetBiReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_update_bi_reservation_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.update_bi_reservation), + '__call__') as call: + call.return_value = reservation.BiReservation() + client.update_bi_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.UpdateBiReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_get_iam_policy_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_iam_policy), + '__call__') as call: + call.return_value = policy_pb2.Policy() + client.get_iam_policy(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = iam_policy_pb2.GetIamPolicyRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_set_iam_policy_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.set_iam_policy), + '__call__') as call: + call.return_value = policy_pb2.Policy() + client.set_iam_policy(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = iam_policy_pb2.SetIamPolicyRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_test_iam_permissions_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.test_iam_permissions), + '__call__') as call: + call.return_value = iam_policy_pb2.TestIamPermissionsResponse() + client.test_iam_permissions(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = iam_policy_pb2.TestIamPermissionsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_create_reservation_group_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.create_reservation_group), + '__call__') as call: + call.return_value = reservation.ReservationGroup() + client.create_reservation_group(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.CreateReservationGroupRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_get_reservation_group_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_reservation_group), + '__call__') as call: + call.return_value = reservation.ReservationGroup() + client.get_reservation_group(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.GetReservationGroupRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_delete_reservation_group_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.delete_reservation_group), + '__call__') as call: + call.return_value = None + client.delete_reservation_group(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.DeleteReservationGroupRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_list_reservation_groups_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_reservation_groups), + '__call__') as call: + call.return_value = reservation.ListReservationGroupsResponse() + client.list_reservation_groups(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.ListReservationGroupsRequest() + + assert args[0] == request_msg + + +def test_transport_kind_grpc_asyncio(): + transport = ReservationServiceAsyncClient.get_transport_class("grpc_asyncio")( + credentials=async_anonymous_credentials() + ) + assert transport.kind == "grpc_asyncio" + + +def test_initialize_client_w_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio" + ) + assert client is not None + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_create_reservation_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.create_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(gcbr_reservation.Reservation( + name='name_value', + slot_capacity=1391, + ignore_idle_slots=True, + concurrency=1195, + multi_region_auxiliary=True, + edition=gcbr_reservation.Edition.STANDARD, + primary_location='primary_location_value', + secondary_location='secondary_location_value', + original_primary_location='original_primary_location_value', + max_slots=986, + scaling_mode=gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + reservation_group='reservation_group_value', + )) + await client.create_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = gcbr_reservation.CreateReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_list_reservations_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_reservations), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListReservationsResponse( + next_page_token='next_page_token_value', + )) + await client.list_reservations(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.ListReservationsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_get_reservation_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Reservation( + name='name_value', + slot_capacity=1391, + ignore_idle_slots=True, + concurrency=1195, + multi_region_auxiliary=True, + edition=reservation.Edition.STANDARD, + primary_location='primary_location_value', + secondary_location='secondary_location_value', + original_primary_location='original_primary_location_value', + max_slots=986, + scaling_mode=reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + reservation_group='reservation_group_value', + )) + await client.get_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.GetReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_delete_reservation_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.delete_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.DeleteReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_update_reservation_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.update_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(gcbr_reservation.Reservation( + name='name_value', + slot_capacity=1391, + ignore_idle_slots=True, + concurrency=1195, + multi_region_auxiliary=True, + edition=gcbr_reservation.Edition.STANDARD, + primary_location='primary_location_value', + secondary_location='secondary_location_value', + original_primary_location='original_primary_location_value', + max_slots=986, + scaling_mode=gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + reservation_group='reservation_group_value', + )) + await client.update_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = gcbr_reservation.UpdateReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_failover_reservation_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.failover_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Reservation( + name='name_value', + slot_capacity=1391, + ignore_idle_slots=True, + concurrency=1195, + multi_region_auxiliary=True, + edition=reservation.Edition.STANDARD, + primary_location='primary_location_value', + secondary_location='secondary_location_value', + original_primary_location='original_primary_location_value', + max_slots=986, + scaling_mode=reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + reservation_group='reservation_group_value', + )) + await client.failover_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.FailoverReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_create_capacity_commitment_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.create_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment( + name='name_value', + slot_count=1098, + plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + state=reservation.CapacityCommitment.State.PENDING, + renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + multi_region_auxiliary=True, + edition=reservation.Edition.STANDARD, + is_flat_rate=True, + )) + await client.create_capacity_commitment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.CreateCapacityCommitmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_list_capacity_commitments_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_capacity_commitments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListCapacityCommitmentsResponse( + next_page_token='next_page_token_value', + )) + await client.list_capacity_commitments(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.ListCapacityCommitmentsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_get_capacity_commitment_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment( + name='name_value', + slot_count=1098, + plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + state=reservation.CapacityCommitment.State.PENDING, + renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + multi_region_auxiliary=True, + edition=reservation.Edition.STANDARD, + is_flat_rate=True, + )) + await client.get_capacity_commitment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.GetCapacityCommitmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_delete_capacity_commitment_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.delete_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_capacity_commitment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.DeleteCapacityCommitmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_update_capacity_commitment_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.update_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment( + name='name_value', + slot_count=1098, + plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + state=reservation.CapacityCommitment.State.PENDING, + renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + multi_region_auxiliary=True, + edition=reservation.Edition.STANDARD, + is_flat_rate=True, + )) + await client.update_capacity_commitment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.UpdateCapacityCommitmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_split_capacity_commitment_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.split_capacity_commitment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.SplitCapacityCommitmentResponse( + )) + await client.split_capacity_commitment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.SplitCapacityCommitmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_merge_capacity_commitments_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.merge_capacity_commitments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment( + name='name_value', + slot_count=1098, + plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + state=reservation.CapacityCommitment.State.PENDING, + renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + multi_region_auxiliary=True, + edition=reservation.Edition.STANDARD, + is_flat_rate=True, + )) + await client.merge_capacity_commitments(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.MergeCapacityCommitmentsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_create_assignment_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.create_assignment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment( + name='name_value', + assignee='assignee_value', + job_type=reservation.Assignment.JobType.PIPELINE, + state=reservation.Assignment.State.PENDING, + enable_gemini_in_bigquery=True, + )) + await client.create_assignment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.CreateAssignmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_list_assignments_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_assignments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListAssignmentsResponse( + next_page_token='next_page_token_value', + )) + await client.list_assignments(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.ListAssignmentsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_delete_assignment_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.delete_assignment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_assignment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.DeleteAssignmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_search_assignments_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.search_assignments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.SearchAssignmentsResponse( + next_page_token='next_page_token_value', + )) + await client.search_assignments(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.SearchAssignmentsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_search_all_assignments_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.search_all_assignments), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.SearchAllAssignmentsResponse( + next_page_token='next_page_token_value', + )) + await client.search_all_assignments(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.SearchAllAssignmentsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_move_assignment_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.move_assignment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment( + name='name_value', + assignee='assignee_value', + job_type=reservation.Assignment.JobType.PIPELINE, + state=reservation.Assignment.State.PENDING, + enable_gemini_in_bigquery=True, + )) + await client.move_assignment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.MoveAssignmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_update_assignment_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.update_assignment), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment( + name='name_value', + assignee='assignee_value', + job_type=reservation.Assignment.JobType.PIPELINE, + state=reservation.Assignment.State.PENDING, + enable_gemini_in_bigquery=True, + )) + await client.update_assignment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.UpdateAssignmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_get_bi_reservation_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_bi_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.BiReservation( + name='name_value', + size=443, + )) + await client.get_bi_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.GetBiReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_update_bi_reservation_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.update_bi_reservation), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.BiReservation( + name='name_value', + size=443, + )) + await client.update_bi_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.UpdateBiReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_get_iam_policy_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_iam_policy), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy( + version=774, + etag=b'etag_blob', + )) + await client.get_iam_policy(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = iam_policy_pb2.GetIamPolicyRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_set_iam_policy_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.set_iam_policy), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy( + version=774, + etag=b'etag_blob', + )) + await client.set_iam_policy(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = iam_policy_pb2.SetIamPolicyRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_test_iam_permissions_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.test_iam_permissions), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(iam_policy_pb2.TestIamPermissionsResponse( + permissions=['permissions_value'], + )) + await client.test_iam_permissions(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = iam_policy_pb2.TestIamPermissionsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_create_reservation_group_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.create_reservation_group), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ReservationGroup( + name='name_value', + )) + await client.create_reservation_group(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.CreateReservationGroupRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_get_reservation_group_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_reservation_group), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ReservationGroup( + name='name_value', + )) + await client.get_reservation_group(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.GetReservationGroupRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_delete_reservation_group_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.delete_reservation_group), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_reservation_group(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.DeleteReservationGroupRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_list_reservation_groups_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_reservation_groups), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListReservationGroupsResponse( + next_page_token='next_page_token_value', + )) + await client.list_reservation_groups(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.ListReservationGroupsRequest() + + assert args[0] == request_msg + + +def test_transport_kind_rest(): + transport = ReservationServiceClient.get_transport_class("rest")( + credentials=ga_credentials.AnonymousCredentials() + ) + assert transport.kind == "rest" + + +def test_create_reservation_rest_bad_request(request_type=gcbr_reservation.CreateReservationRequest): + client = ReservationServiceClient( + 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 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 = mock.Mock() + json_return_value = '' + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.create_reservation(request) + + +@pytest.mark.parametrize("request_type", [ + gcbr_reservation.CreateReservationRequest, + dict, +]) +def test_create_reservation_rest_call_success(request_type): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request_init["reservation"] = {'name': 'name_value', 'slot_capacity': 1391, 'ignore_idle_slots': True, 'autoscale': {'current_slots': 1431, 'max_slots': 986}, 'concurrency': 1195, 'creation_time': {'seconds': 751, 'nanos': 543}, 'update_time': {}, 'multi_region_auxiliary': True, 'edition': 1, 'primary_location': 'primary_location_value', 'secondary_location': 'secondary_location_value', 'original_primary_location': 'original_primary_location_value', 'max_slots': 986, 'scaling_mode': 1, 'labels': {}, 'reservation_group': 'reservation_group_value', 'replication_status': {'error': {'code': 411, 'message': 'message_value', 'details': [{'type_url': 'type.googleapis.com/google.protobuf.Duration', 'value': b'\x08\x0c\x10\xdb\x07'}]}, 'last_error_time': {}, 'last_replication_time': {}, 'soft_failover_start_time': {}}, 'scheduling_policy': {'concurrency': 1195, 'max_slots': 986}} + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = gcbr_reservation.CreateReservationRequest.meta.fields["reservation"] + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["reservation"].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + {"field": field, "subfield": subfield, "is_repeated": is_repeated} + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["reservation"][field])): + del request_init["reservation"][field][i][subfield] + else: + del request_init["reservation"][field][subfield] + 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 = gcbr_reservation.Reservation( + name='name_value', + slot_capacity=1391, + ignore_idle_slots=True, + concurrency=1195, + multi_region_auxiliary=True, + edition=gcbr_reservation.Edition.STANDARD, + primary_location='primary_location_value', + secondary_location='secondary_location_value', + original_primary_location='original_primary_location_value', + max_slots=986, + scaling_mode=gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + reservation_group='reservation_group_value', + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = gcbr_reservation.Reservation.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.create_reservation(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, gcbr_reservation.Reservation) + assert response.name == 'name_value' + assert response.slot_capacity == 1391 + assert response.ignore_idle_slots is True + assert response.concurrency == 1195 + assert response.multi_region_auxiliary is True + assert response.edition == gcbr_reservation.Edition.STANDARD + assert response.primary_location == 'primary_location_value' + assert response.secondary_location == 'secondary_location_value' + assert response.original_primary_location == 'original_primary_location_value' + assert response.max_slots == 986 + assert response.scaling_mode == gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY + assert response.reservation_group == 'reservation_group_value' + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_reservation_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), + ) + client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_create_reservation") as post, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "post_create_reservation_with_metadata") as post_with_metadata, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_create_reservation") as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = gcbr_reservation.CreateReservationRequest.pb(gcbr_reservation.CreateReservationRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = gcbr_reservation.Reservation.to_json(gcbr_reservation.Reservation()) + req.return_value.content = return_value + + request = gcbr_reservation.CreateReservationRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = gcbr_reservation.Reservation() + post_with_metadata.return_value = gcbr_reservation.Reservation(), metadata + + client.create_reservation(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_list_reservations_rest_bad_request(request_type=reservation.ListReservationsRequest): + client = ReservationServiceClient( + 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 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 = mock.Mock() + json_return_value = '' + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.list_reservations(request) + + +@pytest.mark.parametrize("request_type", [ + reservation.ListReservationsRequest, + dict, +]) +def test_list_reservations_rest_call_success(request_type): + client = ReservationServiceClient( + 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 = reservation.ListReservationsResponse( + next_page_token='next_page_token_value', + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = reservation.ListReservationsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.list_reservations(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListReservationsPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_reservations_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), + ) + client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_list_reservations") as post, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "post_list_reservations_with_metadata") as post_with_metadata, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_list_reservations") as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = reservation.ListReservationsRequest.pb(reservation.ListReservationsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = reservation.ListReservationsResponse.to_json(reservation.ListReservationsResponse()) + req.return_value.content = return_value + + request = reservation.ListReservationsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = reservation.ListReservationsResponse() + post_with_metadata.return_value = reservation.ListReservationsResponse(), metadata + + client.list_reservations(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_get_reservation_rest_bad_request(request_type=reservation.GetReservationRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/reservations/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 = mock.Mock() + json_return_value = '' + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.get_reservation(request) + + +@pytest.mark.parametrize("request_type", [ + reservation.GetReservationRequest, + dict, +]) +def test_get_reservation_rest_call_success(request_type): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/reservations/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 = reservation.Reservation( + name='name_value', + slot_capacity=1391, + ignore_idle_slots=True, + concurrency=1195, + multi_region_auxiliary=True, + edition=reservation.Edition.STANDARD, + primary_location='primary_location_value', + secondary_location='secondary_location_value', + original_primary_location='original_primary_location_value', + max_slots=986, + scaling_mode=reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + reservation_group='reservation_group_value', + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = reservation.Reservation.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.get_reservation(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.Reservation) + assert response.name == 'name_value' + assert response.slot_capacity == 1391 + assert response.ignore_idle_slots is True + assert response.concurrency == 1195 + assert response.multi_region_auxiliary is True + assert response.edition == reservation.Edition.STANDARD + assert response.primary_location == 'primary_location_value' + assert response.secondary_location == 'secondary_location_value' + assert response.original_primary_location == 'original_primary_location_value' + assert response.max_slots == 986 + assert response.scaling_mode == reservation.Reservation.ScalingMode.AUTOSCALE_ONLY + assert response.reservation_group == 'reservation_group_value' + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_reservation_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), + ) + client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_get_reservation") as post, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "post_get_reservation_with_metadata") as post_with_metadata, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_get_reservation") as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = reservation.GetReservationRequest.pb(reservation.GetReservationRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = reservation.Reservation.to_json(reservation.Reservation()) + req.return_value.content = return_value + + request = reservation.GetReservationRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = reservation.Reservation() + post_with_metadata.return_value = reservation.Reservation(), metadata + + client.get_reservation(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_delete_reservation_rest_bad_request(request_type=reservation.DeleteReservationRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/reservations/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 = mock.Mock() + json_return_value = '' + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.delete_reservation(request) + + +@pytest.mark.parametrize("request_type", [ + reservation.DeleteReservationRequest, + dict, +]) +def test_delete_reservation_rest_call_success(request_type): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/reservations/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 = mock.Mock() + response_value.status_code = 200 + json_return_value = '' + response_value.content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.delete_reservation(request) + + # Establish that the response is the type that we expect. + assert response is None + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_reservation_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), + ) + client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "pre_delete_reservation") as pre: + pre.assert_not_called() + pb_message = reservation.DeleteReservationRequest.pb(reservation.DeleteReservationRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + request = reservation.DeleteReservationRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_reservation(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + + +def test_update_reservation_rest_bad_request(request_type=gcbr_reservation.UpdateReservationRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {'reservation': {'name': 'projects/sample1/locations/sample2/reservations/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 = mock.Mock() + json_return_value = '' + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.update_reservation(request) + + +@pytest.mark.parametrize("request_type", [ + gcbr_reservation.UpdateReservationRequest, + dict, +]) +def test_update_reservation_rest_call_success(request_type): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {'reservation': {'name': 'projects/sample1/locations/sample2/reservations/sample3'}} + request_init["reservation"] = {'name': 'projects/sample1/locations/sample2/reservations/sample3', 'slot_capacity': 1391, 'ignore_idle_slots': True, 'autoscale': {'current_slots': 1431, 'max_slots': 986}, 'concurrency': 1195, 'creation_time': {'seconds': 751, 'nanos': 543}, 'update_time': {}, 'multi_region_auxiliary': True, 'edition': 1, 'primary_location': 'primary_location_value', 'secondary_location': 'secondary_location_value', 'original_primary_location': 'original_primary_location_value', 'max_slots': 986, 'scaling_mode': 1, 'labels': {}, 'reservation_group': 'reservation_group_value', 'replication_status': {'error': {'code': 411, 'message': 'message_value', 'details': [{'type_url': 'type.googleapis.com/google.protobuf.Duration', 'value': b'\x08\x0c\x10\xdb\x07'}]}, 'last_error_time': {}, 'last_replication_time': {}, 'soft_failover_start_time': {}}, 'scheduling_policy': {'concurrency': 1195, 'max_slots': 986}} + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = gcbr_reservation.UpdateReservationRequest.meta.fields["reservation"] + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["reservation"].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + {"field": field, "subfield": subfield, "is_repeated": is_repeated} + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["reservation"][field])): + del request_init["reservation"][field][i][subfield] + else: + del request_init["reservation"][field][subfield] + 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 = gcbr_reservation.Reservation( + name='name_value', + slot_capacity=1391, + ignore_idle_slots=True, + concurrency=1195, + multi_region_auxiliary=True, + edition=gcbr_reservation.Edition.STANDARD, + primary_location='primary_location_value', + secondary_location='secondary_location_value', + original_primary_location='original_primary_location_value', + max_slots=986, + scaling_mode=gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + reservation_group='reservation_group_value', + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = gcbr_reservation.Reservation.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.update_reservation(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, gcbr_reservation.Reservation) + assert response.name == 'name_value' + assert response.slot_capacity == 1391 + assert response.ignore_idle_slots is True + assert response.concurrency == 1195 + assert response.multi_region_auxiliary is True + assert response.edition == gcbr_reservation.Edition.STANDARD + assert response.primary_location == 'primary_location_value' + assert response.secondary_location == 'secondary_location_value' + assert response.original_primary_location == 'original_primary_location_value' + assert response.max_slots == 986 + assert response.scaling_mode == gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY + assert response.reservation_group == 'reservation_group_value' + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_reservation_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), + ) + client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_update_reservation") as post, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "post_update_reservation_with_metadata") as post_with_metadata, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_update_reservation") as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = gcbr_reservation.UpdateReservationRequest.pb(gcbr_reservation.UpdateReservationRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = gcbr_reservation.Reservation.to_json(gcbr_reservation.Reservation()) + req.return_value.content = return_value + + request = gcbr_reservation.UpdateReservationRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = gcbr_reservation.Reservation() + post_with_metadata.return_value = gcbr_reservation.Reservation(), metadata + + client.update_reservation(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_failover_reservation_rest_bad_request(request_type=reservation.FailoverReservationRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/reservations/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 = mock.Mock() + json_return_value = '' + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.failover_reservation(request) + + +@pytest.mark.parametrize("request_type", [ + reservation.FailoverReservationRequest, + dict, +]) +def test_failover_reservation_rest_call_success(request_type): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/reservations/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 = reservation.Reservation( + name='name_value', + slot_capacity=1391, + ignore_idle_slots=True, + concurrency=1195, + multi_region_auxiliary=True, + edition=reservation.Edition.STANDARD, + primary_location='primary_location_value', + secondary_location='secondary_location_value', + original_primary_location='original_primary_location_value', + max_slots=986, + scaling_mode=reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + reservation_group='reservation_group_value', + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = reservation.Reservation.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.failover_reservation(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.Reservation) + assert response.name == 'name_value' + assert response.slot_capacity == 1391 + assert response.ignore_idle_slots is True + assert response.concurrency == 1195 + assert response.multi_region_auxiliary is True + assert response.edition == reservation.Edition.STANDARD + assert response.primary_location == 'primary_location_value' + assert response.secondary_location == 'secondary_location_value' + assert response.original_primary_location == 'original_primary_location_value' + assert response.max_slots == 986 + assert response.scaling_mode == reservation.Reservation.ScalingMode.AUTOSCALE_ONLY + assert response.reservation_group == 'reservation_group_value' + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_failover_reservation_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), + ) + client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_failover_reservation") as post, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "post_failover_reservation_with_metadata") as post_with_metadata, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_failover_reservation") as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = reservation.FailoverReservationRequest.pb(reservation.FailoverReservationRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = reservation.Reservation.to_json(reservation.Reservation()) + req.return_value.content = return_value + + request = reservation.FailoverReservationRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = reservation.Reservation() + post_with_metadata.return_value = reservation.Reservation(), metadata + + client.failover_reservation(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_create_capacity_commitment_rest_bad_request(request_type=reservation.CreateCapacityCommitmentRequest): + client = ReservationServiceClient( + 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 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 = mock.Mock() + json_return_value = '' + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.create_capacity_commitment(request) + + +@pytest.mark.parametrize("request_type", [ + reservation.CreateCapacityCommitmentRequest, + dict, +]) +def test_create_capacity_commitment_rest_call_success(request_type): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request_init["capacity_commitment"] = {'name': 'name_value', 'slot_count': 1098, 'plan': 3, 'state': 1, 'commitment_start_time': {'seconds': 751, 'nanos': 543}, 'commitment_end_time': {}, 'failure_status': {'code': 411, 'message': 'message_value', 'details': [{'type_url': 'type.googleapis.com/google.protobuf.Duration', 'value': b'\x08\x0c\x10\xdb\x07'}]}, 'renewal_plan': 3, 'multi_region_auxiliary': True, 'edition': 1, 'is_flat_rate': True} + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = reservation.CreateCapacityCommitmentRequest.meta.fields["capacity_commitment"] + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["capacity_commitment"].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + {"field": field, "subfield": subfield, "is_repeated": is_repeated} + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["capacity_commitment"][field])): + del request_init["capacity_commitment"][field][i][subfield] + else: + del request_init["capacity_commitment"][field][subfield] + 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 = reservation.CapacityCommitment( + name='name_value', + slot_count=1098, + plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + state=reservation.CapacityCommitment.State.PENDING, + renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + multi_region_auxiliary=True, + edition=reservation.Edition.STANDARD, + is_flat_rate=True, + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = reservation.CapacityCommitment.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.create_capacity_commitment(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.CapacityCommitment) + assert response.name == 'name_value' + assert response.slot_count == 1098 + assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.state == reservation.CapacityCommitment.State.PENDING + assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.multi_region_auxiliary is True + assert response.edition == reservation.Edition.STANDARD + assert response.is_flat_rate is True + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_capacity_commitment_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), + ) + client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_create_capacity_commitment") as post, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "post_create_capacity_commitment_with_metadata") as post_with_metadata, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_create_capacity_commitment") as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = reservation.CreateCapacityCommitmentRequest.pb(reservation.CreateCapacityCommitmentRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = reservation.CapacityCommitment.to_json(reservation.CapacityCommitment()) + req.return_value.content = return_value + + request = reservation.CreateCapacityCommitmentRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = reservation.CapacityCommitment() + post_with_metadata.return_value = reservation.CapacityCommitment(), metadata + + client.create_capacity_commitment(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_list_capacity_commitments_rest_bad_request(request_type=reservation.ListCapacityCommitmentsRequest): + client = ReservationServiceClient( + 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 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 = mock.Mock() + json_return_value = '' + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.list_capacity_commitments(request) + + +@pytest.mark.parametrize("request_type", [ + reservation.ListCapacityCommitmentsRequest, + dict, +]) +def test_list_capacity_commitments_rest_call_success(request_type): + client = ReservationServiceClient( + 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 = reservation.ListCapacityCommitmentsResponse( + next_page_token='next_page_token_value', + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = reservation.ListCapacityCommitmentsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.list_capacity_commitments(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListCapacityCommitmentsPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_capacity_commitments_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), + ) + client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_list_capacity_commitments") as post, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "post_list_capacity_commitments_with_metadata") as post_with_metadata, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_list_capacity_commitments") as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = reservation.ListCapacityCommitmentsRequest.pb(reservation.ListCapacityCommitmentsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = reservation.ListCapacityCommitmentsResponse.to_json(reservation.ListCapacityCommitmentsResponse()) + req.return_value.content = return_value + + request = reservation.ListCapacityCommitmentsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = reservation.ListCapacityCommitmentsResponse() + post_with_metadata.return_value = reservation.ListCapacityCommitmentsResponse(), metadata + + client.list_capacity_commitments(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_get_capacity_commitment_rest_bad_request(request_type=reservation.GetCapacityCommitmentRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/capacityCommitments/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 = mock.Mock() + json_return_value = '' + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.get_capacity_commitment(request) + + +@pytest.mark.parametrize("request_type", [ + reservation.GetCapacityCommitmentRequest, + dict, +]) +def test_get_capacity_commitment_rest_call_success(request_type): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/capacityCommitments/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 = reservation.CapacityCommitment( + name='name_value', + slot_count=1098, + plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + state=reservation.CapacityCommitment.State.PENDING, + renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + multi_region_auxiliary=True, + edition=reservation.Edition.STANDARD, + is_flat_rate=True, + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = reservation.CapacityCommitment.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.get_capacity_commitment(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.CapacityCommitment) + assert response.name == 'name_value' + assert response.slot_count == 1098 + assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.state == reservation.CapacityCommitment.State.PENDING + assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.multi_region_auxiliary is True + assert response.edition == reservation.Edition.STANDARD + assert response.is_flat_rate is True + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_capacity_commitment_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), + ) + client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_get_capacity_commitment") as post, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "post_get_capacity_commitment_with_metadata") as post_with_metadata, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_get_capacity_commitment") as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = reservation.GetCapacityCommitmentRequest.pb(reservation.GetCapacityCommitmentRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = reservation.CapacityCommitment.to_json(reservation.CapacityCommitment()) + req.return_value.content = return_value + + request = reservation.GetCapacityCommitmentRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = reservation.CapacityCommitment() + post_with_metadata.return_value = reservation.CapacityCommitment(), metadata + + client.get_capacity_commitment(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_delete_capacity_commitment_rest_bad_request(request_type=reservation.DeleteCapacityCommitmentRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/capacityCommitments/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 = mock.Mock() + json_return_value = '' + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.delete_capacity_commitment(request) + + +@pytest.mark.parametrize("request_type", [ + reservation.DeleteCapacityCommitmentRequest, + dict, +]) +def test_delete_capacity_commitment_rest_call_success(request_type): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/capacityCommitments/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 = mock.Mock() + response_value.status_code = 200 + json_return_value = '' + response_value.content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.delete_capacity_commitment(request) + + # Establish that the response is the type that we expect. + assert response is None + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_capacity_commitment_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), + ) + client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "pre_delete_capacity_commitment") as pre: + pre.assert_not_called() + pb_message = reservation.DeleteCapacityCommitmentRequest.pb(reservation.DeleteCapacityCommitmentRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + request = reservation.DeleteCapacityCommitmentRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_capacity_commitment(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + + +def test_update_capacity_commitment_rest_bad_request(request_type=reservation.UpdateCapacityCommitmentRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {'capacity_commitment': {'name': 'projects/sample1/locations/sample2/capacityCommitments/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 = mock.Mock() + json_return_value = '' + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.update_capacity_commitment(request) + + +@pytest.mark.parametrize("request_type", [ + reservation.UpdateCapacityCommitmentRequest, + dict, +]) +def test_update_capacity_commitment_rest_call_success(request_type): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {'capacity_commitment': {'name': 'projects/sample1/locations/sample2/capacityCommitments/sample3'}} + request_init["capacity_commitment"] = {'name': 'projects/sample1/locations/sample2/capacityCommitments/sample3', 'slot_count': 1098, 'plan': 3, 'state': 1, 'commitment_start_time': {'seconds': 751, 'nanos': 543}, 'commitment_end_time': {}, 'failure_status': {'code': 411, 'message': 'message_value', 'details': [{'type_url': 'type.googleapis.com/google.protobuf.Duration', 'value': b'\x08\x0c\x10\xdb\x07'}]}, 'renewal_plan': 3, 'multi_region_auxiliary': True, 'edition': 1, 'is_flat_rate': True} + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = reservation.UpdateCapacityCommitmentRequest.meta.fields["capacity_commitment"] + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["capacity_commitment"].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + {"field": field, "subfield": subfield, "is_repeated": is_repeated} + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["capacity_commitment"][field])): + del request_init["capacity_commitment"][field][i][subfield] + else: + del request_init["capacity_commitment"][field][subfield] + 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 = reservation.CapacityCommitment( + name='name_value', + slot_count=1098, + plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + state=reservation.CapacityCommitment.State.PENDING, + renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + multi_region_auxiliary=True, + edition=reservation.Edition.STANDARD, + is_flat_rate=True, + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = reservation.CapacityCommitment.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.update_capacity_commitment(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.CapacityCommitment) + assert response.name == 'name_value' + assert response.slot_count == 1098 + assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.state == reservation.CapacityCommitment.State.PENDING + assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.multi_region_auxiliary is True + assert response.edition == reservation.Edition.STANDARD + assert response.is_flat_rate is True + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_capacity_commitment_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), + ) + client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_update_capacity_commitment") as post, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "post_update_capacity_commitment_with_metadata") as post_with_metadata, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_update_capacity_commitment") as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = reservation.UpdateCapacityCommitmentRequest.pb(reservation.UpdateCapacityCommitmentRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = reservation.CapacityCommitment.to_json(reservation.CapacityCommitment()) + req.return_value.content = return_value + + request = reservation.UpdateCapacityCommitmentRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = reservation.CapacityCommitment() + post_with_metadata.return_value = reservation.CapacityCommitment(), metadata + + client.update_capacity_commitment(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_split_capacity_commitment_rest_bad_request(request_type=reservation.SplitCapacityCommitmentRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/capacityCommitments/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 = mock.Mock() + json_return_value = '' + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.split_capacity_commitment(request) + + +@pytest.mark.parametrize("request_type", [ + reservation.SplitCapacityCommitmentRequest, + dict, +]) +def test_split_capacity_commitment_rest_call_success(request_type): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/capacityCommitments/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 = reservation.SplitCapacityCommitmentResponse( + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = reservation.SplitCapacityCommitmentResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.split_capacity_commitment(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.SplitCapacityCommitmentResponse) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_split_capacity_commitment_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), + ) + client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_split_capacity_commitment") as post, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "post_split_capacity_commitment_with_metadata") as post_with_metadata, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_split_capacity_commitment") as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = reservation.SplitCapacityCommitmentRequest.pb(reservation.SplitCapacityCommitmentRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = reservation.SplitCapacityCommitmentResponse.to_json(reservation.SplitCapacityCommitmentResponse()) + req.return_value.content = return_value + + request = reservation.SplitCapacityCommitmentRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = reservation.SplitCapacityCommitmentResponse() + post_with_metadata.return_value = reservation.SplitCapacityCommitmentResponse(), metadata + + client.split_capacity_commitment(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_merge_capacity_commitments_rest_bad_request(request_type=reservation.MergeCapacityCommitmentsRequest): + client = ReservationServiceClient( + 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 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 = mock.Mock() + json_return_value = '' + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.merge_capacity_commitments(request) + + +@pytest.mark.parametrize("request_type", [ + reservation.MergeCapacityCommitmentsRequest, + dict, +]) +def test_merge_capacity_commitments_rest_call_success(request_type): + client = ReservationServiceClient( + 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 = reservation.CapacityCommitment( + name='name_value', + slot_count=1098, + plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + state=reservation.CapacityCommitment.State.PENDING, + renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + multi_region_auxiliary=True, + edition=reservation.Edition.STANDARD, + is_flat_rate=True, + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = reservation.CapacityCommitment.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.merge_capacity_commitments(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.CapacityCommitment) + assert response.name == 'name_value' + assert response.slot_count == 1098 + assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.state == reservation.CapacityCommitment.State.PENDING + assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.multi_region_auxiliary is True + assert response.edition == reservation.Edition.STANDARD + assert response.is_flat_rate is True + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_merge_capacity_commitments_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), + ) + client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_merge_capacity_commitments") as post, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "post_merge_capacity_commitments_with_metadata") as post_with_metadata, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_merge_capacity_commitments") as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = reservation.MergeCapacityCommitmentsRequest.pb(reservation.MergeCapacityCommitmentsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = reservation.CapacityCommitment.to_json(reservation.CapacityCommitment()) + req.return_value.content = return_value + + request = reservation.MergeCapacityCommitmentsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = reservation.CapacityCommitment() + post_with_metadata.return_value = reservation.CapacityCommitment(), metadata + + client.merge_capacity_commitments(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_create_assignment_rest_bad_request(request_type=reservation.CreateAssignmentRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2/reservations/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 = mock.Mock() + json_return_value = '' + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.create_assignment(request) + + +@pytest.mark.parametrize("request_type", [ + reservation.CreateAssignmentRequest, + dict, +]) +def test_create_assignment_rest_call_success(request_type): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2/reservations/sample3'} + request_init["assignment"] = {'name': 'name_value', 'assignee': 'assignee_value', 'job_type': 1, 'state': 1, 'enable_gemini_in_bigquery': True, 'scheduling_policy': {'concurrency': 1195, 'max_slots': 986}} + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = reservation.CreateAssignmentRequest.meta.fields["assignment"] + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["assignment"].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + {"field": field, "subfield": subfield, "is_repeated": is_repeated} + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["assignment"][field])): + del request_init["assignment"][field][i][subfield] + else: + del request_init["assignment"][field][subfield] + 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 = reservation.Assignment( + name='name_value', + assignee='assignee_value', + job_type=reservation.Assignment.JobType.PIPELINE, + state=reservation.Assignment.State.PENDING, + enable_gemini_in_bigquery=True, + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = reservation.Assignment.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.create_assignment(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.Assignment) + assert response.name == 'name_value' + assert response.assignee == 'assignee_value' + assert response.job_type == reservation.Assignment.JobType.PIPELINE + assert response.state == reservation.Assignment.State.PENDING + assert response.enable_gemini_in_bigquery is True + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_assignment_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), + ) + client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_create_assignment") as post, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "post_create_assignment_with_metadata") as post_with_metadata, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_create_assignment") as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = reservation.CreateAssignmentRequest.pb(reservation.CreateAssignmentRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = reservation.Assignment.to_json(reservation.Assignment()) + req.return_value.content = return_value + + request = reservation.CreateAssignmentRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = reservation.Assignment() + post_with_metadata.return_value = reservation.Assignment(), metadata + + client.create_assignment(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_list_assignments_rest_bad_request(request_type=reservation.ListAssignmentsRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2/reservations/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 = mock.Mock() + json_return_value = '' + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.list_assignments(request) + + +@pytest.mark.parametrize("request_type", [ + reservation.ListAssignmentsRequest, + dict, +]) +def test_list_assignments_rest_call_success(request_type): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2/reservations/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 = reservation.ListAssignmentsResponse( + next_page_token='next_page_token_value', + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = reservation.ListAssignmentsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.list_assignments(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListAssignmentsPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_assignments_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), + ) + client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_list_assignments") as post, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "post_list_assignments_with_metadata") as post_with_metadata, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_list_assignments") as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = reservation.ListAssignmentsRequest.pb(reservation.ListAssignmentsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = reservation.ListAssignmentsResponse.to_json(reservation.ListAssignmentsResponse()) + req.return_value.content = return_value + + request = reservation.ListAssignmentsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = reservation.ListAssignmentsResponse() + post_with_metadata.return_value = reservation.ListAssignmentsResponse(), metadata + + client.list_assignments(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_delete_assignment_rest_bad_request(request_type=reservation.DeleteAssignmentRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/reservations/sample3/assignments/sample4'} + 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 = mock.Mock() + json_return_value = '' + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.delete_assignment(request) + + +@pytest.mark.parametrize("request_type", [ + reservation.DeleteAssignmentRequest, + dict, +]) +def test_delete_assignment_rest_call_success(request_type): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/reservations/sample3/assignments/sample4'} + 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 = mock.Mock() + response_value.status_code = 200 + json_return_value = '' + response_value.content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.delete_assignment(request) + + # Establish that the response is the type that we expect. + assert response is None + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_assignment_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), + ) + client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "pre_delete_assignment") as pre: + pre.assert_not_called() + pb_message = reservation.DeleteAssignmentRequest.pb(reservation.DeleteAssignmentRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + request = reservation.DeleteAssignmentRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_assignment(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + + +def test_search_assignments_rest_bad_request(request_type=reservation.SearchAssignmentsRequest): + client = ReservationServiceClient( + 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 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 = mock.Mock() + json_return_value = '' + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.search_assignments(request) + + +@pytest.mark.parametrize("request_type", [ + reservation.SearchAssignmentsRequest, + dict, +]) +def test_search_assignments_rest_call_success(request_type): + client = ReservationServiceClient( + 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 = reservation.SearchAssignmentsResponse( + next_page_token='next_page_token_value', + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = reservation.SearchAssignmentsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.search_assignments(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.SearchAssignmentsPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_search_assignments_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), + ) + client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_search_assignments") as post, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "post_search_assignments_with_metadata") as post_with_metadata, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_search_assignments") as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = reservation.SearchAssignmentsRequest.pb(reservation.SearchAssignmentsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = reservation.SearchAssignmentsResponse.to_json(reservation.SearchAssignmentsResponse()) + req.return_value.content = return_value + + request = reservation.SearchAssignmentsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = reservation.SearchAssignmentsResponse() + post_with_metadata.return_value = reservation.SearchAssignmentsResponse(), metadata + + client.search_assignments(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_search_all_assignments_rest_bad_request(request_type=reservation.SearchAllAssignmentsRequest): + client = ReservationServiceClient( + 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 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 = mock.Mock() + json_return_value = '' + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.search_all_assignments(request) + + +@pytest.mark.parametrize("request_type", [ + reservation.SearchAllAssignmentsRequest, + dict, +]) +def test_search_all_assignments_rest_call_success(request_type): + client = ReservationServiceClient( + 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 = reservation.SearchAllAssignmentsResponse( + next_page_token='next_page_token_value', + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = reservation.SearchAllAssignmentsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.search_all_assignments(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.SearchAllAssignmentsPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_search_all_assignments_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), + ) + client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_search_all_assignments") as post, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "post_search_all_assignments_with_metadata") as post_with_metadata, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_search_all_assignments") as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = reservation.SearchAllAssignmentsRequest.pb(reservation.SearchAllAssignmentsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = reservation.SearchAllAssignmentsResponse.to_json(reservation.SearchAllAssignmentsResponse()) + req.return_value.content = return_value + + request = reservation.SearchAllAssignmentsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = reservation.SearchAllAssignmentsResponse() + post_with_metadata.return_value = reservation.SearchAllAssignmentsResponse(), metadata + + client.search_all_assignments(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_move_assignment_rest_bad_request(request_type=reservation.MoveAssignmentRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/reservations/sample3/assignments/sample4'} + 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 = mock.Mock() + json_return_value = '' + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.move_assignment(request) + + +@pytest.mark.parametrize("request_type", [ + reservation.MoveAssignmentRequest, + dict, +]) +def test_move_assignment_rest_call_success(request_type): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/reservations/sample3/assignments/sample4'} + 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 = reservation.Assignment( + name='name_value', + assignee='assignee_value', + job_type=reservation.Assignment.JobType.PIPELINE, + state=reservation.Assignment.State.PENDING, + enable_gemini_in_bigquery=True, + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = reservation.Assignment.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.move_assignment(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.Assignment) + assert response.name == 'name_value' + assert response.assignee == 'assignee_value' + assert response.job_type == reservation.Assignment.JobType.PIPELINE + assert response.state == reservation.Assignment.State.PENDING + assert response.enable_gemini_in_bigquery is True + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_move_assignment_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), + ) + client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_move_assignment") as post, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "post_move_assignment_with_metadata") as post_with_metadata, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_move_assignment") as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = reservation.MoveAssignmentRequest.pb(reservation.MoveAssignmentRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = reservation.Assignment.to_json(reservation.Assignment()) + req.return_value.content = return_value + + request = reservation.MoveAssignmentRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = reservation.Assignment() + post_with_metadata.return_value = reservation.Assignment(), metadata + + client.move_assignment(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_update_assignment_rest_bad_request(request_type=reservation.UpdateAssignmentRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {'assignment': {'name': 'projects/sample1/locations/sample2/reservations/sample3/assignments/sample4'}} + 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 = mock.Mock() + json_return_value = '' + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.update_assignment(request) + + +@pytest.mark.parametrize("request_type", [ + reservation.UpdateAssignmentRequest, + dict, +]) +def test_update_assignment_rest_call_success(request_type): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {'assignment': {'name': 'projects/sample1/locations/sample2/reservations/sample3/assignments/sample4'}} + request_init["assignment"] = {'name': 'projects/sample1/locations/sample2/reservations/sample3/assignments/sample4', 'assignee': 'assignee_value', 'job_type': 1, 'state': 1, 'enable_gemini_in_bigquery': True, 'scheduling_policy': {'concurrency': 1195, 'max_slots': 986}} + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = reservation.UpdateAssignmentRequest.meta.fields["assignment"] + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["assignment"].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + {"field": field, "subfield": subfield, "is_repeated": is_repeated} + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["assignment"][field])): + del request_init["assignment"][field][i][subfield] + else: + del request_init["assignment"][field][subfield] + 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 = reservation.Assignment( + name='name_value', + assignee='assignee_value', + job_type=reservation.Assignment.JobType.PIPELINE, + state=reservation.Assignment.State.PENDING, + enable_gemini_in_bigquery=True, + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = reservation.Assignment.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.update_assignment(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.Assignment) + assert response.name == 'name_value' + assert response.assignee == 'assignee_value' + assert response.job_type == reservation.Assignment.JobType.PIPELINE + assert response.state == reservation.Assignment.State.PENDING + assert response.enable_gemini_in_bigquery is True + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_assignment_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), + ) + client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_update_assignment") as post, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "post_update_assignment_with_metadata") as post_with_metadata, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_update_assignment") as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = reservation.UpdateAssignmentRequest.pb(reservation.UpdateAssignmentRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = reservation.Assignment.to_json(reservation.Assignment()) + req.return_value.content = return_value + + request = reservation.UpdateAssignmentRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = reservation.Assignment() + post_with_metadata.return_value = reservation.Assignment(), metadata + + client.update_assignment(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_get_bi_reservation_rest_bad_request(request_type=reservation.GetBiReservationRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/biReservation'} + 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 = mock.Mock() + json_return_value = '' + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.get_bi_reservation(request) + + +@pytest.mark.parametrize("request_type", [ + reservation.GetBiReservationRequest, + dict, +]) +def test_get_bi_reservation_rest_call_success(request_type): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/biReservation'} + 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 = reservation.BiReservation( + name='name_value', + size=443, + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = reservation.BiReservation.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.get_bi_reservation(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.BiReservation) + assert response.name == 'name_value' + assert response.size == 443 + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_bi_reservation_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), + ) + client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_get_bi_reservation") as post, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "post_get_bi_reservation_with_metadata") as post_with_metadata, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_get_bi_reservation") as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = reservation.GetBiReservationRequest.pb(reservation.GetBiReservationRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = reservation.BiReservation.to_json(reservation.BiReservation()) + req.return_value.content = return_value + + request = reservation.GetBiReservationRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = reservation.BiReservation() + post_with_metadata.return_value = reservation.BiReservation(), metadata + + client.get_bi_reservation(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_update_bi_reservation_rest_bad_request(request_type=reservation.UpdateBiReservationRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {'bi_reservation': {'name': 'projects/sample1/locations/sample2/biReservation'}} + 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 = mock.Mock() + json_return_value = '' + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.update_bi_reservation(request) + + +@pytest.mark.parametrize("request_type", [ + reservation.UpdateBiReservationRequest, + dict, +]) +def test_update_bi_reservation_rest_call_success(request_type): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {'bi_reservation': {'name': 'projects/sample1/locations/sample2/biReservation'}} + request_init["bi_reservation"] = {'name': 'projects/sample1/locations/sample2/biReservation', 'update_time': {'seconds': 751, 'nanos': 543}, 'size': 443, 'preferred_tables': [{'project_id': 'project_id_value', 'dataset_id': 'dataset_id_value', 'table_id': 'table_id_value'}]} + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = reservation.UpdateBiReservationRequest.meta.fields["bi_reservation"] + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["bi_reservation"].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + {"field": field, "subfield": subfield, "is_repeated": is_repeated} + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["bi_reservation"][field])): + del request_init["bi_reservation"][field][i][subfield] + else: + del request_init["bi_reservation"][field][subfield] + 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 = reservation.BiReservation( + name='name_value', + size=443, + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = reservation.BiReservation.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.update_bi_reservation(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.BiReservation) + assert response.name == 'name_value' + assert response.size == 443 + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_bi_reservation_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), + ) + client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_update_bi_reservation") as post, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "post_update_bi_reservation_with_metadata") as post_with_metadata, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_update_bi_reservation") as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = reservation.UpdateBiReservationRequest.pb(reservation.UpdateBiReservationRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = reservation.BiReservation.to_json(reservation.BiReservation()) + req.return_value.content = return_value + + request = reservation.UpdateBiReservationRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = reservation.BiReservation() + post_with_metadata.return_value = reservation.BiReservation(), metadata + + client.update_bi_reservation(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_get_iam_policy_rest_bad_request(request_type=iam_policy_pb2.GetIamPolicyRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {'resource': 'projects/sample1/locations/sample2/reservations/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 = mock.Mock() + json_return_value = '' + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.get_iam_policy(request) + + +@pytest.mark.parametrize("request_type", [ + iam_policy_pb2.GetIamPolicyRequest, + dict, +]) +def test_get_iam_policy_rest_call_success(request_type): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {'resource': 'projects/sample1/locations/sample2/reservations/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 = policy_pb2.Policy( + version=774, + etag=b'etag_blob', + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + 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 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.get_iam_policy(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, policy_pb2.Policy) + assert response.version == 774 + assert response.etag == b'etag_blob' + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_iam_policy_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), + ) + client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_get_iam_policy") as post, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "post_get_iam_policy_with_metadata") as post_with_metadata, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_get_iam_policy") as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = iam_policy_pb2.GetIamPolicyRequest() + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = json_format.MessageToJson(policy_pb2.Policy()) + req.return_value.content = return_value + + request = iam_policy_pb2.GetIamPolicyRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = policy_pb2.Policy() + post_with_metadata.return_value = policy_pb2.Policy(), metadata + + client.get_iam_policy(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_set_iam_policy_rest_bad_request(request_type=iam_policy_pb2.SetIamPolicyRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {'resource': 'projects/sample1/locations/sample2/reservations/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 = mock.Mock() + json_return_value = '' + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.set_iam_policy(request) + + +@pytest.mark.parametrize("request_type", [ + iam_policy_pb2.SetIamPolicyRequest, + dict, +]) +def test_set_iam_policy_rest_call_success(request_type): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {'resource': 'projects/sample1/locations/sample2/reservations/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 = policy_pb2.Policy( + version=774, + etag=b'etag_blob', + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + 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 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.set_iam_policy(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, policy_pb2.Policy) + assert response.version == 774 + assert response.etag == b'etag_blob' + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_set_iam_policy_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), + ) + client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_set_iam_policy") as post, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "post_set_iam_policy_with_metadata") as post_with_metadata, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_set_iam_policy") as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = iam_policy_pb2.SetIamPolicyRequest() + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = json_format.MessageToJson(policy_pb2.Policy()) + req.return_value.content = return_value + + request = iam_policy_pb2.SetIamPolicyRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = policy_pb2.Policy() + post_with_metadata.return_value = policy_pb2.Policy(), metadata + + client.set_iam_policy(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_test_iam_permissions_rest_bad_request(request_type=iam_policy_pb2.TestIamPermissionsRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {'resource': 'projects/sample1/locations/sample2/reservations/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 = mock.Mock() + json_return_value = '' + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.test_iam_permissions(request) + + +@pytest.mark.parametrize("request_type", [ + iam_policy_pb2.TestIamPermissionsRequest, + dict, +]) +def test_test_iam_permissions_rest_call_success(request_type): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {'resource': 'projects/sample1/locations/sample2/reservations/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 = iam_policy_pb2.TestIamPermissionsResponse( + permissions=['permissions_value'], + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + 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 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.test_iam_permissions(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, iam_policy_pb2.TestIamPermissionsResponse) + assert response.permissions == ['permissions_value'] + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_test_iam_permissions_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), + ) + client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_test_iam_permissions") as post, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "post_test_iam_permissions_with_metadata") as post_with_metadata, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_test_iam_permissions") as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = iam_policy_pb2.TestIamPermissionsRequest() + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = json_format.MessageToJson(iam_policy_pb2.TestIamPermissionsResponse()) + req.return_value.content = return_value + + request = iam_policy_pb2.TestIamPermissionsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = iam_policy_pb2.TestIamPermissionsResponse() + post_with_metadata.return_value = iam_policy_pb2.TestIamPermissionsResponse(), metadata + + client.test_iam_permissions(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_create_reservation_group_rest_bad_request(request_type=reservation.CreateReservationGroupRequest): + client = ReservationServiceClient( + 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 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 = mock.Mock() + json_return_value = '' + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.create_reservation_group(request) + + +@pytest.mark.parametrize("request_type", [ + reservation.CreateReservationGroupRequest, + dict, +]) +def test_create_reservation_group_rest_call_success(request_type): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'projects/sample1/locations/sample2'} + request_init["reservation_group"] = {'name': 'name_value'} + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = reservation.CreateReservationGroupRequest.meta.fields["reservation_group"] + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["reservation_group"].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + {"field": field, "subfield": subfield, "is_repeated": is_repeated} + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["reservation_group"][field])): + del request_init["reservation_group"][field][i][subfield] + else: + del request_init["reservation_group"][field][subfield] + 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 = reservation.ReservationGroup( + name='name_value', + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = reservation.ReservationGroup.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.create_reservation_group(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.ReservationGroup) + assert response.name == 'name_value' + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_reservation_group_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), + ) + client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_create_reservation_group") as post, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "post_create_reservation_group_with_metadata") as post_with_metadata, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_create_reservation_group") as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = reservation.CreateReservationGroupRequest.pb(reservation.CreateReservationGroupRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = reservation.ReservationGroup.to_json(reservation.ReservationGroup()) + req.return_value.content = return_value + + request = reservation.CreateReservationGroupRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = reservation.ReservationGroup() + post_with_metadata.return_value = reservation.ReservationGroup(), metadata + + client.create_reservation_group(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_get_reservation_group_rest_bad_request(request_type=reservation.GetReservationGroupRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/reservationGroups/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 = mock.Mock() + json_return_value = '' + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.get_reservation_group(request) + + +@pytest.mark.parametrize("request_type", [ + reservation.GetReservationGroupRequest, + dict, +]) +def test_get_reservation_group_rest_call_success(request_type): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/reservationGroups/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 = reservation.ReservationGroup( + name='name_value', + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = reservation.ReservationGroup.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.get_reservation_group(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.ReservationGroup) + assert response.name == 'name_value' + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_reservation_group_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), + ) + client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_get_reservation_group") as post, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "post_get_reservation_group_with_metadata") as post_with_metadata, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_get_reservation_group") as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = reservation.GetReservationGroupRequest.pb(reservation.GetReservationGroupRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = reservation.ReservationGroup.to_json(reservation.ReservationGroup()) + req.return_value.content = return_value + + request = reservation.GetReservationGroupRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = reservation.ReservationGroup() + post_with_metadata.return_value = reservation.ReservationGroup(), metadata + + client.get_reservation_group(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_delete_reservation_group_rest_bad_request(request_type=reservation.DeleteReservationGroupRequest): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/reservationGroups/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 = mock.Mock() + json_return_value = '' + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.delete_reservation_group(request) + + +@pytest.mark.parametrize("request_type", [ + reservation.DeleteReservationGroupRequest, + dict, +]) +def test_delete_reservation_group_rest_call_success(request_type): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'projects/sample1/locations/sample2/reservationGroups/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 = mock.Mock() + response_value.status_code = 200 + json_return_value = '' + response_value.content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.delete_reservation_group(request) + + # Establish that the response is the type that we expect. + assert response is None + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_reservation_group_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), + ) + client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "pre_delete_reservation_group") as pre: + pre.assert_not_called() + pb_message = reservation.DeleteReservationGroupRequest.pb(reservation.DeleteReservationGroupRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + request = reservation.DeleteReservationGroupRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_reservation_group(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + + +def test_list_reservation_groups_rest_bad_request(request_type=reservation.ListReservationGroupsRequest): + client = ReservationServiceClient( + 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 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 = mock.Mock() + json_return_value = '' + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.list_reservation_groups(request) + + +@pytest.mark.parametrize("request_type", [ + reservation.ListReservationGroupsRequest, + dict, +]) +def test_list_reservation_groups_rest_call_success(request_type): + client = ReservationServiceClient( + 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 = reservation.ListReservationGroupsResponse( + next_page_token='next_page_token_value', + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = reservation.ListReservationGroupsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.list_reservation_groups(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListReservationGroupsPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_reservation_groups_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), + ) + client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_list_reservation_groups") as post, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "post_list_reservation_groups_with_metadata") as post_with_metadata, \ + mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_list_reservation_groups") as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = reservation.ListReservationGroupsRequest.pb(reservation.ListReservationGroupsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = reservation.ListReservationGroupsResponse.to_json(reservation.ListReservationGroupsResponse()) + req.return_value.content = return_value + + request = reservation.ListReservationGroupsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = reservation.ListReservationGroupsResponse() + post_with_metadata.return_value = reservation.ListReservationGroupsResponse(), metadata + + client.list_reservation_groups(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + +def test_initialize_client_w_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + assert client is not None + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_create_reservation_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.create_reservation), + '__call__') as call: + client.create_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = gcbr_reservation.CreateReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_list_reservations_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_reservations), + '__call__') as call: + client.list_reservations(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.ListReservationsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_get_reservation_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_reservation), + '__call__') as call: + client.get_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.GetReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_delete_reservation_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.delete_reservation), + '__call__') as call: + client.delete_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.DeleteReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_update_reservation_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.update_reservation), + '__call__') as call: + client.update_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = gcbr_reservation.UpdateReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_failover_reservation_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.failover_reservation), + '__call__') as call: + client.failover_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.FailoverReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_create_capacity_commitment_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.create_capacity_commitment), + '__call__') as call: + client.create_capacity_commitment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.CreateCapacityCommitmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_list_capacity_commitments_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_capacity_commitments), + '__call__') as call: + client.list_capacity_commitments(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.ListCapacityCommitmentsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_get_capacity_commitment_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_capacity_commitment), + '__call__') as call: + client.get_capacity_commitment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.GetCapacityCommitmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_delete_capacity_commitment_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.delete_capacity_commitment), + '__call__') as call: + client.delete_capacity_commitment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.DeleteCapacityCommitmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_update_capacity_commitment_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.update_capacity_commitment), + '__call__') as call: + client.update_capacity_commitment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.UpdateCapacityCommitmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_split_capacity_commitment_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.split_capacity_commitment), + '__call__') as call: + client.split_capacity_commitment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.SplitCapacityCommitmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_merge_capacity_commitments_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.merge_capacity_commitments), + '__call__') as call: + client.merge_capacity_commitments(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.MergeCapacityCommitmentsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_create_assignment_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.create_assignment), + '__call__') as call: + client.create_assignment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.CreateAssignmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_list_assignments_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_assignments), + '__call__') as call: + client.list_assignments(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.ListAssignmentsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_delete_assignment_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.delete_assignment), + '__call__') as call: + client.delete_assignment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.DeleteAssignmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_search_assignments_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.search_assignments), + '__call__') as call: + client.search_assignments(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.SearchAssignmentsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_search_all_assignments_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.search_all_assignments), + '__call__') as call: + client.search_all_assignments(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.SearchAllAssignmentsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_move_assignment_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.move_assignment), + '__call__') as call: + client.move_assignment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.MoveAssignmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_update_assignment_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.update_assignment), + '__call__') as call: + client.update_assignment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.UpdateAssignmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_get_bi_reservation_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_bi_reservation), + '__call__') as call: + client.get_bi_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.GetBiReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_update_bi_reservation_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.update_bi_reservation), + '__call__') as call: + client.update_bi_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.UpdateBiReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_get_iam_policy_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_iam_policy), + '__call__') as call: + client.get_iam_policy(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = iam_policy_pb2.GetIamPolicyRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_set_iam_policy_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.set_iam_policy), + '__call__') as call: + client.set_iam_policy(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = iam_policy_pb2.SetIamPolicyRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_test_iam_permissions_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.test_iam_permissions), + '__call__') as call: + client.test_iam_permissions(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = iam_policy_pb2.TestIamPermissionsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_create_reservation_group_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.create_reservation_group), + '__call__') as call: + client.create_reservation_group(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.CreateReservationGroupRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_get_reservation_group_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_reservation_group), + '__call__') as call: + client.get_reservation_group(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.GetReservationGroupRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_delete_reservation_group_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.delete_reservation_group), + '__call__') as call: + client.delete_reservation_group(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.DeleteReservationGroupRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_list_reservation_groups_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_reservation_groups), + '__call__') as call: + client.list_reservation_groups(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.ListReservationGroupsRequest() + + assert args[0] == request_msg + + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.ReservationServiceGrpcTransport, + ) + +def test_reservation_service_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.ReservationServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json" + ) + + +def test_reservation_service_base_transport(): + # Instantiate the base transport. + with mock.patch('google.cloud.bigquery_reservation_v1.services.reservation_service.transports.ReservationServiceTransport.__init__') as Transport: + Transport.return_value = None + transport = transports.ReservationServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + 'create_reservation', + 'list_reservations', + 'get_reservation', + 'delete_reservation', + 'update_reservation', + 'failover_reservation', + 'create_capacity_commitment', + 'list_capacity_commitments', + 'get_capacity_commitment', + 'delete_capacity_commitment', + 'update_capacity_commitment', + 'split_capacity_commitment', + 'merge_capacity_commitments', + 'create_assignment', + 'list_assignments', + 'delete_assignment', + 'search_assignments', + 'search_all_assignments', + 'move_assignment', + 'update_assignment', + 'get_bi_reservation', + 'update_bi_reservation', + 'get_iam_policy', + 'set_iam_policy', + 'test_iam_permissions', + 'create_reservation_group', + 'get_reservation_group', + 'delete_reservation_group', + 'list_reservation_groups', + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + with pytest.raises(NotImplementedError): + transport.close() + + # Catch all for all remaining methods and properties + remainder = [ + 'kind', + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +def test_reservation_service_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.bigquery_reservation_v1.services.reservation_service.transports.ReservationServiceTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.ReservationServiceTransport( + 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/bigquery', + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id="octopus", + ) + + +def test_reservation_service_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.bigquery_reservation_v1.services.reservation_service.transports.ReservationServiceTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.ReservationServiceTransport() + adc.assert_called_once() + + +def test_reservation_service_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) + ReservationServiceClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/bigquery', + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.ReservationServiceGrpcTransport, + transports.ReservationServiceGrpcAsyncIOTransport, + ], +) +def test_reservation_service_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/bigquery', 'https://www.googleapis.com/auth/cloud-platform',), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.ReservationServiceGrpcTransport, + transports.ReservationServiceGrpcAsyncIOTransport, + transports.ReservationServiceRestTransport, + ], +) +def test_reservation_service_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.ReservationServiceGrpcTransport, grpc_helpers), + (transports.ReservationServiceGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +def test_reservation_service_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( + "bigqueryreservation.googleapis.com:443", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + default_scopes=( + 'https://www.googleapis.com/auth/bigquery', + 'https://www.googleapis.com/auth/cloud-platform', +), + scopes=["1", "2"], + default_host="bigqueryreservation.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("transport_class", [transports.ReservationServiceGrpcTransport, transports.ReservationServiceGrpcAsyncIOTransport]) +def test_reservation_service_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_reservation_service_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.ReservationServiceRestTransport ( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_reservation_service_host_no_port(transport_name): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='bigqueryreservation.googleapis.com'), + transport=transport_name, + ) + assert client.transport._host == ( + 'bigqueryreservation.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://bigqueryreservation.googleapis.com' + ) + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_reservation_service_host_with_port(transport_name): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='bigqueryreservation.googleapis.com:8000'), + transport=transport_name, + ) + assert client.transport._host == ( + 'bigqueryreservation.googleapis.com:8000' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://bigqueryreservation.googleapis.com:8000' + ) + +@pytest.mark.parametrize("transport_name", [ + "rest", +]) +def test_reservation_service_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = ReservationServiceClient( + credentials=creds1, + transport=transport_name, + ) + client2 = ReservationServiceClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.create_reservation._session + session2 = client2.transport.create_reservation._session + assert session1 != session2 + session1 = client1.transport.list_reservations._session + session2 = client2.transport.list_reservations._session + assert session1 != session2 + session1 = client1.transport.get_reservation._session + session2 = client2.transport.get_reservation._session + assert session1 != session2 + session1 = client1.transport.delete_reservation._session + session2 = client2.transport.delete_reservation._session + assert session1 != session2 + session1 = client1.transport.update_reservation._session + session2 = client2.transport.update_reservation._session + assert session1 != session2 + session1 = client1.transport.failover_reservation._session + session2 = client2.transport.failover_reservation._session + assert session1 != session2 + session1 = client1.transport.create_capacity_commitment._session + session2 = client2.transport.create_capacity_commitment._session + assert session1 != session2 + session1 = client1.transport.list_capacity_commitments._session + session2 = client2.transport.list_capacity_commitments._session + assert session1 != session2 + session1 = client1.transport.get_capacity_commitment._session + session2 = client2.transport.get_capacity_commitment._session + assert session1 != session2 + session1 = client1.transport.delete_capacity_commitment._session + session2 = client2.transport.delete_capacity_commitment._session + assert session1 != session2 + session1 = client1.transport.update_capacity_commitment._session + session2 = client2.transport.update_capacity_commitment._session + assert session1 != session2 + session1 = client1.transport.split_capacity_commitment._session + session2 = client2.transport.split_capacity_commitment._session + assert session1 != session2 + session1 = client1.transport.merge_capacity_commitments._session + session2 = client2.transport.merge_capacity_commitments._session + assert session1 != session2 + session1 = client1.transport.create_assignment._session + session2 = client2.transport.create_assignment._session + assert session1 != session2 + session1 = client1.transport.list_assignments._session + session2 = client2.transport.list_assignments._session + assert session1 != session2 + session1 = client1.transport.delete_assignment._session + session2 = client2.transport.delete_assignment._session + assert session1 != session2 + session1 = client1.transport.search_assignments._session + session2 = client2.transport.search_assignments._session + assert session1 != session2 + session1 = client1.transport.search_all_assignments._session + session2 = client2.transport.search_all_assignments._session + assert session1 != session2 + session1 = client1.transport.move_assignment._session + session2 = client2.transport.move_assignment._session + assert session1 != session2 + session1 = client1.transport.update_assignment._session + session2 = client2.transport.update_assignment._session + assert session1 != session2 + session1 = client1.transport.get_bi_reservation._session + session2 = client2.transport.get_bi_reservation._session + assert session1 != session2 + session1 = client1.transport.update_bi_reservation._session + session2 = client2.transport.update_bi_reservation._session + assert session1 != session2 + session1 = client1.transport.get_iam_policy._session + session2 = client2.transport.get_iam_policy._session + assert session1 != session2 + session1 = client1.transport.set_iam_policy._session + session2 = client2.transport.set_iam_policy._session + assert session1 != session2 + session1 = client1.transport.test_iam_permissions._session + session2 = client2.transport.test_iam_permissions._session + assert session1 != session2 + session1 = client1.transport.create_reservation_group._session + session2 = client2.transport.create_reservation_group._session + assert session1 != session2 + session1 = client1.transport.get_reservation_group._session + session2 = client2.transport.get_reservation_group._session + assert session1 != session2 + session1 = client1.transport.delete_reservation_group._session + session2 = client2.transport.delete_reservation_group._session + assert session1 != session2 + session1 = client1.transport.list_reservation_groups._session + session2 = client2.transport.list_reservation_groups._session + assert session1 != session2 +def test_reservation_service_grpc_transport_channel(): + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.ReservationServiceGrpcTransport( + 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_reservation_service_grpc_asyncio_transport_channel(): + channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.ReservationServiceGrpcAsyncIOTransport( + 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.ReservationServiceGrpcTransport, transports.ReservationServiceGrpcAsyncIOTransport]) +def test_reservation_service_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.ReservationServiceGrpcTransport, transports.ReservationServiceGrpcAsyncIOTransport]) +def test_reservation_service_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_assignment_path(): + project = "squid" + location = "clam" + reservation = "whelk" + assignment = "octopus" + expected = "projects/{project}/locations/{location}/reservations/{reservation}/assignments/{assignment}".format(project=project, location=location, reservation=reservation, assignment=assignment, ) + actual = ReservationServiceClient.assignment_path(project, location, reservation, assignment) + assert expected == actual + + +def test_parse_assignment_path(): + expected = { + "project": "oyster", + "location": "nudibranch", + "reservation": "cuttlefish", + "assignment": "mussel", + } + path = ReservationServiceClient.assignment_path(**expected) + + # Check that the path construction is reversible. + actual = ReservationServiceClient.parse_assignment_path(path) + assert expected == actual + +def test_bi_reservation_path(): + project = "winkle" + location = "nautilus" + expected = "projects/{project}/locations/{location}/biReservation".format(project=project, location=location, ) + actual = ReservationServiceClient.bi_reservation_path(project, location) + assert expected == actual + + +def test_parse_bi_reservation_path(): + expected = { + "project": "scallop", + "location": "abalone", + } + path = ReservationServiceClient.bi_reservation_path(**expected) + + # Check that the path construction is reversible. + actual = ReservationServiceClient.parse_bi_reservation_path(path) + assert expected == actual + +def test_capacity_commitment_path(): + project = "squid" + location = "clam" + capacity_commitment = "whelk" + expected = "projects/{project}/locations/{location}/capacityCommitments/{capacity_commitment}".format(project=project, location=location, capacity_commitment=capacity_commitment, ) + actual = ReservationServiceClient.capacity_commitment_path(project, location, capacity_commitment) + assert expected == actual + + +def test_parse_capacity_commitment_path(): + expected = { + "project": "octopus", + "location": "oyster", + "capacity_commitment": "nudibranch", + } + path = ReservationServiceClient.capacity_commitment_path(**expected) + + # Check that the path construction is reversible. + actual = ReservationServiceClient.parse_capacity_commitment_path(path) + assert expected == actual + +def test_reservation_path(): + project = "cuttlefish" + location = "mussel" + reservation = "winkle" + expected = "projects/{project}/locations/{location}/reservations/{reservation}".format(project=project, location=location, reservation=reservation, ) + actual = ReservationServiceClient.reservation_path(project, location, reservation) + assert expected == actual + + +def test_parse_reservation_path(): + expected = { + "project": "nautilus", + "location": "scallop", + "reservation": "abalone", + } + path = ReservationServiceClient.reservation_path(**expected) + + # Check that the path construction is reversible. + actual = ReservationServiceClient.parse_reservation_path(path) + assert expected == actual + +def test_reservation_group_path(): + project = "squid" + location = "clam" + reservation_group = "whelk" + expected = "projects/{project}/locations/{location}/reservationGroups/{reservation_group}".format(project=project, location=location, reservation_group=reservation_group, ) + actual = ReservationServiceClient.reservation_group_path(project, location, reservation_group) + assert expected == actual + + +def test_parse_reservation_group_path(): + expected = { + "project": "octopus", + "location": "oyster", + "reservation_group": "nudibranch", + } + path = ReservationServiceClient.reservation_group_path(**expected) + + # Check that the path construction is reversible. + actual = ReservationServiceClient.parse_reservation_group_path(path) + assert expected == actual + +def test_common_billing_account_path(): + billing_account = "cuttlefish" + expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + actual = ReservationServiceClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "mussel", + } + path = ReservationServiceClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = ReservationServiceClient.parse_common_billing_account_path(path) + assert expected == actual + +def test_common_folder_path(): + folder = "winkle" + expected = "folders/{folder}".format(folder=folder, ) + actual = ReservationServiceClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "nautilus", + } + path = ReservationServiceClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = ReservationServiceClient.parse_common_folder_path(path) + assert expected == actual + +def test_common_organization_path(): + organization = "scallop" + expected = "organizations/{organization}".format(organization=organization, ) + actual = ReservationServiceClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "abalone", + } + path = ReservationServiceClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = ReservationServiceClient.parse_common_organization_path(path) + assert expected == actual + +def test_common_project_path(): + project = "squid" + expected = "projects/{project}".format(project=project, ) + actual = ReservationServiceClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "clam", + } + path = ReservationServiceClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = ReservationServiceClient.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 = ReservationServiceClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "oyster", + "location": "nudibranch", + } + path = ReservationServiceClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = ReservationServiceClient.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.ReservationServiceTransport, '_prep_wrapped_messages') as prep: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object(transports.ReservationServiceTransport, '_prep_wrapped_messages') as prep: + transport_class = ReservationServiceClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + +def test_transport_close_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc" + ) + with mock.patch.object(type(getattr(client.transport, "_grpc_channel")), "close") as close: + with client: + close.assert_not_called() + close.assert_called_once() + + +@pytest.mark.asyncio +async def test_transport_close_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + 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_transport_close_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + with mock.patch.object(type(getattr(client.transport, "_session")), "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 = ReservationServiceClient( + 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", [ + (ReservationServiceClient, transports.ReservationServiceGrpcTransport), + (ReservationServiceAsyncClient, transports.ReservationServiceGrpcAsyncIOTransport), +]) +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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + 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, + ) From 46cf789c66ed151093710597bba7719ea1008747 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Fri, 3 Oct 2025 23:07:11 +0000 Subject: [PATCH 2/2] =?UTF-8?q?=F0=9F=A6=89=20Updates=20from=20OwlBot=20po?= =?UTF-8?q?st-processor?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --- .../v1/.coveragerc | 13 - .../v1/.flake8 | 34 - .../v1/LICENSE | 202 - .../v1/MANIFEST.in | 20 - .../v1/README.rst | 143 - .../v1/docs/_static/custom.css | 20 - .../v1/docs/_templates/layout.html | 50 - .../reservation_service.rst | 10 - .../bigquery_reservation_v1/services_.rst | 6 - .../docs/bigquery_reservation_v1/types_.rst | 6 - .../v1/docs/conf.py | 385 - .../v1/docs/index.rst | 10 - .../v1/docs/multiprocessing.rst | 7 - .../cloud/bigquery_reservation/__init__.py | 111 - .../bigquery_reservation/gapic_version.py | 16 - .../cloud/bigquery_reservation/py.typed | 2 - .../cloud/bigquery_reservation_v1/__init__.py | 112 - .../gapic_metadata.json | 463 - .../bigquery_reservation_v1/gapic_version.py | 16 - .../cloud/bigquery_reservation_v1/py.typed | 2 - .../services/__init__.py | 15 - .../services/reservation_service/__init__.py | 22 - .../reservation_service/async_client.py | 3824 --- .../services/reservation_service/client.py | 4203 --- .../services/reservation_service/pagers.py | 861 - .../reservation_service/transports/README.rst | 9 - .../transports/__init__.py | 38 - .../reservation_service/transports/base.py | 656 - .../reservation_service/transports/grpc.py | 1299 - .../transports/grpc_asyncio.py | 1560 -- .../reservation_service/transports/rest.py | 5221 ---- .../transports/rest_base.py | 1282 - .../bigquery_reservation_v1/types/__init__.py | 104 - .../types/reservation.py | 1937 -- .../v1/mypy.ini | 3 - .../v1/noxfile.py | 591 - ...rvation_service_create_assignment_async.py | 52 - ...ervation_service_create_assignment_sync.py | 52 - ...ervice_create_capacity_commitment_async.py | 52 - ...service_create_capacity_commitment_sync.py | 52 - ...vation_service_create_reservation_async.py | 52 - ...rvation_service_create_reservation_sync.py | 52 - ...rvation_service_delete_assignment_async.py | 50 - ...ervation_service_delete_assignment_sync.py | 50 - ...ervice_delete_capacity_commitment_async.py | 50 - ...service_delete_capacity_commitment_sync.py | 50 - ...vation_service_delete_reservation_async.py | 50 - ...rvation_service_delete_reservation_sync.py | 50 - ...tion_service_failover_reservation_async.py | 52 - ...ation_service_failover_reservation_sync.py | 52 - ...vation_service_get_bi_reservation_async.py | 52 - ...rvation_service_get_bi_reservation_sync.py | 52 - ...n_service_get_capacity_commitment_async.py | 52 - ...on_service_get_capacity_commitment_sync.py | 52 - ...servation_service_get_reservation_async.py | 52 - ...eservation_service_get_reservation_sync.py | 52 - ...ervation_service_list_assignments_async.py | 53 - ...servation_service_list_assignments_sync.py | 53 - ...service_list_capacity_commitments_async.py | 53 - ..._service_list_capacity_commitments_sync.py | 53 - ...rvation_service_list_reservations_async.py | 53 - ...ervation_service_list_reservations_sync.py | 53 - ...ervice_merge_capacity_commitments_async.py | 51 - ...service_merge_capacity_commitments_sync.py | 51 - ...servation_service_move_assignment_async.py | 52 - ...eservation_service_move_assignment_sync.py | 52 - ...on_service_search_all_assignments_async.py | 53 - ...ion_service_search_all_assignments_sync.py | 53 - ...vation_service_search_assignments_async.py | 53 - ...rvation_service_search_assignments_sync.py | 53 - ...service_split_capacity_commitment_async.py | 52 - ..._service_split_capacity_commitment_sync.py | 52 - ...rvation_service_update_assignment_async.py | 51 - ...ervation_service_update_assignment_sync.py | 51 - ...ion_service_update_bi_reservation_async.py | 51 - ...tion_service_update_bi_reservation_sync.py | 51 - ...ervice_update_capacity_commitment_async.py | 51 - ...service_update_capacity_commitment_sync.py | 51 - ...vation_service_update_reservation_async.py | 51 - ...rvation_service_update_reservation_sync.py | 51 - ..._google.cloud.bigquery.reservation.v1.json | 4740 ---- .../fixup_bigquery_reservation_v1_keywords.py | 204 - .../v1/setup.py | 99 - .../v1/testing/constraints-3.10.txt | 7 - .../v1/testing/constraints-3.11.txt | 7 - .../v1/testing/constraints-3.12.txt | 7 - .../v1/testing/constraints-3.13.txt | 12 - .../v1/testing/constraints-3.7.txt | 11 - .../v1/testing/constraints-3.8.txt | 7 - .../v1/testing/constraints-3.9.txt | 7 - .../v1/tests/__init__.py | 16 - .../v1/tests/unit/__init__.py | 16 - .../v1/tests/unit/gapic/__init__.py | 16 - .../gapic/bigquery_reservation_v1/__init__.py | 16 - .../test_reservation_service.py | 22667 ---------------- .../cloud/bigquery_reservation/__init__.py | 14 + .../bigquery_reservation/gapic_version.py | 2 +- .../cloud/bigquery_reservation_v1/__init__.py | 14 + .../gapic_metadata.json | 105 + .../bigquery_reservation_v1/gapic_version.py | 2 +- .../reservation_service/async_client.py | 838 + .../services/reservation_service/client.py | 844 + .../services/reservation_service/pagers.py | 156 + .../reservation_service/transports/base.py | 106 + .../reservation_service/transports/grpc.py | 232 + .../transports/grpc_asyncio.py | 271 + .../reservation_service/transports/rest.py | 2267 +- .../transports/rest_base.py | 377 + .../bigquery_reservation_v1/types/__init__.py | 14 + .../types/reservation.py | 398 +- ..._service_create_reservation_group_async.py | 0 ...n_service_create_reservation_group_sync.py | 0 ..._service_delete_reservation_group_async.py | 0 ...n_service_delete_reservation_group_sync.py | 0 ...eservation_service_get_iam_policy_async.py | 0 ...reservation_service_get_iam_policy_sync.py | 0 ...ion_service_get_reservation_group_async.py | 0 ...tion_service_get_reservation_group_sync.py | 0 ...n_service_list_reservation_groups_async.py | 0 ...on_service_list_reservation_groups_sync.py | 0 ...eservation_service_set_iam_policy_async.py | 0 ...reservation_service_set_iam_policy_sync.py | 0 ...tion_service_test_iam_permissions_async.py | 0 ...ation_service_test_iam_permissions_sync.py | 0 ..._google.cloud.bigquery.reservation.v1.json | 1311 +- .../fixup_bigquery_reservation_v1_keywords.py | 9 +- .../setup.py | 1 + .../testing/constraints-3.10.txt | 1 + .../testing/constraints-3.11.txt | 1 + .../testing/constraints-3.12.txt | 1 + .../testing/constraints-3.13.txt | 1 + .../testing/constraints-3.7.txt | 1 + .../testing/constraints-3.8.txt | 1 + .../testing/constraints-3.9.txt | 1 + .../test_reservation_service.py | 13053 ++++++--- 135 files changed, 15645 insertions(+), 57737 deletions(-) delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/.coveragerc delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/.flake8 delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/LICENSE delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/MANIFEST.in delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/README.rst delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/_static/custom.css delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/_templates/layout.html delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/bigquery_reservation_v1/reservation_service.rst delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/bigquery_reservation_v1/services_.rst delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/bigquery_reservation_v1/types_.rst delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/conf.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/index.rst delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/multiprocessing.rst delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation/__init__.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation/gapic_version.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation/py.typed delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/__init__.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/gapic_metadata.json delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/gapic_version.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/py.typed delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/__init__.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/__init__.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/async_client.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/client.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/pagers.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/README.rst delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/__init__.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/base.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc_asyncio.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/rest.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/rest_base.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/types/__init__.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/types/reservation.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/mypy.ini delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/noxfile.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_assignment_async.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_assignment_sync.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_capacity_commitment_async.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_capacity_commitment_sync.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_reservation_async.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_reservation_sync.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_assignment_async.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_assignment_sync.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_capacity_commitment_async.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_capacity_commitment_sync.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_reservation_async.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_reservation_sync.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_failover_reservation_async.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_failover_reservation_sync.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_bi_reservation_async.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_bi_reservation_sync.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_capacity_commitment_async.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_capacity_commitment_sync.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_reservation_async.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_reservation_sync.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_assignments_async.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_assignments_sync.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_capacity_commitments_async.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_capacity_commitments_sync.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_reservations_async.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_reservations_sync.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_merge_capacity_commitments_async.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_merge_capacity_commitments_sync.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_move_assignment_async.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_move_assignment_sync.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_search_all_assignments_async.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_search_all_assignments_sync.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_search_assignments_async.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_search_assignments_sync.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_split_capacity_commitment_async.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_split_capacity_commitment_sync.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_assignment_async.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_assignment_sync.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_bi_reservation_async.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_bi_reservation_sync.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_capacity_commitment_async.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_capacity_commitment_sync.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_reservation_async.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_reservation_sync.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/snippet_metadata_google.cloud.bigquery.reservation.v1.json delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/scripts/fixup_bigquery_reservation_v1_keywords.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/setup.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.10.txt delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.11.txt delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.12.txt delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.13.txt delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.7.txt delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.8.txt delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.9.txt delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/tests/__init__.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/tests/unit/__init__.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/tests/unit/gapic/__init__.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/tests/unit/gapic/bigquery_reservation_v1/__init__.py delete mode 100644 owl-bot-staging/google-cloud-bigquery-reservation/v1/tests/unit/gapic/bigquery_reservation_v1/test_reservation_service.py rename {owl-bot-staging/google-cloud-bigquery-reservation/v1 => packages/google-cloud-bigquery-reservation}/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_reservation_group_async.py (100%) rename {owl-bot-staging/google-cloud-bigquery-reservation/v1 => packages/google-cloud-bigquery-reservation}/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_reservation_group_sync.py (100%) rename {owl-bot-staging/google-cloud-bigquery-reservation/v1 => packages/google-cloud-bigquery-reservation}/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_reservation_group_async.py (100%) rename {owl-bot-staging/google-cloud-bigquery-reservation/v1 => packages/google-cloud-bigquery-reservation}/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_reservation_group_sync.py (100%) rename {owl-bot-staging/google-cloud-bigquery-reservation/v1 => packages/google-cloud-bigquery-reservation}/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_iam_policy_async.py (100%) rename {owl-bot-staging/google-cloud-bigquery-reservation/v1 => packages/google-cloud-bigquery-reservation}/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_iam_policy_sync.py (100%) rename {owl-bot-staging/google-cloud-bigquery-reservation/v1 => packages/google-cloud-bigquery-reservation}/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_reservation_group_async.py (100%) rename {owl-bot-staging/google-cloud-bigquery-reservation/v1 => packages/google-cloud-bigquery-reservation}/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_reservation_group_sync.py (100%) rename {owl-bot-staging/google-cloud-bigquery-reservation/v1 => packages/google-cloud-bigquery-reservation}/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_reservation_groups_async.py (100%) rename {owl-bot-staging/google-cloud-bigquery-reservation/v1 => packages/google-cloud-bigquery-reservation}/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_reservation_groups_sync.py (100%) rename {owl-bot-staging/google-cloud-bigquery-reservation/v1 => packages/google-cloud-bigquery-reservation}/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_set_iam_policy_async.py (100%) rename {owl-bot-staging/google-cloud-bigquery-reservation/v1 => packages/google-cloud-bigquery-reservation}/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_set_iam_policy_sync.py (100%) rename {owl-bot-staging/google-cloud-bigquery-reservation/v1 => packages/google-cloud-bigquery-reservation}/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_test_iam_permissions_async.py (100%) rename {owl-bot-staging/google-cloud-bigquery-reservation/v1 => packages/google-cloud-bigquery-reservation}/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_test_iam_permissions_sync.py (100%) diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/.coveragerc b/owl-bot-staging/google-cloud-bigquery-reservation/v1/.coveragerc deleted file mode 100644 index 24e124ab08de..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/.coveragerc +++ /dev/null @@ -1,13 +0,0 @@ -[run] -branch = True - -[report] -show_missing = True -omit = - google/cloud/bigquery_reservation/__init__.py - google/cloud/bigquery_reservation/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/google-cloud-bigquery-reservation/v1/.flake8 b/owl-bot-staging/google-cloud-bigquery-reservation/v1/.flake8 deleted file mode 100644 index 90316de21489..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/.flake8 +++ /dev/null @@ -1,34 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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. -# -[flake8] -# TODO(https://github.com/googleapis/gapic-generator-python/issues/2333): -# Resolve flake8 lint issues -ignore = E203, E231, E266, E501, W503 -exclude = - # TODO(https://github.com/googleapis/gapic-generator-python/issues/2333): - # Ensure that generated code passes flake8 lint - **/gapic/** - **/services/** - **/types/** - # Exclude Protobuf gencode - *_pb2.py - - # Standard linting exemptions. - **/.nox/** - __pycache__, - .git, - *.pyc, - conf.py diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/LICENSE b/owl-bot-staging/google-cloud-bigquery-reservation/v1/LICENSE deleted file mode 100644 index d64569567334..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/LICENSE +++ /dev/null @@ -1,202 +0,0 @@ - - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - 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/google-cloud-bigquery-reservation/v1/MANIFEST.in b/owl-bot-staging/google-cloud-bigquery-reservation/v1/MANIFEST.in deleted file mode 100644 index dae249ec8976..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/MANIFEST.in +++ /dev/null @@ -1,20 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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. -# -include README.rst LICENSE -recursive-include google *.py *.pyi *.json *.proto py.typed -recursive-include tests * -global-exclude *.py[co] -global-exclude __pycache__ diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/README.rst b/owl-bot-staging/google-cloud-bigquery-reservation/v1/README.rst deleted file mode 100644 index 1cfbfbc32063..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/README.rst +++ /dev/null @@ -1,143 +0,0 @@ -Python Client for Google Cloud Bigquery Reservation 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 Bigquery Reservation 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 - - -Logging -------- - -This library uses the standard Python :code:`logging` functionality to log some RPC events that could be of interest for debugging and monitoring purposes. -Note the following: - -#. Logs may contain sensitive information. Take care to **restrict access to the logs** if they are saved, whether it be on local storage or on Google Cloud Logging. -#. Google may refine the occurrence, level, and content of various log messages in this library without flagging such changes as breaking. **Do not depend on immutability of the logging events**. -#. By default, the logging events from this library are not handled. You must **explicitly configure log handling** using one of the mechanisms below. - - -Simple, environment-based configuration -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To enable logging for this library without any changes in your code, set the :code:`GOOGLE_SDK_PYTHON_LOGGING_SCOPE` environment variable to a valid Google -logging scope. This configures handling of logging events (at level :code:`logging.DEBUG` or higher) from this library in a default manner, emitting the logged -messages in a structured format. It does not currently allow customizing the logging levels captured nor the handlers, formatters, etc. used for any logging -event. - -A logging scope is a period-separated namespace that begins with :code:`google`, identifying the Python module or package to log. - -- Valid logging scopes: :code:`google`, :code:`google.cloud.asset.v1`, :code:`google.api`, :code:`google.auth`, etc. -- Invalid logging scopes: :code:`foo`, :code:`123`, etc. - -**NOTE**: If the logging scope is invalid, the library does not set up any logging handlers. - - -Examples -^^^^^^^^ - -- Enabling the default handler for all Google-based loggers - -.. code-block:: console - - export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google - -- Enabling the default handler for a specific Google module (for a client library called :code:`library_v1`): - -.. code-block:: console - - export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google.cloud.library_v1 - - -Advanced, code-based configuration -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You can also configure a valid logging scope using Python's standard `logging` mechanism. - - -Examples -^^^^^^^^ - -- Configuring a handler for all Google-based loggers - -.. code-block:: python - - import logging - - from google.cloud.translate_v3 import translate - - base_logger = logging.getLogger("google") - base_logger.addHandler(logging.StreamHandler()) - base_logger.setLevel(logging.DEBUG) - -- Configuring a handler for a specific Google module (for a client library called :code:`library_v1`): - -.. code-block:: python - - import logging - - from google.cloud.translate_v3 import translate - - base_logger = logging.getLogger("google.cloud.library_v1") - base_logger.addHandler(logging.StreamHandler()) - base_logger.setLevel(logging.DEBUG) - - -Logging details -~~~~~~~~~~~~~~~ - -#. Regardless of which of the mechanisms above you use to configure logging for this library, by default logging events are not propagated up to the root - logger from the `google`-level logger. If you need the events to be propagated to the root logger, you must explicitly set - :code:`logging.getLogger("google").propagate = True` in your code. -#. You can mix the different logging configurations above for different Google modules. For example, you may want use a code-based logging configuration for - one library, but decide you need to also set up environment-based logging configuration for another library. - - #. If you attempt to use both code-based and environment-based configuration for the same module, the environment-based configuration will be ineffectual - if the code -based configuration gets applied first. - -#. The Google-specific logging configurations (default handlers for environment-based configuration; not propagating logging events to the root logger) get - executed the first time *any* client library is instantiated in your application, and only if the affected loggers have not been previously configured. - (This is the reason for 2.i. above.) diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/_static/custom.css b/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/_static/custom.css deleted file mode 100644 index b0a295464b23..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/_static/custom.css +++ /dev/null @@ -1,20 +0,0 @@ -div#python2-eol { - border-color: red; - border-width: medium; -} - -/* Ensure minimum width for 'Parameters' / 'Returns' column */ -dl.field-list > dt { - min-width: 100px -} - -/* Insert space between methods for readability */ -dl.method { - padding-top: 10px; - padding-bottom: 10px -} - -/* Insert empty space between classes */ -dl.class { - padding-bottom: 50px -} diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/_templates/layout.html b/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/_templates/layout.html deleted file mode 100644 index 95e9c77fcfe1..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/_templates/layout.html +++ /dev/null @@ -1,50 +0,0 @@ - -{% extends "!layout.html" %} -{%- block content %} -{%- if theme_fixed_sidebar|lower == 'true' %} -
- {{ sidebar() }} - {%- block document %} -
- {%- if render_sidebar %} -
- {%- endif %} - - {%- block relbar_top %} - {%- if theme_show_relbar_top|tobool %} -
-   - {{- rellink_markup () }} -
- {%- endif %} - {% endblock %} - -
-
- As of January 1, 2020 this library no longer supports Python 2 on the latest released version. - Library versions released prior to that date will continue to be available. For more information please - visit Python 2 support on Google Cloud. -
- {% block body %} {% endblock %} -
- - {%- block relbar_bottom %} - {%- if theme_show_relbar_bottom|tobool %} -
-   - {{- rellink_markup () }} -
- {%- endif %} - {% endblock %} - - {%- if render_sidebar %} -
- {%- endif %} -
- {%- endblock %} -
-
-{%- else %} -{{ super() }} -{%- endif %} -{%- endblock %} diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/bigquery_reservation_v1/reservation_service.rst b/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/bigquery_reservation_v1/reservation_service.rst deleted file mode 100644 index 35e6b3cfd676..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/bigquery_reservation_v1/reservation_service.rst +++ /dev/null @@ -1,10 +0,0 @@ -ReservationService ------------------------------------- - -.. automodule:: google.cloud.bigquery_reservation_v1.services.reservation_service - :members: - :inherited-members: - -.. automodule:: google.cloud.bigquery_reservation_v1.services.reservation_service.pagers - :members: - :inherited-members: diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/bigquery_reservation_v1/services_.rst b/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/bigquery_reservation_v1/services_.rst deleted file mode 100644 index 3f9e9577f53c..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/bigquery_reservation_v1/services_.rst +++ /dev/null @@ -1,6 +0,0 @@ -Services for Google Cloud Bigquery Reservation v1 API -===================================================== -.. toctree:: - :maxdepth: 2 - - reservation_service diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/bigquery_reservation_v1/types_.rst b/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/bigquery_reservation_v1/types_.rst deleted file mode 100644 index 96a1583d3f20..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/bigquery_reservation_v1/types_.rst +++ /dev/null @@ -1,6 +0,0 @@ -Types for Google Cloud Bigquery Reservation v1 API -================================================== - -.. automodule:: google.cloud.bigquery_reservation_v1.types - :members: - :show-inheritance: diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/conf.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/conf.py deleted file mode 100644 index 06008b76447b..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/conf.py +++ /dev/null @@ -1,385 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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-bigquery-reservation 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("..")) - -# For plugins that can not read conf.py. -# See also: https://github.com/docascode/sphinx-docfx-yaml/issues/85 -sys.path.insert(0, os.path.abspath(".")) - -__version__ = "" - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -needs_sphinx = "4.5.0" - -# 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.doctest", - "sphinx.ext.napoleon", - "sphinx.ext.todo", - "sphinx.ext.viewcode", - "recommonmark", -] - -# autodoc/autosummary flags -autoclass_content = "both" -autodoc_default_options = {"members": True} -autosummary_generate = True - - -# Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# source_suffix = ['.rst', '.md'] -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-bigquery-reservation" -copyright = u"2025, Google, LLC" -author = u"Google APIs" - -# 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", - "**/.nox/**/*", - "samples/AUTHORING_GUIDE.md", - "samples/CONTRIBUTING.md", - "samples/snippets/README.rst", -] - -# 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 google-cloud-bigquery-reservation", - "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-bigquery-reservation-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-bigquery-reservation.tex", - u"google-cloud-bigquery-reservation 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-bigquery-reservation", - "google-cloud-bigquery-reservation 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-bigquery-reservation", - "google-cloud-bigquery-reservation Documentation", - author, - "google-cloud-bigquery-reservation", - "google-cloud-bigquery-reservation Library", - "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": ("https://python.readthedocs.org/en/latest/", None), - "google-auth": ("https://googleapis.dev/python/google-auth/latest/", None), - "google.api_core": ( - "https://googleapis.dev/python/google-api-core/latest/", - None, - ), - "grpc": ("https://grpc.github.io/grpc/python/", None), - "proto-plus": ("https://proto-plus-python.readthedocs.io/en/latest/", 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/google-cloud-bigquery-reservation/v1/docs/index.rst b/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/index.rst deleted file mode 100644 index 848c6ec2f825..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. include:: multiprocessing.rst - - -API Reference -------------- -.. toctree:: - :maxdepth: 2 - - bigquery_reservation_v1/services_ - bigquery_reservation_v1/types_ diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/multiprocessing.rst b/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/multiprocessing.rst deleted file mode 100644 index 536d17b2ea65..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/docs/multiprocessing.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. note:: - - Because this client uses :mod:`grpc` library, it is safe to - share instances across threads. In multiprocessing scenarios, the best - practice is to create client instances *after* the invocation of - :func:`os.fork` by :class:`multiprocessing.pool.Pool` or - :class:`multiprocessing.Process`. diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation/__init__.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation/__init__.py deleted file mode 100644 index 04af02e9ea29..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation/__init__.py +++ /dev/null @@ -1,111 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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.bigquery_reservation import gapic_version as package_version - -__version__ = package_version.__version__ - - -from google.cloud.bigquery_reservation_v1.services.reservation_service.client import ReservationServiceClient -from google.cloud.bigquery_reservation_v1.services.reservation_service.async_client import ReservationServiceAsyncClient - -from google.cloud.bigquery_reservation_v1.types.reservation import Assignment -from google.cloud.bigquery_reservation_v1.types.reservation import BiReservation -from google.cloud.bigquery_reservation_v1.types.reservation import CapacityCommitment -from google.cloud.bigquery_reservation_v1.types.reservation import CreateAssignmentRequest -from google.cloud.bigquery_reservation_v1.types.reservation import CreateCapacityCommitmentRequest -from google.cloud.bigquery_reservation_v1.types.reservation import CreateReservationGroupRequest -from google.cloud.bigquery_reservation_v1.types.reservation import CreateReservationRequest -from google.cloud.bigquery_reservation_v1.types.reservation import DeleteAssignmentRequest -from google.cloud.bigquery_reservation_v1.types.reservation import DeleteCapacityCommitmentRequest -from google.cloud.bigquery_reservation_v1.types.reservation import DeleteReservationGroupRequest -from google.cloud.bigquery_reservation_v1.types.reservation import DeleteReservationRequest -from google.cloud.bigquery_reservation_v1.types.reservation import FailoverReservationRequest -from google.cloud.bigquery_reservation_v1.types.reservation import GetBiReservationRequest -from google.cloud.bigquery_reservation_v1.types.reservation import GetCapacityCommitmentRequest -from google.cloud.bigquery_reservation_v1.types.reservation import GetReservationGroupRequest -from google.cloud.bigquery_reservation_v1.types.reservation import GetReservationRequest -from google.cloud.bigquery_reservation_v1.types.reservation import ListAssignmentsRequest -from google.cloud.bigquery_reservation_v1.types.reservation import ListAssignmentsResponse -from google.cloud.bigquery_reservation_v1.types.reservation import ListCapacityCommitmentsRequest -from google.cloud.bigquery_reservation_v1.types.reservation import ListCapacityCommitmentsResponse -from google.cloud.bigquery_reservation_v1.types.reservation import ListReservationGroupsRequest -from google.cloud.bigquery_reservation_v1.types.reservation import ListReservationGroupsResponse -from google.cloud.bigquery_reservation_v1.types.reservation import ListReservationsRequest -from google.cloud.bigquery_reservation_v1.types.reservation import ListReservationsResponse -from google.cloud.bigquery_reservation_v1.types.reservation import MergeCapacityCommitmentsRequest -from google.cloud.bigquery_reservation_v1.types.reservation import MoveAssignmentRequest -from google.cloud.bigquery_reservation_v1.types.reservation import Reservation -from google.cloud.bigquery_reservation_v1.types.reservation import ReservationGroup -from google.cloud.bigquery_reservation_v1.types.reservation import SchedulingPolicy -from google.cloud.bigquery_reservation_v1.types.reservation import SearchAllAssignmentsRequest -from google.cloud.bigquery_reservation_v1.types.reservation import SearchAllAssignmentsResponse -from google.cloud.bigquery_reservation_v1.types.reservation import SearchAssignmentsRequest -from google.cloud.bigquery_reservation_v1.types.reservation import SearchAssignmentsResponse -from google.cloud.bigquery_reservation_v1.types.reservation import SplitCapacityCommitmentRequest -from google.cloud.bigquery_reservation_v1.types.reservation import SplitCapacityCommitmentResponse -from google.cloud.bigquery_reservation_v1.types.reservation import TableReference -from google.cloud.bigquery_reservation_v1.types.reservation import UpdateAssignmentRequest -from google.cloud.bigquery_reservation_v1.types.reservation import UpdateBiReservationRequest -from google.cloud.bigquery_reservation_v1.types.reservation import UpdateCapacityCommitmentRequest -from google.cloud.bigquery_reservation_v1.types.reservation import UpdateReservationRequest -from google.cloud.bigquery_reservation_v1.types.reservation import Edition -from google.cloud.bigquery_reservation_v1.types.reservation import FailoverMode - -__all__ = ('ReservationServiceClient', - 'ReservationServiceAsyncClient', - 'Assignment', - 'BiReservation', - 'CapacityCommitment', - 'CreateAssignmentRequest', - 'CreateCapacityCommitmentRequest', - 'CreateReservationGroupRequest', - 'CreateReservationRequest', - 'DeleteAssignmentRequest', - 'DeleteCapacityCommitmentRequest', - 'DeleteReservationGroupRequest', - 'DeleteReservationRequest', - 'FailoverReservationRequest', - 'GetBiReservationRequest', - 'GetCapacityCommitmentRequest', - 'GetReservationGroupRequest', - 'GetReservationRequest', - 'ListAssignmentsRequest', - 'ListAssignmentsResponse', - 'ListCapacityCommitmentsRequest', - 'ListCapacityCommitmentsResponse', - 'ListReservationGroupsRequest', - 'ListReservationGroupsResponse', - 'ListReservationsRequest', - 'ListReservationsResponse', - 'MergeCapacityCommitmentsRequest', - 'MoveAssignmentRequest', - 'Reservation', - 'ReservationGroup', - 'SchedulingPolicy', - 'SearchAllAssignmentsRequest', - 'SearchAllAssignmentsResponse', - 'SearchAssignmentsRequest', - 'SearchAssignmentsResponse', - 'SplitCapacityCommitmentRequest', - 'SplitCapacityCommitmentResponse', - 'TableReference', - 'UpdateAssignmentRequest', - 'UpdateBiReservationRequest', - 'UpdateCapacityCommitmentRequest', - 'UpdateReservationRequest', - 'Edition', - 'FailoverMode', -) diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation/gapic_version.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation/gapic_version.py deleted file mode 100644 index 20a9cd975b02..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation/gapic_version.py +++ /dev/null @@ -1,16 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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.0.0" # {x-release-please-version} diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation/py.typed b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation/py.typed deleted file mode 100644 index ff261ee1d848..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-bigquery-reservation package uses inline types. diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/__init__.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/__init__.py deleted file mode 100644 index 05ff40e1cca9..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/__init__.py +++ /dev/null @@ -1,112 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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.bigquery_reservation_v1 import gapic_version as package_version - -__version__ = package_version.__version__ - - -from .services.reservation_service import ReservationServiceClient -from .services.reservation_service import ReservationServiceAsyncClient - -from .types.reservation import Assignment -from .types.reservation import BiReservation -from .types.reservation import CapacityCommitment -from .types.reservation import CreateAssignmentRequest -from .types.reservation import CreateCapacityCommitmentRequest -from .types.reservation import CreateReservationGroupRequest -from .types.reservation import CreateReservationRequest -from .types.reservation import DeleteAssignmentRequest -from .types.reservation import DeleteCapacityCommitmentRequest -from .types.reservation import DeleteReservationGroupRequest -from .types.reservation import DeleteReservationRequest -from .types.reservation import FailoverReservationRequest -from .types.reservation import GetBiReservationRequest -from .types.reservation import GetCapacityCommitmentRequest -from .types.reservation import GetReservationGroupRequest -from .types.reservation import GetReservationRequest -from .types.reservation import ListAssignmentsRequest -from .types.reservation import ListAssignmentsResponse -from .types.reservation import ListCapacityCommitmentsRequest -from .types.reservation import ListCapacityCommitmentsResponse -from .types.reservation import ListReservationGroupsRequest -from .types.reservation import ListReservationGroupsResponse -from .types.reservation import ListReservationsRequest -from .types.reservation import ListReservationsResponse -from .types.reservation import MergeCapacityCommitmentsRequest -from .types.reservation import MoveAssignmentRequest -from .types.reservation import Reservation -from .types.reservation import ReservationGroup -from .types.reservation import SchedulingPolicy -from .types.reservation import SearchAllAssignmentsRequest -from .types.reservation import SearchAllAssignmentsResponse -from .types.reservation import SearchAssignmentsRequest -from .types.reservation import SearchAssignmentsResponse -from .types.reservation import SplitCapacityCommitmentRequest -from .types.reservation import SplitCapacityCommitmentResponse -from .types.reservation import TableReference -from .types.reservation import UpdateAssignmentRequest -from .types.reservation import UpdateBiReservationRequest -from .types.reservation import UpdateCapacityCommitmentRequest -from .types.reservation import UpdateReservationRequest -from .types.reservation import Edition -from .types.reservation import FailoverMode - -__all__ = ( - 'ReservationServiceAsyncClient', -'Assignment', -'BiReservation', -'CapacityCommitment', -'CreateAssignmentRequest', -'CreateCapacityCommitmentRequest', -'CreateReservationGroupRequest', -'CreateReservationRequest', -'DeleteAssignmentRequest', -'DeleteCapacityCommitmentRequest', -'DeleteReservationGroupRequest', -'DeleteReservationRequest', -'Edition', -'FailoverMode', -'FailoverReservationRequest', -'GetBiReservationRequest', -'GetCapacityCommitmentRequest', -'GetReservationGroupRequest', -'GetReservationRequest', -'ListAssignmentsRequest', -'ListAssignmentsResponse', -'ListCapacityCommitmentsRequest', -'ListCapacityCommitmentsResponse', -'ListReservationGroupsRequest', -'ListReservationGroupsResponse', -'ListReservationsRequest', -'ListReservationsResponse', -'MergeCapacityCommitmentsRequest', -'MoveAssignmentRequest', -'Reservation', -'ReservationGroup', -'ReservationServiceClient', -'SchedulingPolicy', -'SearchAllAssignmentsRequest', -'SearchAllAssignmentsResponse', -'SearchAssignmentsRequest', -'SearchAssignmentsResponse', -'SplitCapacityCommitmentRequest', -'SplitCapacityCommitmentResponse', -'TableReference', -'UpdateAssignmentRequest', -'UpdateBiReservationRequest', -'UpdateCapacityCommitmentRequest', -'UpdateReservationRequest', -) diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/gapic_metadata.json b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/gapic_metadata.json deleted file mode 100644 index 7216bd76bb22..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/gapic_metadata.json +++ /dev/null @@ -1,463 +0,0 @@ - { - "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", - "language": "python", - "libraryPackage": "google.cloud.bigquery_reservation_v1", - "protoPackage": "google.cloud.bigquery.reservation.v1", - "schema": "1.0", - "services": { - "ReservationService": { - "clients": { - "grpc": { - "libraryClient": "ReservationServiceClient", - "rpcs": { - "CreateAssignment": { - "methods": [ - "create_assignment" - ] - }, - "CreateCapacityCommitment": { - "methods": [ - "create_capacity_commitment" - ] - }, - "CreateReservation": { - "methods": [ - "create_reservation" - ] - }, - "CreateReservationGroup": { - "methods": [ - "create_reservation_group" - ] - }, - "DeleteAssignment": { - "methods": [ - "delete_assignment" - ] - }, - "DeleteCapacityCommitment": { - "methods": [ - "delete_capacity_commitment" - ] - }, - "DeleteReservation": { - "methods": [ - "delete_reservation" - ] - }, - "DeleteReservationGroup": { - "methods": [ - "delete_reservation_group" - ] - }, - "FailoverReservation": { - "methods": [ - "failover_reservation" - ] - }, - "GetBiReservation": { - "methods": [ - "get_bi_reservation" - ] - }, - "GetCapacityCommitment": { - "methods": [ - "get_capacity_commitment" - ] - }, - "GetIamPolicy": { - "methods": [ - "get_iam_policy" - ] - }, - "GetReservation": { - "methods": [ - "get_reservation" - ] - }, - "GetReservationGroup": { - "methods": [ - "get_reservation_group" - ] - }, - "ListAssignments": { - "methods": [ - "list_assignments" - ] - }, - "ListCapacityCommitments": { - "methods": [ - "list_capacity_commitments" - ] - }, - "ListReservationGroups": { - "methods": [ - "list_reservation_groups" - ] - }, - "ListReservations": { - "methods": [ - "list_reservations" - ] - }, - "MergeCapacityCommitments": { - "methods": [ - "merge_capacity_commitments" - ] - }, - "MoveAssignment": { - "methods": [ - "move_assignment" - ] - }, - "SearchAllAssignments": { - "methods": [ - "search_all_assignments" - ] - }, - "SearchAssignments": { - "methods": [ - "search_assignments" - ] - }, - "SetIamPolicy": { - "methods": [ - "set_iam_policy" - ] - }, - "SplitCapacityCommitment": { - "methods": [ - "split_capacity_commitment" - ] - }, - "TestIamPermissions": { - "methods": [ - "test_iam_permissions" - ] - }, - "UpdateAssignment": { - "methods": [ - "update_assignment" - ] - }, - "UpdateBiReservation": { - "methods": [ - "update_bi_reservation" - ] - }, - "UpdateCapacityCommitment": { - "methods": [ - "update_capacity_commitment" - ] - }, - "UpdateReservation": { - "methods": [ - "update_reservation" - ] - } - } - }, - "grpc-async": { - "libraryClient": "ReservationServiceAsyncClient", - "rpcs": { - "CreateAssignment": { - "methods": [ - "create_assignment" - ] - }, - "CreateCapacityCommitment": { - "methods": [ - "create_capacity_commitment" - ] - }, - "CreateReservation": { - "methods": [ - "create_reservation" - ] - }, - "CreateReservationGroup": { - "methods": [ - "create_reservation_group" - ] - }, - "DeleteAssignment": { - "methods": [ - "delete_assignment" - ] - }, - "DeleteCapacityCommitment": { - "methods": [ - "delete_capacity_commitment" - ] - }, - "DeleteReservation": { - "methods": [ - "delete_reservation" - ] - }, - "DeleteReservationGroup": { - "methods": [ - "delete_reservation_group" - ] - }, - "FailoverReservation": { - "methods": [ - "failover_reservation" - ] - }, - "GetBiReservation": { - "methods": [ - "get_bi_reservation" - ] - }, - "GetCapacityCommitment": { - "methods": [ - "get_capacity_commitment" - ] - }, - "GetIamPolicy": { - "methods": [ - "get_iam_policy" - ] - }, - "GetReservation": { - "methods": [ - "get_reservation" - ] - }, - "GetReservationGroup": { - "methods": [ - "get_reservation_group" - ] - }, - "ListAssignments": { - "methods": [ - "list_assignments" - ] - }, - "ListCapacityCommitments": { - "methods": [ - "list_capacity_commitments" - ] - }, - "ListReservationGroups": { - "methods": [ - "list_reservation_groups" - ] - }, - "ListReservations": { - "methods": [ - "list_reservations" - ] - }, - "MergeCapacityCommitments": { - "methods": [ - "merge_capacity_commitments" - ] - }, - "MoveAssignment": { - "methods": [ - "move_assignment" - ] - }, - "SearchAllAssignments": { - "methods": [ - "search_all_assignments" - ] - }, - "SearchAssignments": { - "methods": [ - "search_assignments" - ] - }, - "SetIamPolicy": { - "methods": [ - "set_iam_policy" - ] - }, - "SplitCapacityCommitment": { - "methods": [ - "split_capacity_commitment" - ] - }, - "TestIamPermissions": { - "methods": [ - "test_iam_permissions" - ] - }, - "UpdateAssignment": { - "methods": [ - "update_assignment" - ] - }, - "UpdateBiReservation": { - "methods": [ - "update_bi_reservation" - ] - }, - "UpdateCapacityCommitment": { - "methods": [ - "update_capacity_commitment" - ] - }, - "UpdateReservation": { - "methods": [ - "update_reservation" - ] - } - } - }, - "rest": { - "libraryClient": "ReservationServiceClient", - "rpcs": { - "CreateAssignment": { - "methods": [ - "create_assignment" - ] - }, - "CreateCapacityCommitment": { - "methods": [ - "create_capacity_commitment" - ] - }, - "CreateReservation": { - "methods": [ - "create_reservation" - ] - }, - "CreateReservationGroup": { - "methods": [ - "create_reservation_group" - ] - }, - "DeleteAssignment": { - "methods": [ - "delete_assignment" - ] - }, - "DeleteCapacityCommitment": { - "methods": [ - "delete_capacity_commitment" - ] - }, - "DeleteReservation": { - "methods": [ - "delete_reservation" - ] - }, - "DeleteReservationGroup": { - "methods": [ - "delete_reservation_group" - ] - }, - "FailoverReservation": { - "methods": [ - "failover_reservation" - ] - }, - "GetBiReservation": { - "methods": [ - "get_bi_reservation" - ] - }, - "GetCapacityCommitment": { - "methods": [ - "get_capacity_commitment" - ] - }, - "GetIamPolicy": { - "methods": [ - "get_iam_policy" - ] - }, - "GetReservation": { - "methods": [ - "get_reservation" - ] - }, - "GetReservationGroup": { - "methods": [ - "get_reservation_group" - ] - }, - "ListAssignments": { - "methods": [ - "list_assignments" - ] - }, - "ListCapacityCommitments": { - "methods": [ - "list_capacity_commitments" - ] - }, - "ListReservationGroups": { - "methods": [ - "list_reservation_groups" - ] - }, - "ListReservations": { - "methods": [ - "list_reservations" - ] - }, - "MergeCapacityCommitments": { - "methods": [ - "merge_capacity_commitments" - ] - }, - "MoveAssignment": { - "methods": [ - "move_assignment" - ] - }, - "SearchAllAssignments": { - "methods": [ - "search_all_assignments" - ] - }, - "SearchAssignments": { - "methods": [ - "search_assignments" - ] - }, - "SetIamPolicy": { - "methods": [ - "set_iam_policy" - ] - }, - "SplitCapacityCommitment": { - "methods": [ - "split_capacity_commitment" - ] - }, - "TestIamPermissions": { - "methods": [ - "test_iam_permissions" - ] - }, - "UpdateAssignment": { - "methods": [ - "update_assignment" - ] - }, - "UpdateBiReservation": { - "methods": [ - "update_bi_reservation" - ] - }, - "UpdateCapacityCommitment": { - "methods": [ - "update_capacity_commitment" - ] - }, - "UpdateReservation": { - "methods": [ - "update_reservation" - ] - } - } - } - } - } - } -} diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/gapic_version.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/gapic_version.py deleted file mode 100644 index 20a9cd975b02..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/gapic_version.py +++ /dev/null @@ -1,16 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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.0.0" # {x-release-please-version} diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/py.typed b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/py.typed deleted file mode 100644 index ff261ee1d848..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-bigquery-reservation package uses inline types. diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/__init__.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/__init__.py deleted file mode 100644 index cbf94b283c70..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/__init__.py +++ /dev/null @@ -1,15 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/__init__.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/__init__.py deleted file mode 100644 index 58f7130ab0b3..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/__init__.py +++ /dev/null @@ -1,22 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 ReservationServiceClient -from .async_client import ReservationServiceAsyncClient - -__all__ = ( - 'ReservationServiceClient', - 'ReservationServiceAsyncClient', -) diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/async_client.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/async_client.py deleted file mode 100644 index 2d47de243606..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/async_client.py +++ /dev/null @@ -1,3824 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 logging as std_logging -from collections import OrderedDict -import re -from typing import Dict, Callable, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union -import warnings - -from google.cloud.bigquery_reservation_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_async as retries -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore -import google.protobuf - - -try: - OptionalRetry = Union[retries.AsyncRetry, gapic_v1.method._MethodDefault, None] -except AttributeError: # pragma: NO COVER - OptionalRetry = Union[retries.AsyncRetry, object, None] # type: ignore - -from google.cloud.bigquery_reservation_v1.services.reservation_service import pagers -from google.cloud.bigquery_reservation_v1.types import reservation -from google.cloud.bigquery_reservation_v1.types import reservation as gcbr_reservation -from google.iam.v1 import iam_policy_pb2 # type: ignore -from google.iam.v1 import policy_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 .transports.base import ReservationServiceTransport, DEFAULT_CLIENT_INFO -from .transports.grpc_asyncio import ReservationServiceGrpcAsyncIOTransport -from .client import ReservationServiceClient - -try: - from google.api_core import client_logging # type: ignore - CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER -except ImportError: # pragma: NO COVER - CLIENT_LOGGING_SUPPORTED = False - -_LOGGER = std_logging.getLogger(__name__) - -class ReservationServiceAsyncClient: - """This API allows users to manage their BigQuery reservations. - - A reservation provides computational resource guarantees, in the - form of `slots `__, to - users. A slot is a unit of computational power in BigQuery, and - serves as the basic unit of parallelism. In a scan of a - multi-partitioned table, a single slot operates on a single - partition of the table. A reservation resource exists as a child - resource of the admin project and location, e.g.: - ``projects/myproject/locations/US/reservations/reservationName``. - - A capacity commitment is a way to purchase compute capacity for - BigQuery jobs (in the form of slots) with some committed period of - usage. A capacity commitment resource exists as a child resource of - the admin project and location, e.g.: - ``projects/myproject/locations/US/capacityCommitments/id``. - """ - - _client: ReservationServiceClient - - # Copy defaults from the synchronous client for use here. - # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. - DEFAULT_ENDPOINT = ReservationServiceClient.DEFAULT_ENDPOINT - DEFAULT_MTLS_ENDPOINT = ReservationServiceClient.DEFAULT_MTLS_ENDPOINT - _DEFAULT_ENDPOINT_TEMPLATE = ReservationServiceClient._DEFAULT_ENDPOINT_TEMPLATE - _DEFAULT_UNIVERSE = ReservationServiceClient._DEFAULT_UNIVERSE - - assignment_path = staticmethod(ReservationServiceClient.assignment_path) - parse_assignment_path = staticmethod(ReservationServiceClient.parse_assignment_path) - bi_reservation_path = staticmethod(ReservationServiceClient.bi_reservation_path) - parse_bi_reservation_path = staticmethod(ReservationServiceClient.parse_bi_reservation_path) - capacity_commitment_path = staticmethod(ReservationServiceClient.capacity_commitment_path) - parse_capacity_commitment_path = staticmethod(ReservationServiceClient.parse_capacity_commitment_path) - reservation_path = staticmethod(ReservationServiceClient.reservation_path) - parse_reservation_path = staticmethod(ReservationServiceClient.parse_reservation_path) - reservation_group_path = staticmethod(ReservationServiceClient.reservation_group_path) - parse_reservation_group_path = staticmethod(ReservationServiceClient.parse_reservation_group_path) - common_billing_account_path = staticmethod(ReservationServiceClient.common_billing_account_path) - parse_common_billing_account_path = staticmethod(ReservationServiceClient.parse_common_billing_account_path) - common_folder_path = staticmethod(ReservationServiceClient.common_folder_path) - parse_common_folder_path = staticmethod(ReservationServiceClient.parse_common_folder_path) - common_organization_path = staticmethod(ReservationServiceClient.common_organization_path) - parse_common_organization_path = staticmethod(ReservationServiceClient.parse_common_organization_path) - common_project_path = staticmethod(ReservationServiceClient.common_project_path) - parse_common_project_path = staticmethod(ReservationServiceClient.parse_common_project_path) - common_location_path = staticmethod(ReservationServiceClient.common_location_path) - parse_common_location_path = staticmethod(ReservationServiceClient.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: - ReservationServiceAsyncClient: The constructed client. - """ - return ReservationServiceClient.from_service_account_info.__func__(ReservationServiceAsyncClient, 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: - ReservationServiceAsyncClient: The constructed client. - """ - return ReservationServiceClient.from_service_account_file.__func__(ReservationServiceAsyncClient, 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 ReservationServiceClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore - - @property - def transport(self) -> ReservationServiceTransport: - """Returns the transport used by the client instance. - - Returns: - ReservationServiceTransport: The transport used by the client instance. - """ - return self._client.transport - - @property - def api_endpoint(self): - """Return the API endpoint used by the client instance. - - Returns: - str: The API endpoint used by the client instance. - """ - return self._client._api_endpoint - - @property - def universe_domain(self) -> str: - """Return the universe domain used by the client instance. - - Returns: - str: The universe domain used - by the client instance. - """ - return self._client._universe_domain - - get_transport_class = ReservationServiceClient.get_transport_class - - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Optional[Union[str, ReservationServiceTransport, Callable[..., ReservationServiceTransport]]] = "grpc_asyncio", - client_options: Optional[ClientOptions] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the reservation service async 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 (Optional[Union[str,ReservationServiceTransport,Callable[..., ReservationServiceTransport]]]): - The transport to use, or a Callable that constructs and returns a new transport to use. - If a Callable is given, it will be called with the same set of initialization - arguments as used in the ReservationServiceTransport constructor. - 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. - - 1. The ``api_endpoint`` property can be used to override the - default endpoint provided by the client when ``transport`` is - not explicitly provided. Only if this property is not set and - ``transport`` was not explicitly provided, the endpoint is - determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment - variable, which have one of the following values: - "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). - - 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable - is "true", then the ``client_cert_source`` property can be used - to provide a client certificate for mTLS 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. - - 3. The ``universe_domain`` property can be used to override the - default "googleapis.com" universe. Note that ``api_endpoint`` - property still takes precedence; and ``universe_domain`` is - currently not supported for mTLS. - - 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. - """ - self._client = ReservationServiceClient( - credentials=credentials, - transport=transport, - client_options=client_options, - client_info=client_info, - - ) - - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(std_logging.DEBUG): # pragma: NO COVER - _LOGGER.debug( - "Created client `google.cloud.bigquery.reservation_v1.ReservationServiceAsyncClient`.", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "universeDomain": getattr(self._client._transport._credentials, "universe_domain", ""), - "credentialsType": f"{type(self._client._transport._credentials).__module__}.{type(self._client._transport._credentials).__qualname__}", - "credentialsInfo": getattr(self.transport._credentials, "get_cred_info", lambda: None)(), - } if hasattr(self._client._transport, "_credentials") else { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "credentialsType": None, - } - ) - - async def create_reservation(self, - request: Optional[Union[gcbr_reservation.CreateReservationRequest, dict]] = None, - *, - parent: Optional[str] = None, - reservation: Optional[gcbr_reservation.Reservation] = None, - reservation_id: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> gcbr_reservation.Reservation: - r"""Creates a new reservation 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 bigquery_reservation_v1 - - async def sample_create_reservation(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.CreateReservationRequest( - parent="parent_value", - ) - - # Make the request - response = await client.create_reservation(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.bigquery_reservation_v1.types.CreateReservationRequest, dict]]): - The request object. The request for - [ReservationService.CreateReservation][google.cloud.bigquery.reservation.v1.ReservationService.CreateReservation]. - parent (:class:`str`): - Required. Project, location. E.g., - ``projects/myproject/locations/US`` - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - reservation (:class:`google.cloud.bigquery_reservation_v1.types.Reservation`): - Definition of the new reservation to - create. - - This corresponds to the ``reservation`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - reservation_id (:class:`str`): - The reservation ID. It must only - contain lower case alphanumeric - characters or dashes. It must start with - a letter and must not end with a dash. - Its maximum length is 64 characters. - - This corresponds to the ``reservation_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.types.Reservation: - A reservation is a mechanism used to - guarantee slots to users. - - """ - # 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. - flattened_params = [parent, reservation, reservation_id] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.") - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, gcbr_reservation.CreateReservationRequest): - request = gcbr_reservation.CreateReservationRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if reservation is not None: - request.reservation = reservation - if reservation_id is not None: - request.reservation_id = reservation_id - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._client._transport._wrapped_methods[self._client._transport.create_reservation] - - # 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), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def list_reservations(self, - request: Optional[Union[reservation.ListReservationsRequest, dict]] = None, - *, - parent: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> pagers.ListReservationsAsyncPager: - r"""Lists all the reservations for the project in the - specified location. - - .. 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 bigquery_reservation_v1 - - async def sample_list_reservations(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.ListReservationsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_reservations(request=request) - - # Handle the response - async for response in page_result: - print(response) - - Args: - request (Optional[Union[google.cloud.bigquery_reservation_v1.types.ListReservationsRequest, dict]]): - The request object. The request for - [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations]. - parent (:class:`str`): - Required. The parent resource name containing project - and location, e.g.: ``projects/myproject/locations/US`` - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListReservationsAsyncPager: - The response for - [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations]. - - 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. - flattened_params = [parent] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.") - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.ListReservationsRequest): - request = reservation.ListReservationsRequest(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._client._transport._wrapped_methods[self._client._transport.list_reservations] - - # 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), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # 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.ListReservationsAsyncPager( - method=rpc, - request=request, - response=response, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def get_reservation(self, - request: Optional[Union[reservation.GetReservationRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> reservation.Reservation: - r"""Returns information about the reservation. - - .. 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 bigquery_reservation_v1 - - async def sample_get_reservation(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.GetReservationRequest( - name="name_value", - ) - - # Make the request - response = await client.get_reservation(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.bigquery_reservation_v1.types.GetReservationRequest, dict]]): - The request object. The request for - [ReservationService.GetReservation][google.cloud.bigquery.reservation.v1.ReservationService.GetReservation]. - name (:class:`str`): - Required. Resource name of the reservation to retrieve. - E.g., - ``projects/myproject/locations/US/reservations/team1-prod`` - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.types.Reservation: - A reservation is a mechanism used to - guarantee slots to users. - - """ - # 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. - flattened_params = [name] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.") - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.GetReservationRequest): - request = reservation.GetReservationRequest(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._client._transport._wrapped_methods[self._client._transport.get_reservation] - - # 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), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def delete_reservation(self, - request: Optional[Union[reservation.DeleteReservationRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> None: - r"""Deletes a reservation. Returns - ``google.rpc.Code.FAILED_PRECONDITION`` when reservation has - assignments. - - .. 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 bigquery_reservation_v1 - - async def sample_delete_reservation(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.DeleteReservationRequest( - name="name_value", - ) - - # Make the request - await client.delete_reservation(request=request) - - Args: - request (Optional[Union[google.cloud.bigquery_reservation_v1.types.DeleteReservationRequest, dict]]): - The request object. The request for - [ReservationService.DeleteReservation][google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservation]. - name (:class:`str`): - Required. Resource name of the reservation to retrieve. - E.g., - ``projects/myproject/locations/US/reservations/team1-prod`` - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - """ - # 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. - flattened_params = [name] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.") - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.DeleteReservationRequest): - request = reservation.DeleteReservationRequest(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._client._transport._wrapped_methods[self._client._transport.delete_reservation] - - # 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), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # Send the request. - await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - async def update_reservation(self, - request: Optional[Union[gcbr_reservation.UpdateReservationRequest, dict]] = None, - *, - reservation: Optional[gcbr_reservation.Reservation] = 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, Union[str, bytes]]] = (), - ) -> gcbr_reservation.Reservation: - r"""Updates an existing reservation 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 bigquery_reservation_v1 - - async def sample_update_reservation(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.UpdateReservationRequest( - ) - - # Make the request - response = await client.update_reservation(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.bigquery_reservation_v1.types.UpdateReservationRequest, dict]]): - The request object. The request for - [ReservationService.UpdateReservation][google.cloud.bigquery.reservation.v1.ReservationService.UpdateReservation]. - reservation (:class:`google.cloud.bigquery_reservation_v1.types.Reservation`): - Content of the reservation to update. - This corresponds to the ``reservation`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): - Standard field mask for the set of - fields to be updated. - - 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_async.AsyncRetry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.types.Reservation: - A reservation is a mechanism used to - guarantee slots to users. - - """ - # 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. - flattened_params = [reservation, update_mask] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.") - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, gcbr_reservation.UpdateReservationRequest): - request = gcbr_reservation.UpdateReservationRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if reservation is not None: - request.reservation = reservation - 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._client._transport._wrapped_methods[self._client._transport.update_reservation] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("reservation.name", request.reservation.name), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def failover_reservation(self, - request: Optional[Union[reservation.FailoverReservationRequest, dict]] = None, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> reservation.Reservation: - r"""Fail over a reservation to the secondary location. The operation - should be done in the current secondary location, which will be - promoted to the new primary location for the reservation. - Attempting to failover a reservation in the current primary - location will fail with the error code - ``google.rpc.Code.FAILED_PRECONDITION``. - - .. 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 bigquery_reservation_v1 - - async def sample_failover_reservation(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.FailoverReservationRequest( - name="name_value", - ) - - # Make the request - response = await client.failover_reservation(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.bigquery_reservation_v1.types.FailoverReservationRequest, dict]]): - The request object. The request for - ReservationService.FailoverReservation. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.types.Reservation: - A reservation is a mechanism used to - guarantee slots to users. - - """ - # Create or coerce a protobuf request object. - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.FailoverReservationRequest): - request = reservation.FailoverReservationRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._client._transport._wrapped_methods[self._client._transport.failover_reservation] - - # 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), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def create_capacity_commitment(self, - request: Optional[Union[reservation.CreateCapacityCommitmentRequest, dict]] = None, - *, - parent: Optional[str] = None, - capacity_commitment: Optional[reservation.CapacityCommitment] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> reservation.CapacityCommitment: - r"""Creates a new capacity commitment 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 bigquery_reservation_v1 - - async def sample_create_capacity_commitment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.CreateCapacityCommitmentRequest( - parent="parent_value", - ) - - # Make the request - response = await client.create_capacity_commitment(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.bigquery_reservation_v1.types.CreateCapacityCommitmentRequest, dict]]): - The request object. The request for - [ReservationService.CreateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.CreateCapacityCommitment]. - parent (:class:`str`): - Required. Resource name of the parent reservation. E.g., - ``projects/myproject/locations/US`` - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - capacity_commitment (:class:`google.cloud.bigquery_reservation_v1.types.CapacityCommitment`): - Content of the capacity commitment to - create. - - This corresponds to the ``capacity_commitment`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.types.CapacityCommitment: - Capacity commitment is a way to - purchase compute capacity for BigQuery - jobs (in the form of slots) with some - committed period of usage. Annual - commitments renew by default. - Commitments can be removed after their - commitment end time passes. - - In order to remove annual commitment, - its plan needs to be changed to monthly - or flex first. - - A capacity commitment resource exists as - a child resource of the admin project. - - """ - # 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. - flattened_params = [parent, capacity_commitment] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.") - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.CreateCapacityCommitmentRequest): - request = reservation.CreateCapacityCommitmentRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if capacity_commitment is not None: - request.capacity_commitment = capacity_commitment - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._client._transport._wrapped_methods[self._client._transport.create_capacity_commitment] - - # 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), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def list_capacity_commitments(self, - request: Optional[Union[reservation.ListCapacityCommitmentsRequest, dict]] = None, - *, - parent: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> pagers.ListCapacityCommitmentsAsyncPager: - r"""Lists all the capacity commitments for the admin - 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 bigquery_reservation_v1 - - async def sample_list_capacity_commitments(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.ListCapacityCommitmentsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_capacity_commitments(request=request) - - # Handle the response - async for response in page_result: - print(response) - - Args: - request (Optional[Union[google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsRequest, dict]]): - The request object. The request for - [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments]. - parent (:class:`str`): - Required. Resource name of the parent reservation. E.g., - ``projects/myproject/locations/US`` - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListCapacityCommitmentsAsyncPager: - The response for - [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments]. - - 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. - flattened_params = [parent] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.") - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.ListCapacityCommitmentsRequest): - request = reservation.ListCapacityCommitmentsRequest(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._client._transport._wrapped_methods[self._client._transport.list_capacity_commitments] - - # 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), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # 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.ListCapacityCommitmentsAsyncPager( - method=rpc, - request=request, - response=response, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def get_capacity_commitment(self, - request: Optional[Union[reservation.GetCapacityCommitmentRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> reservation.CapacityCommitment: - r"""Returns information about the capacity commitment. - - .. 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 bigquery_reservation_v1 - - async def sample_get_capacity_commitment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.GetCapacityCommitmentRequest( - name="name_value", - ) - - # Make the request - response = await client.get_capacity_commitment(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.bigquery_reservation_v1.types.GetCapacityCommitmentRequest, dict]]): - The request object. The request for - [ReservationService.GetCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitment]. - name (:class:`str`): - Required. Resource name of the capacity commitment to - retrieve. E.g., - ``projects/myproject/locations/US/capacityCommitments/123`` - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.types.CapacityCommitment: - Capacity commitment is a way to - purchase compute capacity for BigQuery - jobs (in the form of slots) with some - committed period of usage. Annual - commitments renew by default. - Commitments can be removed after their - commitment end time passes. - - In order to remove annual commitment, - its plan needs to be changed to monthly - or flex first. - - A capacity commitment resource exists as - a child resource of the admin project. - - """ - # 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. - flattened_params = [name] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.") - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.GetCapacityCommitmentRequest): - request = reservation.GetCapacityCommitmentRequest(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._client._transport._wrapped_methods[self._client._transport.get_capacity_commitment] - - # 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), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def delete_capacity_commitment(self, - request: Optional[Union[reservation.DeleteCapacityCommitmentRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> None: - r"""Deletes a capacity commitment. Attempting to delete capacity - commitment before its commitment_end_time will fail with the - error code ``google.rpc.Code.FAILED_PRECONDITION``. - - .. 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 bigquery_reservation_v1 - - async def sample_delete_capacity_commitment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.DeleteCapacityCommitmentRequest( - name="name_value", - ) - - # Make the request - await client.delete_capacity_commitment(request=request) - - Args: - request (Optional[Union[google.cloud.bigquery_reservation_v1.types.DeleteCapacityCommitmentRequest, dict]]): - The request object. The request for - [ReservationService.DeleteCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteCapacityCommitment]. - name (:class:`str`): - Required. Resource name of the capacity commitment to - delete. E.g., - ``projects/myproject/locations/US/capacityCommitments/123`` - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - """ - # 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. - flattened_params = [name] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.") - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.DeleteCapacityCommitmentRequest): - request = reservation.DeleteCapacityCommitmentRequest(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._client._transport._wrapped_methods[self._client._transport.delete_capacity_commitment] - - # 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), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # Send the request. - await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - async def update_capacity_commitment(self, - request: Optional[Union[reservation.UpdateCapacityCommitmentRequest, dict]] = None, - *, - capacity_commitment: Optional[reservation.CapacityCommitment] = 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, Union[str, bytes]]] = (), - ) -> reservation.CapacityCommitment: - r"""Updates an existing capacity commitment. - - Only ``plan`` and ``renewal_plan`` fields can be updated. - - Plan can only be changed to a plan of a longer commitment - period. Attempting to change to a plan with shorter commitment - period will fail with the error code - ``google.rpc.Code.FAILED_PRECONDITION``. - - .. 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 bigquery_reservation_v1 - - async def sample_update_capacity_commitment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.UpdateCapacityCommitmentRequest( - ) - - # Make the request - response = await client.update_capacity_commitment(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.bigquery_reservation_v1.types.UpdateCapacityCommitmentRequest, dict]]): - The request object. The request for - [ReservationService.UpdateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateCapacityCommitment]. - capacity_commitment (:class:`google.cloud.bigquery_reservation_v1.types.CapacityCommitment`): - Content of the capacity commitment to - update. - - This corresponds to the ``capacity_commitment`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): - Standard field mask for the set of - fields to be updated. - - 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_async.AsyncRetry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.types.CapacityCommitment: - Capacity commitment is a way to - purchase compute capacity for BigQuery - jobs (in the form of slots) with some - committed period of usage. Annual - commitments renew by default. - Commitments can be removed after their - commitment end time passes. - - In order to remove annual commitment, - its plan needs to be changed to monthly - or flex first. - - A capacity commitment resource exists as - a child resource of the admin project. - - """ - # 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. - flattened_params = [capacity_commitment, update_mask] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.") - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.UpdateCapacityCommitmentRequest): - request = reservation.UpdateCapacityCommitmentRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if capacity_commitment is not None: - request.capacity_commitment = capacity_commitment - 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._client._transport._wrapped_methods[self._client._transport.update_capacity_commitment] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("capacity_commitment.name", request.capacity_commitment.name), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def split_capacity_commitment(self, - request: Optional[Union[reservation.SplitCapacityCommitmentRequest, dict]] = None, - *, - name: Optional[str] = None, - slot_count: Optional[int] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> reservation.SplitCapacityCommitmentResponse: - r"""Splits capacity commitment to two commitments of the same plan - and ``commitment_end_time``. - - A common use case is to enable downgrading commitments. - - For example, in order to downgrade from 10000 slots to 8000, you - might split a 10000 capacity commitment into commitments of 2000 - and 8000. Then, you delete the first one after the commitment - end time passes. - - .. 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 bigquery_reservation_v1 - - async def sample_split_capacity_commitment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.SplitCapacityCommitmentRequest( - name="name_value", - ) - - # Make the request - response = await client.split_capacity_commitment(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.bigquery_reservation_v1.types.SplitCapacityCommitmentRequest, dict]]): - The request object. The request for - [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment]. - name (:class:`str`): - Required. The resource name e.g.,: - ``projects/myproject/locations/US/capacityCommitments/123`` - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - slot_count (:class:`int`): - Number of slots in the capacity - commitment after the split. - - This corresponds to the ``slot_count`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.types.SplitCapacityCommitmentResponse: - The response for - [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment]. - - """ - # 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. - flattened_params = [name, slot_count] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.") - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.SplitCapacityCommitmentRequest): - request = reservation.SplitCapacityCommitmentRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if slot_count is not None: - request.slot_count = slot_count - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._client._transport._wrapped_methods[self._client._transport.split_capacity_commitment] - - # 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), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def merge_capacity_commitments(self, - request: Optional[Union[reservation.MergeCapacityCommitmentsRequest, dict]] = None, - *, - parent: Optional[str] = None, - capacity_commitment_ids: Optional[MutableSequence[str]] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> reservation.CapacityCommitment: - r"""Merges capacity commitments of the same plan into a single - commitment. - - The resulting capacity commitment has the greater - commitment_end_time out of the to-be-merged capacity - commitments. - - Attempting to merge capacity commitments of different plan will - fail with the error code - ``google.rpc.Code.FAILED_PRECONDITION``. - - .. 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 bigquery_reservation_v1 - - async def sample_merge_capacity_commitments(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.MergeCapacityCommitmentsRequest( - ) - - # Make the request - response = await client.merge_capacity_commitments(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.bigquery_reservation_v1.types.MergeCapacityCommitmentsRequest, dict]]): - The request object. The request for - [ReservationService.MergeCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.MergeCapacityCommitments]. - parent (:class:`str`): - Parent resource that identifies admin project and - location e.g., ``projects/myproject/locations/us`` - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - capacity_commitment_ids (:class:`MutableSequence[str]`): - Ids of capacity commitments to merge. - These capacity commitments must exist - under admin project and location - specified in the parent. - ID is the last portion of capacity - commitment name e.g., 'abc' for - projects/myproject/locations/US/capacityCommitments/abc - - This corresponds to the ``capacity_commitment_ids`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.types.CapacityCommitment: - Capacity commitment is a way to - purchase compute capacity for BigQuery - jobs (in the form of slots) with some - committed period of usage. Annual - commitments renew by default. - Commitments can be removed after their - commitment end time passes. - - In order to remove annual commitment, - its plan needs to be changed to monthly - or flex first. - - A capacity commitment resource exists as - a child resource of the admin project. - - """ - # 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. - flattened_params = [parent, capacity_commitment_ids] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.") - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.MergeCapacityCommitmentsRequest): - request = reservation.MergeCapacityCommitmentsRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if capacity_commitment_ids: - request.capacity_commitment_ids.extend(capacity_commitment_ids) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._client._transport._wrapped_methods[self._client._transport.merge_capacity_commitments] - - # 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), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def create_assignment(self, - request: Optional[Union[reservation.CreateAssignmentRequest, dict]] = None, - *, - parent: Optional[str] = None, - assignment: Optional[reservation.Assignment] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> reservation.Assignment: - r"""Creates an assignment object which allows the given project to - submit jobs of a certain type using slots from the specified - reservation. - - Currently a resource (project, folder, organization) can only - have one assignment per each (job_type, location) combination, - and that reservation will be used for all jobs of the matching - type. - - Different assignments can be created on different levels of the - projects, folders or organization hierarchy. During query - execution, the assignment is looked up at the project, folder - and organization levels in that order. The first assignment - found is applied to the query. - - When creating assignments, it does not matter if other - assignments exist at higher levels. - - Example: - - - The organization ``organizationA`` contains two projects, - ``project1`` and ``project2``. - - Assignments for all three entities (``organizationA``, - ``project1``, and ``project2``) could all be created and - mapped to the same or different reservations. - - "None" assignments represent an absence of the assignment. - Projects assigned to None use on-demand pricing. To create a - "None" assignment, use "none" as a reservation_id in the parent. - Example parent: - ``projects/myproject/locations/US/reservations/none``. - - Returns ``google.rpc.Code.PERMISSION_DENIED`` if user does not - have 'bigquery.admin' permissions on the project using the - reservation and the project that owns this reservation. - - Returns ``google.rpc.Code.INVALID_ARGUMENT`` when location of - the assignment does not match location of the reservation. - - .. 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 bigquery_reservation_v1 - - async def sample_create_assignment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.CreateAssignmentRequest( - parent="parent_value", - ) - - # Make the request - response = await client.create_assignment(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.bigquery_reservation_v1.types.CreateAssignmentRequest, dict]]): - The request object. The request for - [ReservationService.CreateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.CreateAssignment]. - Note: "bigquery.reservationAssignments.create" - permission is required on the related assignee. - parent (:class:`str`): - Required. The parent resource name of the assignment - E.g. - ``projects/myproject/locations/US/reservations/team1-prod`` - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - assignment (:class:`google.cloud.bigquery_reservation_v1.types.Assignment`): - Assignment resource to create. - This corresponds to the ``assignment`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.types.Assignment: - An assignment allows a project to - submit jobs of a certain type using - slots from the specified reservation. - - """ - # 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. - flattened_params = [parent, assignment] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.") - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.CreateAssignmentRequest): - request = reservation.CreateAssignmentRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if assignment is not None: - request.assignment = assignment - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._client._transport._wrapped_methods[self._client._transport.create_assignment] - - # 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), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def list_assignments(self, - request: Optional[Union[reservation.ListAssignmentsRequest, dict]] = None, - *, - parent: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> pagers.ListAssignmentsAsyncPager: - r"""Lists assignments. - - Only explicitly created assignments will be returned. - - Example: - - - Organization ``organizationA`` contains two projects, - ``project1`` and ``project2``. - - Reservation ``res1`` exists and was created previously. - - CreateAssignment was used previously to define the following - associations between entities and reservations: - ```` and ```` - - In this example, ListAssignments will just return the above two - assignments for reservation ``res1``, and no expansion/merge - will happen. - - The wildcard "-" can be used for reservations in the request. In - that case all assignments belongs to the specified project and - location will be listed. - - **Note** "-" cannot be used for projects nor locations. - - .. 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 bigquery_reservation_v1 - - async def sample_list_assignments(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.ListAssignmentsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_assignments(request=request) - - # Handle the response - async for response in page_result: - print(response) - - Args: - request (Optional[Union[google.cloud.bigquery_reservation_v1.types.ListAssignmentsRequest, dict]]): - The request object. The request for - [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments]. - parent (:class:`str`): - Required. The parent resource name e.g.: - - ``projects/myproject/locations/US/reservations/team1-prod`` - - Or: - - ``projects/myproject/locations/US/reservations/-`` - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListAssignmentsAsyncPager: - The response for - [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments]. - - 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. - flattened_params = [parent] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.") - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.ListAssignmentsRequest): - request = reservation.ListAssignmentsRequest(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._client._transport._wrapped_methods[self._client._transport.list_assignments] - - # 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), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # 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.ListAssignmentsAsyncPager( - method=rpc, - request=request, - response=response, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def delete_assignment(self, - request: Optional[Union[reservation.DeleteAssignmentRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> None: - r"""Deletes a assignment. No expansion will happen. - - Example: - - - Organization ``organizationA`` contains two projects, - ``project1`` and ``project2``. - - Reservation ``res1`` exists and was created previously. - - CreateAssignment was used previously to define the following - associations between entities and reservations: - ```` and ```` - - In this example, deletion of the ```` - assignment won't affect the other assignment - ````. After said deletion, queries from - ``project1`` will still use ``res1`` while queries from - ``project2`` will switch to use on-demand mode. - - .. 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 bigquery_reservation_v1 - - async def sample_delete_assignment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.DeleteAssignmentRequest( - name="name_value", - ) - - # Make the request - await client.delete_assignment(request=request) - - Args: - request (Optional[Union[google.cloud.bigquery_reservation_v1.types.DeleteAssignmentRequest, dict]]): - The request object. The request for - [ReservationService.DeleteAssignment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteAssignment]. - Note: "bigquery.reservationAssignments.delete" - permission is required on the related assignee. - name (:class:`str`): - Required. Name of the resource, e.g. - ``projects/myproject/locations/US/reservations/team1-prod/assignments/123`` - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - """ - # 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. - flattened_params = [name] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.") - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.DeleteAssignmentRequest): - request = reservation.DeleteAssignmentRequest(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._client._transport._wrapped_methods[self._client._transport.delete_assignment] - - # 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), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # Send the request. - await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - async def search_assignments(self, - request: Optional[Union[reservation.SearchAssignmentsRequest, dict]] = None, - *, - parent: Optional[str] = None, - query: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> pagers.SearchAssignmentsAsyncPager: - r"""Deprecated: Looks up assignments for a specified resource for a - particular region. If the request is about a project: - - 1. Assignments created on the project will be returned if they - exist. - 2. Otherwise assignments created on the closest ancestor will be - returned. - 3. Assignments for different JobTypes will all be returned. - - The same logic applies if the request is about a folder. - - If the request is about an organization, then assignments - created on the organization will be returned (organization - doesn't have ancestors). - - Comparing to ListAssignments, there are some behavior - differences: - - 1. permission on the assignee will be verified in this API. - 2. Hierarchy lookup (project->folder->organization) happens in - this API. - 3. Parent here is ``projects/*/locations/*``, instead of - ``projects/*/locations/*reservations/*``. - - **Note** "-" cannot be used for projects nor locations. - - .. 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 bigquery_reservation_v1 - - async def sample_search_assignments(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.SearchAssignmentsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.search_assignments(request=request) - - # Handle the response - async for response in page_result: - print(response) - - Args: - request (Optional[Union[google.cloud.bigquery_reservation_v1.types.SearchAssignmentsRequest, dict]]): - The request object. The request for - [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. - Note: "bigquery.reservationAssignments.search" - permission is required on the related assignee. - parent (:class:`str`): - Required. The resource name of the admin - project(containing project and location), e.g.: - ``projects/myproject/locations/US``. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - query (:class:`str`): - Please specify resource name as assignee in the query. - - Examples: - - - ``assignee=projects/myproject`` - - ``assignee=folders/123`` - - ``assignee=organizations/456`` - - This corresponds to the ``query`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.SearchAssignmentsAsyncPager: - The response for - [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. - - Iterating over this object will yield results and - resolve additional pages automatically. - - """ - warnings.warn("ReservationServiceAsyncClient.search_assignments is deprecated", - DeprecationWarning) - - # 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. - flattened_params = [parent, query] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.") - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.SearchAssignmentsRequest): - request = reservation.SearchAssignmentsRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if query is not None: - request.query = query - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._client._transport._wrapped_methods[self._client._transport.search_assignments] - - # 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), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # 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.SearchAssignmentsAsyncPager( - method=rpc, - request=request, - response=response, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def search_all_assignments(self, - request: Optional[Union[reservation.SearchAllAssignmentsRequest, dict]] = None, - *, - parent: Optional[str] = None, - query: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> pagers.SearchAllAssignmentsAsyncPager: - r"""Looks up assignments for a specified resource for a particular - region. If the request is about a project: - - 1. Assignments created on the project will be returned if they - exist. - 2. Otherwise assignments created on the closest ancestor will be - returned. - 3. Assignments for different JobTypes will all be returned. - - The same logic applies if the request is about a folder. - - If the request is about an organization, then assignments - created on the organization will be returned (organization - doesn't have ancestors). - - Comparing to ListAssignments, there are some behavior - differences: - - 1. permission on the assignee will be verified in this API. - 2. Hierarchy lookup (project->folder->organization) happens in - this API. - 3. Parent here is ``projects/*/locations/*``, instead of - ``projects/*/locations/*reservations/*``. - - .. 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 bigquery_reservation_v1 - - async def sample_search_all_assignments(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.SearchAllAssignmentsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.search_all_assignments(request=request) - - # Handle the response - async for response in page_result: - print(response) - - Args: - request (Optional[Union[google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsRequest, dict]]): - The request object. The request for - [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. - Note: "bigquery.reservationAssignments.search" - permission is required on the related assignee. - parent (:class:`str`): - Required. The resource name with location (project name - could be the wildcard '-'), e.g.: - ``projects/-/locations/US``. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - query (:class:`str`): - Please specify resource name as assignee in the query. - - Examples: - - - ``assignee=projects/myproject`` - - ``assignee=folders/123`` - - ``assignee=organizations/456`` - - This corresponds to the ``query`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.SearchAllAssignmentsAsyncPager: - The response for - [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. - - 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. - flattened_params = [parent, query] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.") - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.SearchAllAssignmentsRequest): - request = reservation.SearchAllAssignmentsRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if query is not None: - request.query = query - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._client._transport._wrapped_methods[self._client._transport.search_all_assignments] - - # 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), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # 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.SearchAllAssignmentsAsyncPager( - method=rpc, - request=request, - response=response, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def move_assignment(self, - request: Optional[Union[reservation.MoveAssignmentRequest, dict]] = None, - *, - name: Optional[str] = None, - destination_id: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> reservation.Assignment: - r"""Moves an assignment under a new reservation. - - This differs from removing an existing assignment and - recreating a new one by providing a transactional change - that ensures an assignee always has an associated - reservation. - - .. 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 bigquery_reservation_v1 - - async def sample_move_assignment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.MoveAssignmentRequest( - name="name_value", - ) - - # Make the request - response = await client.move_assignment(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.bigquery_reservation_v1.types.MoveAssignmentRequest, dict]]): - The request object. The request for - [ReservationService.MoveAssignment][google.cloud.bigquery.reservation.v1.ReservationService.MoveAssignment]. - - **Note**: "bigquery.reservationAssignments.create" - permission is required on the destination_id. - - **Note**: "bigquery.reservationAssignments.create" and - "bigquery.reservationAssignments.delete" permission are - required on the related assignee. - name (:class:`str`): - Required. The resource name of the assignment, e.g. - ``projects/myproject/locations/US/reservations/team1-prod/assignments/123`` - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - destination_id (:class:`str`): - The new reservation ID, e.g.: - ``projects/myotherproject/locations/US/reservations/team2-prod`` - - This corresponds to the ``destination_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.types.Assignment: - An assignment allows a project to - submit jobs of a certain type using - slots from the specified reservation. - - """ - # 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. - flattened_params = [name, destination_id] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.") - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.MoveAssignmentRequest): - request = reservation.MoveAssignmentRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if destination_id is not None: - request.destination_id = destination_id - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._client._transport._wrapped_methods[self._client._transport.move_assignment] - - # 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), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def update_assignment(self, - request: Optional[Union[reservation.UpdateAssignmentRequest, dict]] = None, - *, - assignment: Optional[reservation.Assignment] = 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, Union[str, bytes]]] = (), - ) -> reservation.Assignment: - r"""Updates an existing assignment. - - Only the ``priority`` field can be updated. - - .. 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 bigquery_reservation_v1 - - async def sample_update_assignment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.UpdateAssignmentRequest( - ) - - # Make the request - response = await client.update_assignment(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.bigquery_reservation_v1.types.UpdateAssignmentRequest, dict]]): - The request object. The request for - [ReservationService.UpdateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateAssignment]. - assignment (:class:`google.cloud.bigquery_reservation_v1.types.Assignment`): - Content of the assignment to update. - This corresponds to the ``assignment`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): - Standard field mask for the set of - fields to be updated. - - 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_async.AsyncRetry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.types.Assignment: - An assignment allows a project to - submit jobs of a certain type using - slots from the specified reservation. - - """ - # 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. - flattened_params = [assignment, update_mask] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.") - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.UpdateAssignmentRequest): - request = reservation.UpdateAssignmentRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if assignment is not None: - request.assignment = assignment - 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._client._transport._wrapped_methods[self._client._transport.update_assignment] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("assignment.name", request.assignment.name), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def get_bi_reservation(self, - request: Optional[Union[reservation.GetBiReservationRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> reservation.BiReservation: - r"""Retrieves a BI reservation. - - .. 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 bigquery_reservation_v1 - - async def sample_get_bi_reservation(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.GetBiReservationRequest( - name="name_value", - ) - - # Make the request - response = await client.get_bi_reservation(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.bigquery_reservation_v1.types.GetBiReservationRequest, dict]]): - The request object. A request to get a singleton BI - reservation. - name (:class:`str`): - Required. Name of the requested reservation, for - example: - ``projects/{project_id}/locations/{location_id}/biReservation`` - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.types.BiReservation: - Represents a BI Reservation. - """ - # 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. - flattened_params = [name] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.") - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.GetBiReservationRequest): - request = reservation.GetBiReservationRequest(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._client._transport._wrapped_methods[self._client._transport.get_bi_reservation] - - # 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), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def update_bi_reservation(self, - request: Optional[Union[reservation.UpdateBiReservationRequest, dict]] = None, - *, - bi_reservation: Optional[reservation.BiReservation] = 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, Union[str, bytes]]] = (), - ) -> reservation.BiReservation: - r"""Updates a BI reservation. - - Only fields specified in the ``field_mask`` are updated. - - A singleton BI reservation always exists with default size 0. In - order to reserve BI capacity it needs to be updated to an amount - greater than 0. In order to release BI capacity reservation size - must be set to 0. - - .. 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 bigquery_reservation_v1 - - async def sample_update_bi_reservation(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.UpdateBiReservationRequest( - ) - - # Make the request - response = await client.update_bi_reservation(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.bigquery_reservation_v1.types.UpdateBiReservationRequest, dict]]): - The request object. A request to update a BI reservation. - bi_reservation (:class:`google.cloud.bigquery_reservation_v1.types.BiReservation`): - A reservation to update. - This corresponds to the ``bi_reservation`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): - A list of fields to be updated in - this request. - - 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_async.AsyncRetry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.types.BiReservation: - Represents a BI Reservation. - """ - # 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. - flattened_params = [bi_reservation, update_mask] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.") - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.UpdateBiReservationRequest): - request = reservation.UpdateBiReservationRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if bi_reservation is not None: - request.bi_reservation = bi_reservation - 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._client._transport._wrapped_methods[self._client._transport.update_bi_reservation] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("bi_reservation.name", request.bi_reservation.name), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def get_iam_policy(self, - request: Optional[Union[iam_policy_pb2.GetIamPolicyRequest, dict]] = None, - *, - resource: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> policy_pb2.Policy: - r"""Gets the access control policy for a resource. May return: - - - A\ ``NOT_FOUND`` error if the resource doesn't exist or you - don't have the permission to view it. - - An empty policy if the resource exists but doesn't have a set - policy. - - Supported resources are: - - - Reservations - - ReservationAssignments - - To call this method, you must have the following Google IAM - permissions: - - - ``bigqueryreservation.reservations.getIamPolicy`` to get - policies on reservations. - - .. 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 bigquery_reservation_v1 - from google.iam.v1 import iam_policy_pb2 # type: ignore - - async def sample_get_iam_policy(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = iam_policy_pb2.GetIamPolicyRequest( - resource="resource_value", - ) - - # Make the request - response = await client.get_iam_policy(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]]): - The request object. Request message for ``GetIamPolicy`` method. - resource (:class:`str`): - REQUIRED: The resource for which the - policy is being requested. See the - operation documentation for the - appropriate value for this field. - - This corresponds to the ``resource`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.iam.v1.policy_pb2.Policy: - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. - - A Policy is a collection of bindings. A binding binds - one or more members, or principals, to a single role. - Principals can be user accounts, service accounts, - Google groups, and domains (such as G Suite). A role - is a named list of permissions; each role can be an - IAM predefined role or a user-created custom role. - - For some types of Google Cloud resources, a binding - can also specify a condition, which is a logical - expression that allows access to a resource only if - the expression evaluates to true. A condition can add - constraints based on attributes of the request, the - resource, or both. To learn which resources support - conditions in their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - - **JSON example:** - - :literal:`` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }`\ \` - - **YAML example:** - - :literal:`` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3`\ \` - - For a description of IAM and its features, see the - [IAM - documentation](https://cloud.google.com/iam/docs/). - - """ - # 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. - flattened_params = [resource] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.") - - # - The request isn't a proto-plus wrapped type, - # so it must be constructed via keyword expansion. - if isinstance(request, dict): - request = iam_policy_pb2.GetIamPolicyRequest(**request) - elif not request: - request = iam_policy_pb2.GetIamPolicyRequest(resource=resource) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._client._transport._wrapped_methods[self._client._transport.get_iam_policy] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("resource", request.resource), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def set_iam_policy(self, - request: Optional[Union[iam_policy_pb2.SetIamPolicyRequest, dict]] = None, - *, - resource: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> policy_pb2.Policy: - r"""Sets an access control policy for a resource. Replaces any - existing policy. - - Supported resources are: - - - Reservations - - To call this method, you must have the following Google IAM - permissions: - - - ``bigqueryreservation.reservations.setIamPolicy`` to set - policies on reservations. - - .. 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 bigquery_reservation_v1 - from google.iam.v1 import iam_policy_pb2 # type: ignore - - async def sample_set_iam_policy(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = iam_policy_pb2.SetIamPolicyRequest( - resource="resource_value", - ) - - # Make the request - response = await client.set_iam_policy(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]]): - The request object. Request message for ``SetIamPolicy`` method. - resource (:class:`str`): - REQUIRED: The resource for which the - policy is being specified. See the - operation documentation for the - appropriate value for this field. - - This corresponds to the ``resource`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.iam.v1.policy_pb2.Policy: - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. - - A Policy is a collection of bindings. A binding binds - one or more members, or principals, to a single role. - Principals can be user accounts, service accounts, - Google groups, and domains (such as G Suite). A role - is a named list of permissions; each role can be an - IAM predefined role or a user-created custom role. - - For some types of Google Cloud resources, a binding - can also specify a condition, which is a logical - expression that allows access to a resource only if - the expression evaluates to true. A condition can add - constraints based on attributes of the request, the - resource, or both. To learn which resources support - conditions in their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - - **JSON example:** - - :literal:`` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }`\ \` - - **YAML example:** - - :literal:`` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3`\ \` - - For a description of IAM and its features, see the - [IAM - documentation](https://cloud.google.com/iam/docs/). - - """ - # 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. - flattened_params = [resource] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.") - - # - The request isn't a proto-plus wrapped type, - # so it must be constructed via keyword expansion. - if isinstance(request, dict): - request = iam_policy_pb2.SetIamPolicyRequest(**request) - elif not request: - request = iam_policy_pb2.SetIamPolicyRequest(resource=resource) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._client._transport._wrapped_methods[self._client._transport.set_iam_policy] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("resource", request.resource), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def test_iam_permissions(self, - request: Optional[Union[iam_policy_pb2.TestIamPermissionsRequest, dict]] = None, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> iam_policy_pb2.TestIamPermissionsResponse: - r"""Gets your permissions on a resource. Returns an empty - set of permissions if the resource doesn't exist. - - Supported resources are: - - - Reservations - - No Google IAM permissions are required to call this - method. - - .. 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 bigquery_reservation_v1 - from google.iam.v1 import iam_policy_pb2 # type: ignore - - async def sample_test_iam_permissions(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = iam_policy_pb2.TestIamPermissionsRequest( - resource="resource_value", - permissions=['permissions_value1', 'permissions_value2'], - ) - - # Make the request - response = await client.test_iam_permissions(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]]): - The request object. Request message for ``TestIamPermissions`` method. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse: - Response message for TestIamPermissions 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 = iam_policy_pb2.TestIamPermissionsRequest(**request) - elif not request: - request = iam_policy_pb2.TestIamPermissionsRequest() - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._client._transport._wrapped_methods[self._client._transport.test_iam_permissions] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("resource", request.resource), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def create_reservation_group(self, - request: Optional[Union[reservation.CreateReservationGroupRequest, dict]] = None, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> reservation.ReservationGroup: - r"""Creates a new reservation group. - - .. 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 bigquery_reservation_v1 - - async def sample_create_reservation_group(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.CreateReservationGroupRequest( - parent="parent_value", - reservation_group_id="reservation_group_id_value", - ) - - # Make the request - response = await client.create_reservation_group(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.bigquery_reservation_v1.types.CreateReservationGroupRequest, dict]]): - The request object. The request for - [ReservationService.CreateReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.CreateReservationGroup]. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.types.ReservationGroup: - A reservation group is a container - for reservations. - - """ - # Create or coerce a protobuf request object. - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.CreateReservationGroupRequest): - request = reservation.CreateReservationGroupRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._client._transport._wrapped_methods[self._client._transport.create_reservation_group] - - # 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), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def get_reservation_group(self, - request: Optional[Union[reservation.GetReservationGroupRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> reservation.ReservationGroup: - r"""Returns information about the reservation group. - - .. 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 bigquery_reservation_v1 - - async def sample_get_reservation_group(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.GetReservationGroupRequest( - name="name_value", - ) - - # Make the request - response = await client.get_reservation_group(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.bigquery_reservation_v1.types.GetReservationGroupRequest, dict]]): - The request object. The request for - [ReservationService.GetReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.GetReservationGroup]. - name (:class:`str`): - Required. Resource name of the reservation group to - retrieve. E.g., - ``projects/myproject/locations/US/reservationGroups/team1-prod`` - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.types.ReservationGroup: - A reservation group is a container - for reservations. - - """ - # 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. - flattened_params = [name] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.") - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.GetReservationGroupRequest): - request = reservation.GetReservationGroupRequest(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._client._transport._wrapped_methods[self._client._transport.get_reservation_group] - - # 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), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def delete_reservation_group(self, - request: Optional[Union[reservation.DeleteReservationGroupRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> None: - r"""Deletes a reservation. Returns - ``google.rpc.Code.FAILED_PRECONDITION`` when reservation has - assignments. - - .. 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 bigquery_reservation_v1 - - async def sample_delete_reservation_group(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.DeleteReservationGroupRequest( - name="name_value", - ) - - # Make the request - await client.delete_reservation_group(request=request) - - Args: - request (Optional[Union[google.cloud.bigquery_reservation_v1.types.DeleteReservationGroupRequest, dict]]): - The request object. The request for - [ReservationService.DeleteReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservationGroup]. - name (:class:`str`): - Required. Resource name of the reservation group to - retrieve. E.g., - ``projects/myproject/locations/US/reservationGroups/team1-prod`` - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - """ - # 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. - flattened_params = [name] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.") - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.DeleteReservationGroupRequest): - request = reservation.DeleteReservationGroupRequest(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._client._transport._wrapped_methods[self._client._transport.delete_reservation_group] - - # 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), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # Send the request. - await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - async def list_reservation_groups(self, - request: Optional[Union[reservation.ListReservationGroupsRequest, dict]] = None, - *, - parent: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> pagers.ListReservationGroupsAsyncPager: - r"""Lists all the reservation groups for the project in - the specified location. - - .. 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 bigquery_reservation_v1 - - async def sample_list_reservation_groups(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.ListReservationGroupsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_reservation_groups(request=request) - - # Handle the response - async for response in page_result: - print(response) - - Args: - request (Optional[Union[google.cloud.bigquery_reservation_v1.types.ListReservationGroupsRequest, dict]]): - The request object. The request for - [ReservationService.ListReservationGroups][google.cloud.bigquery.reservation.v1.ReservationService.ListReservationGroups]. - parent (:class:`str`): - Required. The parent resource name containing project - and location, e.g.: ``projects/myproject/locations/US`` - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListReservationGroupsAsyncPager: - The response for - [ReservationService.ListReservationGroups][google.cloud.bigquery.reservation.v1.ReservationService.ListReservationGroups]. - - 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. - flattened_params = [parent] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.") - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.ListReservationGroupsRequest): - request = reservation.ListReservationGroupsRequest(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._client._transport._wrapped_methods[self._client._transport.list_reservation_groups] - - # 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), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # 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.ListReservationGroupsAsyncPager( - method=rpc, - request=request, - response=response, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def __aenter__(self) -> "ReservationServiceAsyncClient": - 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__) - -if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER - DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ - - -__all__ = ( - "ReservationServiceAsyncClient", -) diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/client.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/client.py deleted file mode 100644 index 19e7a6d485e6..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/client.py +++ /dev/null @@ -1,4203 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 http import HTTPStatus -import json -import logging as std_logging -import os -import re -from typing import Dict, Callable, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast -import warnings - -from google.cloud.bigquery_reservation_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 -import google.protobuf - -try: - OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None] -except AttributeError: # pragma: NO COVER - OptionalRetry = Union[retries.Retry, object, None] # type: ignore - -try: - from google.api_core import client_logging # type: ignore - CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER -except ImportError: # pragma: NO COVER - CLIENT_LOGGING_SUPPORTED = False - -_LOGGER = std_logging.getLogger(__name__) - -from google.cloud.bigquery_reservation_v1.services.reservation_service import pagers -from google.cloud.bigquery_reservation_v1.types import reservation -from google.cloud.bigquery_reservation_v1.types import reservation as gcbr_reservation -from google.iam.v1 import iam_policy_pb2 # type: ignore -from google.iam.v1 import policy_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 .transports.base import ReservationServiceTransport, DEFAULT_CLIENT_INFO -from .transports.grpc import ReservationServiceGrpcTransport -from .transports.grpc_asyncio import ReservationServiceGrpcAsyncIOTransport -from .transports.rest import ReservationServiceRestTransport - - -class ReservationServiceClientMeta(type): - """Metaclass for the ReservationService 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[ReservationServiceTransport]] - _transport_registry["grpc"] = ReservationServiceGrpcTransport - _transport_registry["grpc_asyncio"] = ReservationServiceGrpcAsyncIOTransport - _transport_registry["rest"] = ReservationServiceRestTransport - - def get_transport_class(cls, - label: Optional[str] = None, - ) -> Type[ReservationServiceTransport]: - """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 ReservationServiceClient(metaclass=ReservationServiceClientMeta): - """This API allows users to manage their BigQuery reservations. - - A reservation provides computational resource guarantees, in the - form of `slots `__, to - users. A slot is a unit of computational power in BigQuery, and - serves as the basic unit of parallelism. In a scan of a - multi-partitioned table, a single slot operates on a single - partition of the table. A reservation resource exists as a child - resource of the admin project and location, e.g.: - ``projects/myproject/locations/US/reservations/reservationName``. - - A capacity commitment is a way to purchase compute capacity for - BigQuery jobs (in the form of slots) with some committed period of - usage. A capacity commitment resource exists as a child resource of - the admin project and location, e.g.: - ``projects/myproject/locations/US/capacityCommitments/id``. - """ - - @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") - - # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. - DEFAULT_ENDPOINT = "bigqueryreservation.googleapis.com" - DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore - DEFAULT_ENDPOINT - ) - - _DEFAULT_ENDPOINT_TEMPLATE = "bigqueryreservation.{UNIVERSE_DOMAIN}" - _DEFAULT_UNIVERSE = "googleapis.com" - - @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: - ReservationServiceClient: 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: - ReservationServiceClient: 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) -> ReservationServiceTransport: - """Returns the transport used by the client instance. - - Returns: - ReservationServiceTransport: The transport used by the client - instance. - """ - return self._transport - - @staticmethod - def assignment_path(project: str,location: str,reservation: str,assignment: str,) -> str: - """Returns a fully-qualified assignment string.""" - return "projects/{project}/locations/{location}/reservations/{reservation}/assignments/{assignment}".format(project=project, location=location, reservation=reservation, assignment=assignment, ) - - @staticmethod - def parse_assignment_path(path: str) -> Dict[str,str]: - """Parses a assignment path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/reservations/(?P.+?)/assignments/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def bi_reservation_path(project: str,location: str,) -> str: - """Returns a fully-qualified bi_reservation string.""" - return "projects/{project}/locations/{location}/biReservation".format(project=project, location=location, ) - - @staticmethod - def parse_bi_reservation_path(path: str) -> Dict[str,str]: - """Parses a bi_reservation path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/biReservation$", path) - return m.groupdict() if m else {} - - @staticmethod - def capacity_commitment_path(project: str,location: str,capacity_commitment: str,) -> str: - """Returns a fully-qualified capacity_commitment string.""" - return "projects/{project}/locations/{location}/capacityCommitments/{capacity_commitment}".format(project=project, location=location, capacity_commitment=capacity_commitment, ) - - @staticmethod - def parse_capacity_commitment_path(path: str) -> Dict[str,str]: - """Parses a capacity_commitment path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/capacityCommitments/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def reservation_path(project: str,location: str,reservation: str,) -> str: - """Returns a fully-qualified reservation string.""" - return "projects/{project}/locations/{location}/reservations/{reservation}".format(project=project, location=location, reservation=reservation, ) - - @staticmethod - def parse_reservation_path(path: str) -> Dict[str,str]: - """Parses a reservation path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/reservations/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def reservation_group_path(project: str,location: str,reservation_group: str,) -> str: - """Returns a fully-qualified reservation_group string.""" - return "projects/{project}/locations/{location}/reservationGroups/{reservation_group}".format(project=project, location=location, reservation_group=reservation_group, ) - - @staticmethod - def parse_reservation_group_path(path: str) -> Dict[str,str]: - """Parses a reservation_group path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/reservationGroups/(?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): - """Deprecated. 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. - """ - - warnings.warn("get_mtls_endpoint_and_cert_source is deprecated. Use the api_endpoint property instead.", - DeprecationWarning) - 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 - - @staticmethod - def _read_environment_variables(): - """Returns the environment variables used by the client. - - Returns: - Tuple[bool, str, str]: returns the GOOGLE_API_USE_CLIENT_CERTIFICATE, - GOOGLE_API_USE_MTLS_ENDPOINT, and GOOGLE_CLOUD_UNIVERSE_DOMAIN environment variables. - - Raises: - ValueError: If GOOGLE_API_USE_CLIENT_CERTIFICATE is not - any of ["true", "false"]. - google.auth.exceptions.MutualTLSChannelError: If GOOGLE_API_USE_MTLS_ENDPOINT - is not any of ["auto", "never", "always"]. - """ - use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false").lower() - use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto").lower() - universe_domain_env = os.getenv("GOOGLE_CLOUD_UNIVERSE_DOMAIN") - 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`") - return use_client_cert == "true", use_mtls_endpoint, universe_domain_env - - @staticmethod - def _get_client_cert_source(provided_cert_source, use_cert_flag): - """Return the client cert source to be used by the client. - - Args: - provided_cert_source (bytes): The client certificate source provided. - use_cert_flag (bool): A flag indicating whether to use the client certificate. - - Returns: - bytes or None: The client cert source to be used by the client. - """ - client_cert_source = None - if use_cert_flag: - if provided_cert_source: - client_cert_source = provided_cert_source - elif mtls.has_default_client_cert_source(): - client_cert_source = mtls.default_client_cert_source() - return client_cert_source - - @staticmethod - def _get_api_endpoint(api_override, client_cert_source, universe_domain, use_mtls_endpoint): - """Return the API endpoint used by the client. - - Args: - api_override (str): The API endpoint override. If specified, this is always - the return value of this function and the other arguments are not used. - client_cert_source (bytes): The client certificate source used by the client. - universe_domain (str): The universe domain used by the client. - use_mtls_endpoint (str): How to use the mTLS endpoint, which depends also on the other parameters. - Possible values are "always", "auto", or "never". - - Returns: - str: The API endpoint to be used by the client. - """ - if api_override is not None: - api_endpoint = api_override - elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): - _default_universe = ReservationServiceClient._DEFAULT_UNIVERSE - if universe_domain != _default_universe: - raise MutualTLSChannelError(f"mTLS is not supported in any universe other than {_default_universe}.") - api_endpoint = ReservationServiceClient.DEFAULT_MTLS_ENDPOINT - else: - api_endpoint = ReservationServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=universe_domain) - return api_endpoint - - @staticmethod - def _get_universe_domain(client_universe_domain: Optional[str], universe_domain_env: Optional[str]) -> str: - """Return the universe domain used by the client. - - Args: - client_universe_domain (Optional[str]): The universe domain configured via the client options. - universe_domain_env (Optional[str]): The universe domain configured via the "GOOGLE_CLOUD_UNIVERSE_DOMAIN" environment variable. - - Returns: - str: The universe domain to be used by the client. - - Raises: - ValueError: If the universe domain is an empty string. - """ - universe_domain = ReservationServiceClient._DEFAULT_UNIVERSE - if client_universe_domain is not None: - universe_domain = client_universe_domain - elif universe_domain_env is not None: - universe_domain = universe_domain_env - if len(universe_domain.strip()) == 0: - raise ValueError("Universe Domain cannot be an empty string.") - return universe_domain - - def _validate_universe_domain(self): - """Validates client's and credentials' universe domains are consistent. - - Returns: - bool: True iff the configured universe domain is valid. - - Raises: - ValueError: If the configured universe domain is not valid. - """ - - # NOTE (b/349488459): universe validation is disabled until further notice. - return True - - def _add_cred_info_for_auth_errors( - self, - error: core_exceptions.GoogleAPICallError - ) -> None: - """Adds credential info string to error details for 401/403/404 errors. - - Args: - error (google.api_core.exceptions.GoogleAPICallError): The error to add the cred info. - """ - if error.code not in [HTTPStatus.UNAUTHORIZED, HTTPStatus.FORBIDDEN, HTTPStatus.NOT_FOUND]: - return - - cred = self._transport._credentials - - # get_cred_info is only available in google-auth>=2.35.0 - if not hasattr(cred, "get_cred_info"): - return - - # ignore the type check since pypy test fails when get_cred_info - # is not available - cred_info = cred.get_cred_info() # type: ignore - if cred_info and hasattr(error._details, "append"): - error._details.append(json.dumps(cred_info)) - - @property - def api_endpoint(self): - """Return the API endpoint used by the client instance. - - Returns: - str: The API endpoint used by the client instance. - """ - return self._api_endpoint - - @property - def universe_domain(self) -> str: - """Return the universe domain used by the client instance. - - Returns: - str: The universe domain used by the client instance. - """ - return self._universe_domain - - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Optional[Union[str, ReservationServiceTransport, Callable[..., ReservationServiceTransport]]] = None, - client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the reservation service 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 (Optional[Union[str,ReservationServiceTransport,Callable[..., ReservationServiceTransport]]]): - The transport to use, or a Callable that constructs and returns a new transport. - If a Callable is given, it will be called with the same set of initialization - arguments as used in the ReservationServiceTransport constructor. - 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. - - 1. The ``api_endpoint`` property can be used to override the - default endpoint provided by the client when ``transport`` is - not explicitly provided. Only if this property is not set and - ``transport`` was not explicitly provided, the endpoint is - determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment - variable, which have one of the following values: - "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). - - 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable - is "true", then the ``client_cert_source`` property can be used - to provide a client certificate for mTLS 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. - - 3. The ``universe_domain`` property can be used to override the - default "googleapis.com" universe. Note that the ``api_endpoint`` - property still takes precedence; and ``universe_domain`` is - currently not supported for mTLS. - - 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. - """ - self._client_options = client_options - if isinstance(self._client_options, dict): - self._client_options = client_options_lib.from_dict(self._client_options) - if self._client_options is None: - self._client_options = client_options_lib.ClientOptions() - self._client_options = cast(client_options_lib.ClientOptions, self._client_options) - - universe_domain_opt = getattr(self._client_options, 'universe_domain', None) - - self._use_client_cert, self._use_mtls_endpoint, self._universe_domain_env = ReservationServiceClient._read_environment_variables() - self._client_cert_source = ReservationServiceClient._get_client_cert_source(self._client_options.client_cert_source, self._use_client_cert) - self._universe_domain = ReservationServiceClient._get_universe_domain(universe_domain_opt, self._universe_domain_env) - self._api_endpoint = None # updated below, depending on `transport` - - # Initialize the universe domain validation. - self._is_universe_domain_valid = False - - if CLIENT_LOGGING_SUPPORTED: # pragma: NO COVER - # Setup logging. - client_logging.initialize_logging() - - api_key_value = getattr(self._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. - transport_provided = isinstance(transport, ReservationServiceTransport) - if transport_provided: - # transport is a ReservationServiceTransport instance. - if credentials or self._client_options.credentials_file or api_key_value: - raise ValueError("When providing a transport instance, " - "provide its credentials directly.") - if self._client_options.scopes: - raise ValueError( - "When providing a transport instance, provide its scopes " - "directly." - ) - self._transport = cast(ReservationServiceTransport, transport) - self._api_endpoint = self._transport.host - - self._api_endpoint = (self._api_endpoint or - ReservationServiceClient._get_api_endpoint( - self._client_options.api_endpoint, - self._client_cert_source, - self._universe_domain, - self._use_mtls_endpoint)) - - if not transport_provided: - 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_init: Union[Type[ReservationServiceTransport], Callable[..., ReservationServiceTransport]] = ( - ReservationServiceClient.get_transport_class(transport) - if isinstance(transport, str) or transport is None - else cast(Callable[..., ReservationServiceTransport], transport) - ) - # initialize with the provided callable or the passed in class - self._transport = transport_init( - credentials=credentials, - credentials_file=self._client_options.credentials_file, - host=self._api_endpoint, - scopes=self._client_options.scopes, - client_cert_source_for_mtls=self._client_cert_source, - quota_project_id=self._client_options.quota_project_id, - client_info=client_info, - always_use_jwt_access=True, - api_audience=self._client_options.api_audience, - ) - - if "async" not in str(self._transport): - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(std_logging.DEBUG): # pragma: NO COVER - _LOGGER.debug( - "Created client `google.cloud.bigquery.reservation_v1.ReservationServiceClient`.", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "universeDomain": getattr(self._transport._credentials, "universe_domain", ""), - "credentialsType": f"{type(self._transport._credentials).__module__}.{type(self._transport._credentials).__qualname__}", - "credentialsInfo": getattr(self.transport._credentials, "get_cred_info", lambda: None)(), - } if hasattr(self._transport, "_credentials") else { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "credentialsType": None, - } - ) - - def create_reservation(self, - request: Optional[Union[gcbr_reservation.CreateReservationRequest, dict]] = None, - *, - parent: Optional[str] = None, - reservation: Optional[gcbr_reservation.Reservation] = None, - reservation_id: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> gcbr_reservation.Reservation: - r"""Creates a new reservation 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 bigquery_reservation_v1 - - def sample_create_reservation(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.CreateReservationRequest( - parent="parent_value", - ) - - # Make the request - response = client.create_reservation(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.CreateReservationRequest, dict]): - The request object. The request for - [ReservationService.CreateReservation][google.cloud.bigquery.reservation.v1.ReservationService.CreateReservation]. - parent (str): - Required. Project, location. E.g., - ``projects/myproject/locations/US`` - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - reservation (google.cloud.bigquery_reservation_v1.types.Reservation): - Definition of the new reservation to - create. - - This corresponds to the ``reservation`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - reservation_id (str): - The reservation ID. It must only - contain lower case alphanumeric - characters or dashes. It must start with - a letter and must not end with a dash. - Its maximum length is 64 characters. - - This corresponds to the ``reservation_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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.types.Reservation: - A reservation is a mechanism used to - guarantee slots to users. - - """ - # 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. - flattened_params = [parent, reservation, reservation_id] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.') - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, gcbr_reservation.CreateReservationRequest): - request = gcbr_reservation.CreateReservationRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if reservation is not None: - request.reservation = reservation - if reservation_id is not None: - request.reservation_id = reservation_id - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.create_reservation] - - # 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), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def list_reservations(self, - request: Optional[Union[reservation.ListReservationsRequest, dict]] = None, - *, - parent: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> pagers.ListReservationsPager: - r"""Lists all the reservations for the project in the - specified location. - - .. 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 bigquery_reservation_v1 - - def sample_list_reservations(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.ListReservationsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_reservations(request=request) - - # Handle the response - for response in page_result: - print(response) - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.ListReservationsRequest, dict]): - The request object. The request for - [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations]. - parent (str): - Required. The parent resource name containing project - and location, e.g.: ``projects/myproject/locations/US`` - - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListReservationsPager: - The response for - [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations]. - - 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. - flattened_params = [parent] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.') - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.ListReservationsRequest): - request = reservation.ListReservationsRequest(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_reservations] - - # 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), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # 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.ListReservationsPager( - method=rpc, - request=request, - response=response, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_reservation(self, - request: Optional[Union[reservation.GetReservationRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> reservation.Reservation: - r"""Returns information about the reservation. - - .. 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 bigquery_reservation_v1 - - def sample_get_reservation(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.GetReservationRequest( - name="name_value", - ) - - # Make the request - response = client.get_reservation(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.GetReservationRequest, dict]): - The request object. The request for - [ReservationService.GetReservation][google.cloud.bigquery.reservation.v1.ReservationService.GetReservation]. - name (str): - Required. Resource name of the reservation to retrieve. - E.g., - ``projects/myproject/locations/US/reservations/team1-prod`` - - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.types.Reservation: - A reservation is a mechanism used to - guarantee slots to users. - - """ - # 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. - flattened_params = [name] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.') - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.GetReservationRequest): - request = reservation.GetReservationRequest(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_reservation] - - # 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), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def delete_reservation(self, - request: Optional[Union[reservation.DeleteReservationRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> None: - r"""Deletes a reservation. Returns - ``google.rpc.Code.FAILED_PRECONDITION`` when reservation has - assignments. - - .. 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 bigquery_reservation_v1 - - def sample_delete_reservation(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.DeleteReservationRequest( - name="name_value", - ) - - # Make the request - client.delete_reservation(request=request) - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.DeleteReservationRequest, dict]): - The request object. The request for - [ReservationService.DeleteReservation][google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservation]. - name (str): - Required. Resource name of the reservation to retrieve. - E.g., - ``projects/myproject/locations/US/reservations/team1-prod`` - - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - """ - # 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. - flattened_params = [name] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.') - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.DeleteReservationRequest): - request = reservation.DeleteReservationRequest(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_reservation] - - # 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), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # Send the request. - rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - def update_reservation(self, - request: Optional[Union[gcbr_reservation.UpdateReservationRequest, dict]] = None, - *, - reservation: Optional[gcbr_reservation.Reservation] = 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, Union[str, bytes]]] = (), - ) -> gcbr_reservation.Reservation: - r"""Updates an existing reservation 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 bigquery_reservation_v1 - - def sample_update_reservation(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.UpdateReservationRequest( - ) - - # Make the request - response = client.update_reservation(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.UpdateReservationRequest, dict]): - The request object. The request for - [ReservationService.UpdateReservation][google.cloud.bigquery.reservation.v1.ReservationService.UpdateReservation]. - reservation (google.cloud.bigquery_reservation_v1.types.Reservation): - Content of the reservation to update. - This corresponds to the ``reservation`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Standard field mask for the set of - fields to be updated. - - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.types.Reservation: - A reservation is a mechanism used to - guarantee slots to users. - - """ - # 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. - flattened_params = [reservation, update_mask] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.') - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, gcbr_reservation.UpdateReservationRequest): - request = gcbr_reservation.UpdateReservationRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if reservation is not None: - request.reservation = reservation - 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_reservation] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("reservation.name", request.reservation.name), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def failover_reservation(self, - request: Optional[Union[reservation.FailoverReservationRequest, dict]] = None, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> reservation.Reservation: - r"""Fail over a reservation to the secondary location. The operation - should be done in the current secondary location, which will be - promoted to the new primary location for the reservation. - Attempting to failover a reservation in the current primary - location will fail with the error code - ``google.rpc.Code.FAILED_PRECONDITION``. - - .. 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 bigquery_reservation_v1 - - def sample_failover_reservation(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.FailoverReservationRequest( - name="name_value", - ) - - # Make the request - response = client.failover_reservation(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.FailoverReservationRequest, dict]): - The request object. The request for - ReservationService.FailoverReservation. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.types.Reservation: - A reservation is a mechanism used to - guarantee slots to users. - - """ - # Create or coerce a protobuf request object. - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.FailoverReservationRequest): - request = reservation.FailoverReservationRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.failover_reservation] - - # 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), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def create_capacity_commitment(self, - request: Optional[Union[reservation.CreateCapacityCommitmentRequest, dict]] = None, - *, - parent: Optional[str] = None, - capacity_commitment: Optional[reservation.CapacityCommitment] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> reservation.CapacityCommitment: - r"""Creates a new capacity commitment 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 bigquery_reservation_v1 - - def sample_create_capacity_commitment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.CreateCapacityCommitmentRequest( - parent="parent_value", - ) - - # Make the request - response = client.create_capacity_commitment(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.CreateCapacityCommitmentRequest, dict]): - The request object. The request for - [ReservationService.CreateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.CreateCapacityCommitment]. - parent (str): - Required. Resource name of the parent reservation. E.g., - ``projects/myproject/locations/US`` - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - capacity_commitment (google.cloud.bigquery_reservation_v1.types.CapacityCommitment): - Content of the capacity commitment to - create. - - This corresponds to the ``capacity_commitment`` 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.types.CapacityCommitment: - Capacity commitment is a way to - purchase compute capacity for BigQuery - jobs (in the form of slots) with some - committed period of usage. Annual - commitments renew by default. - Commitments can be removed after their - commitment end time passes. - - In order to remove annual commitment, - its plan needs to be changed to monthly - or flex first. - - A capacity commitment resource exists as - a child resource of the admin project. - - """ - # 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. - flattened_params = [parent, capacity_commitment] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.') - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.CreateCapacityCommitmentRequest): - request = reservation.CreateCapacityCommitmentRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if capacity_commitment is not None: - request.capacity_commitment = capacity_commitment - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.create_capacity_commitment] - - # 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), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def list_capacity_commitments(self, - request: Optional[Union[reservation.ListCapacityCommitmentsRequest, dict]] = None, - *, - parent: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> pagers.ListCapacityCommitmentsPager: - r"""Lists all the capacity commitments for the admin - 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 bigquery_reservation_v1 - - def sample_list_capacity_commitments(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.ListCapacityCommitmentsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_capacity_commitments(request=request) - - # Handle the response - for response in page_result: - print(response) - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsRequest, dict]): - The request object. The request for - [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments]. - parent (str): - Required. Resource name of the parent reservation. E.g., - ``projects/myproject/locations/US`` - - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListCapacityCommitmentsPager: - The response for - [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments]. - - 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. - flattened_params = [parent] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.') - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.ListCapacityCommitmentsRequest): - request = reservation.ListCapacityCommitmentsRequest(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_capacity_commitments] - - # 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), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # 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.ListCapacityCommitmentsPager( - method=rpc, - request=request, - response=response, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_capacity_commitment(self, - request: Optional[Union[reservation.GetCapacityCommitmentRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> reservation.CapacityCommitment: - r"""Returns information about the capacity commitment. - - .. 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 bigquery_reservation_v1 - - def sample_get_capacity_commitment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.GetCapacityCommitmentRequest( - name="name_value", - ) - - # Make the request - response = client.get_capacity_commitment(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.GetCapacityCommitmentRequest, dict]): - The request object. The request for - [ReservationService.GetCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitment]. - name (str): - Required. Resource name of the capacity commitment to - retrieve. E.g., - ``projects/myproject/locations/US/capacityCommitments/123`` - - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.types.CapacityCommitment: - Capacity commitment is a way to - purchase compute capacity for BigQuery - jobs (in the form of slots) with some - committed period of usage. Annual - commitments renew by default. - Commitments can be removed after their - commitment end time passes. - - In order to remove annual commitment, - its plan needs to be changed to monthly - or flex first. - - A capacity commitment resource exists as - a child resource of the admin project. - - """ - # 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. - flattened_params = [name] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.') - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.GetCapacityCommitmentRequest): - request = reservation.GetCapacityCommitmentRequest(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_capacity_commitment] - - # 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), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def delete_capacity_commitment(self, - request: Optional[Union[reservation.DeleteCapacityCommitmentRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> None: - r"""Deletes a capacity commitment. Attempting to delete capacity - commitment before its commitment_end_time will fail with the - error code ``google.rpc.Code.FAILED_PRECONDITION``. - - .. 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 bigquery_reservation_v1 - - def sample_delete_capacity_commitment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.DeleteCapacityCommitmentRequest( - name="name_value", - ) - - # Make the request - client.delete_capacity_commitment(request=request) - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.DeleteCapacityCommitmentRequest, dict]): - The request object. The request for - [ReservationService.DeleteCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteCapacityCommitment]. - name (str): - Required. Resource name of the capacity commitment to - delete. E.g., - ``projects/myproject/locations/US/capacityCommitments/123`` - - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - """ - # 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. - flattened_params = [name] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.') - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.DeleteCapacityCommitmentRequest): - request = reservation.DeleteCapacityCommitmentRequest(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_capacity_commitment] - - # 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), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # Send the request. - rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - def update_capacity_commitment(self, - request: Optional[Union[reservation.UpdateCapacityCommitmentRequest, dict]] = None, - *, - capacity_commitment: Optional[reservation.CapacityCommitment] = 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, Union[str, bytes]]] = (), - ) -> reservation.CapacityCommitment: - r"""Updates an existing capacity commitment. - - Only ``plan`` and ``renewal_plan`` fields can be updated. - - Plan can only be changed to a plan of a longer commitment - period. Attempting to change to a plan with shorter commitment - period will fail with the error code - ``google.rpc.Code.FAILED_PRECONDITION``. - - .. 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 bigquery_reservation_v1 - - def sample_update_capacity_commitment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.UpdateCapacityCommitmentRequest( - ) - - # Make the request - response = client.update_capacity_commitment(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.UpdateCapacityCommitmentRequest, dict]): - The request object. The request for - [ReservationService.UpdateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateCapacityCommitment]. - capacity_commitment (google.cloud.bigquery_reservation_v1.types.CapacityCommitment): - Content of the capacity commitment to - update. - - This corresponds to the ``capacity_commitment`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Standard field mask for the set of - fields to be updated. - - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.types.CapacityCommitment: - Capacity commitment is a way to - purchase compute capacity for BigQuery - jobs (in the form of slots) with some - committed period of usage. Annual - commitments renew by default. - Commitments can be removed after their - commitment end time passes. - - In order to remove annual commitment, - its plan needs to be changed to monthly - or flex first. - - A capacity commitment resource exists as - a child resource of the admin project. - - """ - # 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. - flattened_params = [capacity_commitment, update_mask] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.') - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.UpdateCapacityCommitmentRequest): - request = reservation.UpdateCapacityCommitmentRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if capacity_commitment is not None: - request.capacity_commitment = capacity_commitment - 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_capacity_commitment] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("capacity_commitment.name", request.capacity_commitment.name), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def split_capacity_commitment(self, - request: Optional[Union[reservation.SplitCapacityCommitmentRequest, dict]] = None, - *, - name: Optional[str] = None, - slot_count: Optional[int] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> reservation.SplitCapacityCommitmentResponse: - r"""Splits capacity commitment to two commitments of the same plan - and ``commitment_end_time``. - - A common use case is to enable downgrading commitments. - - For example, in order to downgrade from 10000 slots to 8000, you - might split a 10000 capacity commitment into commitments of 2000 - and 8000. Then, you delete the first one after the commitment - end time passes. - - .. 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 bigquery_reservation_v1 - - def sample_split_capacity_commitment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.SplitCapacityCommitmentRequest( - name="name_value", - ) - - # Make the request - response = client.split_capacity_commitment(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.SplitCapacityCommitmentRequest, dict]): - The request object. The request for - [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment]. - name (str): - Required. The resource name e.g.,: - ``projects/myproject/locations/US/capacityCommitments/123`` - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - slot_count (int): - Number of slots in the capacity - commitment after the split. - - This corresponds to the ``slot_count`` 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.types.SplitCapacityCommitmentResponse: - The response for - [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment]. - - """ - # 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. - flattened_params = [name, slot_count] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.') - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.SplitCapacityCommitmentRequest): - request = reservation.SplitCapacityCommitmentRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if slot_count is not None: - request.slot_count = slot_count - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.split_capacity_commitment] - - # 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), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def merge_capacity_commitments(self, - request: Optional[Union[reservation.MergeCapacityCommitmentsRequest, dict]] = None, - *, - parent: Optional[str] = None, - capacity_commitment_ids: Optional[MutableSequence[str]] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> reservation.CapacityCommitment: - r"""Merges capacity commitments of the same plan into a single - commitment. - - The resulting capacity commitment has the greater - commitment_end_time out of the to-be-merged capacity - commitments. - - Attempting to merge capacity commitments of different plan will - fail with the error code - ``google.rpc.Code.FAILED_PRECONDITION``. - - .. 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 bigquery_reservation_v1 - - def sample_merge_capacity_commitments(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.MergeCapacityCommitmentsRequest( - ) - - # Make the request - response = client.merge_capacity_commitments(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.MergeCapacityCommitmentsRequest, dict]): - The request object. The request for - [ReservationService.MergeCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.MergeCapacityCommitments]. - parent (str): - Parent resource that identifies admin project and - location e.g., ``projects/myproject/locations/us`` - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - capacity_commitment_ids (MutableSequence[str]): - Ids of capacity commitments to merge. - These capacity commitments must exist - under admin project and location - specified in the parent. - ID is the last portion of capacity - commitment name e.g., 'abc' for - projects/myproject/locations/US/capacityCommitments/abc - - This corresponds to the ``capacity_commitment_ids`` 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.types.CapacityCommitment: - Capacity commitment is a way to - purchase compute capacity for BigQuery - jobs (in the form of slots) with some - committed period of usage. Annual - commitments renew by default. - Commitments can be removed after their - commitment end time passes. - - In order to remove annual commitment, - its plan needs to be changed to monthly - or flex first. - - A capacity commitment resource exists as - a child resource of the admin project. - - """ - # 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. - flattened_params = [parent, capacity_commitment_ids] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.') - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.MergeCapacityCommitmentsRequest): - request = reservation.MergeCapacityCommitmentsRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if capacity_commitment_ids is not None: - request.capacity_commitment_ids = capacity_commitment_ids - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.merge_capacity_commitments] - - # 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), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def create_assignment(self, - request: Optional[Union[reservation.CreateAssignmentRequest, dict]] = None, - *, - parent: Optional[str] = None, - assignment: Optional[reservation.Assignment] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> reservation.Assignment: - r"""Creates an assignment object which allows the given project to - submit jobs of a certain type using slots from the specified - reservation. - - Currently a resource (project, folder, organization) can only - have one assignment per each (job_type, location) combination, - and that reservation will be used for all jobs of the matching - type. - - Different assignments can be created on different levels of the - projects, folders or organization hierarchy. During query - execution, the assignment is looked up at the project, folder - and organization levels in that order. The first assignment - found is applied to the query. - - When creating assignments, it does not matter if other - assignments exist at higher levels. - - Example: - - - The organization ``organizationA`` contains two projects, - ``project1`` and ``project2``. - - Assignments for all three entities (``organizationA``, - ``project1``, and ``project2``) could all be created and - mapped to the same or different reservations. - - "None" assignments represent an absence of the assignment. - Projects assigned to None use on-demand pricing. To create a - "None" assignment, use "none" as a reservation_id in the parent. - Example parent: - ``projects/myproject/locations/US/reservations/none``. - - Returns ``google.rpc.Code.PERMISSION_DENIED`` if user does not - have 'bigquery.admin' permissions on the project using the - reservation and the project that owns this reservation. - - Returns ``google.rpc.Code.INVALID_ARGUMENT`` when location of - the assignment does not match location of the reservation. - - .. 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 bigquery_reservation_v1 - - def sample_create_assignment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.CreateAssignmentRequest( - parent="parent_value", - ) - - # Make the request - response = client.create_assignment(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.CreateAssignmentRequest, dict]): - The request object. The request for - [ReservationService.CreateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.CreateAssignment]. - Note: "bigquery.reservationAssignments.create" - permission is required on the related assignee. - parent (str): - Required. The parent resource name of the assignment - E.g. - ``projects/myproject/locations/US/reservations/team1-prod`` - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - assignment (google.cloud.bigquery_reservation_v1.types.Assignment): - Assignment resource to create. - This corresponds to the ``assignment`` 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.types.Assignment: - An assignment allows a project to - submit jobs of a certain type using - slots from the specified reservation. - - """ - # 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. - flattened_params = [parent, assignment] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.') - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.CreateAssignmentRequest): - request = reservation.CreateAssignmentRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if assignment is not None: - request.assignment = assignment - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.create_assignment] - - # 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), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def list_assignments(self, - request: Optional[Union[reservation.ListAssignmentsRequest, dict]] = None, - *, - parent: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> pagers.ListAssignmentsPager: - r"""Lists assignments. - - Only explicitly created assignments will be returned. - - Example: - - - Organization ``organizationA`` contains two projects, - ``project1`` and ``project2``. - - Reservation ``res1`` exists and was created previously. - - CreateAssignment was used previously to define the following - associations between entities and reservations: - ```` and ```` - - In this example, ListAssignments will just return the above two - assignments for reservation ``res1``, and no expansion/merge - will happen. - - The wildcard "-" can be used for reservations in the request. In - that case all assignments belongs to the specified project and - location will be listed. - - **Note** "-" cannot be used for projects nor locations. - - .. 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 bigquery_reservation_v1 - - def sample_list_assignments(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.ListAssignmentsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_assignments(request=request) - - # Handle the response - for response in page_result: - print(response) - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.ListAssignmentsRequest, dict]): - The request object. The request for - [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments]. - parent (str): - Required. The parent resource name e.g.: - - ``projects/myproject/locations/US/reservations/team1-prod`` - - Or: - - ``projects/myproject/locations/US/reservations/-`` - - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListAssignmentsPager: - The response for - [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments]. - - 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. - flattened_params = [parent] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.') - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.ListAssignmentsRequest): - request = reservation.ListAssignmentsRequest(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_assignments] - - # 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), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # 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.ListAssignmentsPager( - method=rpc, - request=request, - response=response, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def delete_assignment(self, - request: Optional[Union[reservation.DeleteAssignmentRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> None: - r"""Deletes a assignment. No expansion will happen. - - Example: - - - Organization ``organizationA`` contains two projects, - ``project1`` and ``project2``. - - Reservation ``res1`` exists and was created previously. - - CreateAssignment was used previously to define the following - associations between entities and reservations: - ```` and ```` - - In this example, deletion of the ```` - assignment won't affect the other assignment - ````. After said deletion, queries from - ``project1`` will still use ``res1`` while queries from - ``project2`` will switch to use on-demand mode. - - .. 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 bigquery_reservation_v1 - - def sample_delete_assignment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.DeleteAssignmentRequest( - name="name_value", - ) - - # Make the request - client.delete_assignment(request=request) - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.DeleteAssignmentRequest, dict]): - The request object. The request for - [ReservationService.DeleteAssignment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteAssignment]. - Note: "bigquery.reservationAssignments.delete" - permission is required on the related assignee. - name (str): - Required. Name of the resource, e.g. - ``projects/myproject/locations/US/reservations/team1-prod/assignments/123`` - - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - """ - # 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. - flattened_params = [name] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.') - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.DeleteAssignmentRequest): - request = reservation.DeleteAssignmentRequest(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_assignment] - - # 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), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # Send the request. - rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - def search_assignments(self, - request: Optional[Union[reservation.SearchAssignmentsRequest, dict]] = None, - *, - parent: Optional[str] = None, - query: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> pagers.SearchAssignmentsPager: - r"""Deprecated: Looks up assignments for a specified resource for a - particular region. If the request is about a project: - - 1. Assignments created on the project will be returned if they - exist. - 2. Otherwise assignments created on the closest ancestor will be - returned. - 3. Assignments for different JobTypes will all be returned. - - The same logic applies if the request is about a folder. - - If the request is about an organization, then assignments - created on the organization will be returned (organization - doesn't have ancestors). - - Comparing to ListAssignments, there are some behavior - differences: - - 1. permission on the assignee will be verified in this API. - 2. Hierarchy lookup (project->folder->organization) happens in - this API. - 3. Parent here is ``projects/*/locations/*``, instead of - ``projects/*/locations/*reservations/*``. - - **Note** "-" cannot be used for projects nor locations. - - .. 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 bigquery_reservation_v1 - - def sample_search_assignments(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.SearchAssignmentsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.search_assignments(request=request) - - # Handle the response - for response in page_result: - print(response) - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.SearchAssignmentsRequest, dict]): - The request object. The request for - [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. - Note: "bigquery.reservationAssignments.search" - permission is required on the related assignee. - parent (str): - Required. The resource name of the admin - project(containing project and location), e.g.: - ``projects/myproject/locations/US``. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - query (str): - Please specify resource name as assignee in the query. - - Examples: - - - ``assignee=projects/myproject`` - - ``assignee=folders/123`` - - ``assignee=organizations/456`` - - This corresponds to the ``query`` 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.SearchAssignmentsPager: - The response for - [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. - - Iterating over this object will yield results and - resolve additional pages automatically. - - """ - warnings.warn("ReservationServiceClient.search_assignments is deprecated", - DeprecationWarning) - - # 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. - flattened_params = [parent, query] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.') - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.SearchAssignmentsRequest): - request = reservation.SearchAssignmentsRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if query is not None: - request.query = query - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.search_assignments] - - # 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), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # 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.SearchAssignmentsPager( - method=rpc, - request=request, - response=response, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def search_all_assignments(self, - request: Optional[Union[reservation.SearchAllAssignmentsRequest, dict]] = None, - *, - parent: Optional[str] = None, - query: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> pagers.SearchAllAssignmentsPager: - r"""Looks up assignments for a specified resource for a particular - region. If the request is about a project: - - 1. Assignments created on the project will be returned if they - exist. - 2. Otherwise assignments created on the closest ancestor will be - returned. - 3. Assignments for different JobTypes will all be returned. - - The same logic applies if the request is about a folder. - - If the request is about an organization, then assignments - created on the organization will be returned (organization - doesn't have ancestors). - - Comparing to ListAssignments, there are some behavior - differences: - - 1. permission on the assignee will be verified in this API. - 2. Hierarchy lookup (project->folder->organization) happens in - this API. - 3. Parent here is ``projects/*/locations/*``, instead of - ``projects/*/locations/*reservations/*``. - - .. 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 bigquery_reservation_v1 - - def sample_search_all_assignments(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.SearchAllAssignmentsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.search_all_assignments(request=request) - - # Handle the response - for response in page_result: - print(response) - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsRequest, dict]): - The request object. The request for - [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. - Note: "bigquery.reservationAssignments.search" - permission is required on the related assignee. - parent (str): - Required. The resource name with location (project name - could be the wildcard '-'), e.g.: - ``projects/-/locations/US``. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - query (str): - Please specify resource name as assignee in the query. - - Examples: - - - ``assignee=projects/myproject`` - - ``assignee=folders/123`` - - ``assignee=organizations/456`` - - This corresponds to the ``query`` 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.SearchAllAssignmentsPager: - The response for - [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. - - 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. - flattened_params = [parent, query] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.') - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.SearchAllAssignmentsRequest): - request = reservation.SearchAllAssignmentsRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if query is not None: - request.query = query - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.search_all_assignments] - - # 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), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # 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.SearchAllAssignmentsPager( - method=rpc, - request=request, - response=response, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def move_assignment(self, - request: Optional[Union[reservation.MoveAssignmentRequest, dict]] = None, - *, - name: Optional[str] = None, - destination_id: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> reservation.Assignment: - r"""Moves an assignment under a new reservation. - - This differs from removing an existing assignment and - recreating a new one by providing a transactional change - that ensures an assignee always has an associated - reservation. - - .. 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 bigquery_reservation_v1 - - def sample_move_assignment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.MoveAssignmentRequest( - name="name_value", - ) - - # Make the request - response = client.move_assignment(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.MoveAssignmentRequest, dict]): - The request object. The request for - [ReservationService.MoveAssignment][google.cloud.bigquery.reservation.v1.ReservationService.MoveAssignment]. - - **Note**: "bigquery.reservationAssignments.create" - permission is required on the destination_id. - - **Note**: "bigquery.reservationAssignments.create" and - "bigquery.reservationAssignments.delete" permission are - required on the related assignee. - name (str): - Required. The resource name of the assignment, e.g. - ``projects/myproject/locations/US/reservations/team1-prod/assignments/123`` - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - destination_id (str): - The new reservation ID, e.g.: - ``projects/myotherproject/locations/US/reservations/team2-prod`` - - This corresponds to the ``destination_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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.types.Assignment: - An assignment allows a project to - submit jobs of a certain type using - slots from the specified reservation. - - """ - # 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. - flattened_params = [name, destination_id] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.') - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.MoveAssignmentRequest): - request = reservation.MoveAssignmentRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if destination_id is not None: - request.destination_id = destination_id - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.move_assignment] - - # 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), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def update_assignment(self, - request: Optional[Union[reservation.UpdateAssignmentRequest, dict]] = None, - *, - assignment: Optional[reservation.Assignment] = 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, Union[str, bytes]]] = (), - ) -> reservation.Assignment: - r"""Updates an existing assignment. - - Only the ``priority`` field can be updated. - - .. 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 bigquery_reservation_v1 - - def sample_update_assignment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.UpdateAssignmentRequest( - ) - - # Make the request - response = client.update_assignment(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.UpdateAssignmentRequest, dict]): - The request object. The request for - [ReservationService.UpdateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateAssignment]. - assignment (google.cloud.bigquery_reservation_v1.types.Assignment): - Content of the assignment to update. - This corresponds to the ``assignment`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Standard field mask for the set of - fields to be updated. - - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.types.Assignment: - An assignment allows a project to - submit jobs of a certain type using - slots from the specified reservation. - - """ - # 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. - flattened_params = [assignment, update_mask] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.') - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.UpdateAssignmentRequest): - request = reservation.UpdateAssignmentRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if assignment is not None: - request.assignment = assignment - 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_assignment] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("assignment.name", request.assignment.name), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_bi_reservation(self, - request: Optional[Union[reservation.GetBiReservationRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> reservation.BiReservation: - r"""Retrieves a BI reservation. - - .. 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 bigquery_reservation_v1 - - def sample_get_bi_reservation(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.GetBiReservationRequest( - name="name_value", - ) - - # Make the request - response = client.get_bi_reservation(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.GetBiReservationRequest, dict]): - The request object. A request to get a singleton BI - reservation. - name (str): - Required. Name of the requested reservation, for - example: - ``projects/{project_id}/locations/{location_id}/biReservation`` - - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.types.BiReservation: - Represents a BI Reservation. - """ - # 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. - flattened_params = [name] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.') - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.GetBiReservationRequest): - request = reservation.GetBiReservationRequest(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_bi_reservation] - - # 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), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def update_bi_reservation(self, - request: Optional[Union[reservation.UpdateBiReservationRequest, dict]] = None, - *, - bi_reservation: Optional[reservation.BiReservation] = 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, Union[str, bytes]]] = (), - ) -> reservation.BiReservation: - r"""Updates a BI reservation. - - Only fields specified in the ``field_mask`` are updated. - - A singleton BI reservation always exists with default size 0. In - order to reserve BI capacity it needs to be updated to an amount - greater than 0. In order to release BI capacity reservation size - must be set to 0. - - .. 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 bigquery_reservation_v1 - - def sample_update_bi_reservation(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.UpdateBiReservationRequest( - ) - - # Make the request - response = client.update_bi_reservation(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.UpdateBiReservationRequest, dict]): - The request object. A request to update a BI reservation. - bi_reservation (google.cloud.bigquery_reservation_v1.types.BiReservation): - A reservation to update. - This corresponds to the ``bi_reservation`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - A list of fields to be updated in - this request. - - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.types.BiReservation: - Represents a BI Reservation. - """ - # 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. - flattened_params = [bi_reservation, update_mask] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.') - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.UpdateBiReservationRequest): - request = reservation.UpdateBiReservationRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if bi_reservation is not None: - request.bi_reservation = bi_reservation - 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_bi_reservation] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("bi_reservation.name", request.bi_reservation.name), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_iam_policy(self, - request: Optional[Union[iam_policy_pb2.GetIamPolicyRequest, dict]] = None, - *, - resource: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> policy_pb2.Policy: - r"""Gets the access control policy for a resource. May return: - - - A\ ``NOT_FOUND`` error if the resource doesn't exist or you - don't have the permission to view it. - - An empty policy if the resource exists but doesn't have a set - policy. - - Supported resources are: - - - Reservations - - ReservationAssignments - - To call this method, you must have the following Google IAM - permissions: - - - ``bigqueryreservation.reservations.getIamPolicy`` to get - policies on reservations. - - .. 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 bigquery_reservation_v1 - from google.iam.v1 import iam_policy_pb2 # type: ignore - - def sample_get_iam_policy(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = iam_policy_pb2.GetIamPolicyRequest( - resource="resource_value", - ) - - # Make the request - response = client.get_iam_policy(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]): - The request object. Request message for ``GetIamPolicy`` method. - resource (str): - REQUIRED: The resource for which the - policy is being requested. See the - operation documentation for the - appropriate value for this field. - - This corresponds to the ``resource`` 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.iam.v1.policy_pb2.Policy: - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. - - A Policy is a collection of bindings. A binding binds - one or more members, or principals, to a single role. - Principals can be user accounts, service accounts, - Google groups, and domains (such as G Suite). A role - is a named list of permissions; each role can be an - IAM predefined role or a user-created custom role. - - For some types of Google Cloud resources, a binding - can also specify a condition, which is a logical - expression that allows access to a resource only if - the expression evaluates to true. A condition can add - constraints based on attributes of the request, the - resource, or both. To learn which resources support - conditions in their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - - **JSON example:** - - :literal:`` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }`\ \` - - **YAML example:** - - :literal:`` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3`\ \` - - For a description of IAM and its features, see the - [IAM - documentation](https://cloud.google.com/iam/docs/). - - """ - # 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. - flattened_params = [resource] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.') - - if isinstance(request, dict): - # - The request isn't a proto-plus wrapped type, - # so it must be constructed via keyword expansion. - request = iam_policy_pb2.GetIamPolicyRequest(**request) - elif not request: - # Null request, just make one. - request = iam_policy_pb2.GetIamPolicyRequest() - if resource is not None: - request.resource = resource - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.get_iam_policy] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("resource", request.resource), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def set_iam_policy(self, - request: Optional[Union[iam_policy_pb2.SetIamPolicyRequest, dict]] = None, - *, - resource: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> policy_pb2.Policy: - r"""Sets an access control policy for a resource. Replaces any - existing policy. - - Supported resources are: - - - Reservations - - To call this method, you must have the following Google IAM - permissions: - - - ``bigqueryreservation.reservations.setIamPolicy`` to set - policies on reservations. - - .. 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 bigquery_reservation_v1 - from google.iam.v1 import iam_policy_pb2 # type: ignore - - def sample_set_iam_policy(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = iam_policy_pb2.SetIamPolicyRequest( - resource="resource_value", - ) - - # Make the request - response = client.set_iam_policy(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]): - The request object. Request message for ``SetIamPolicy`` method. - resource (str): - REQUIRED: The resource for which the - policy is being specified. See the - operation documentation for the - appropriate value for this field. - - This corresponds to the ``resource`` 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.iam.v1.policy_pb2.Policy: - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. - - A Policy is a collection of bindings. A binding binds - one or more members, or principals, to a single role. - Principals can be user accounts, service accounts, - Google groups, and domains (such as G Suite). A role - is a named list of permissions; each role can be an - IAM predefined role or a user-created custom role. - - For some types of Google Cloud resources, a binding - can also specify a condition, which is a logical - expression that allows access to a resource only if - the expression evaluates to true. A condition can add - constraints based on attributes of the request, the - resource, or both. To learn which resources support - conditions in their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - - **JSON example:** - - :literal:`` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }`\ \` - - **YAML example:** - - :literal:`` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3`\ \` - - For a description of IAM and its features, see the - [IAM - documentation](https://cloud.google.com/iam/docs/). - - """ - # 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. - flattened_params = [resource] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.') - - if isinstance(request, dict): - # - The request isn't a proto-plus wrapped type, - # so it must be constructed via keyword expansion. - request = iam_policy_pb2.SetIamPolicyRequest(**request) - elif not request: - # Null request, just make one. - request = iam_policy_pb2.SetIamPolicyRequest() - if resource is not None: - request.resource = resource - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.set_iam_policy] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("resource", request.resource), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def test_iam_permissions(self, - request: Optional[Union[iam_policy_pb2.TestIamPermissionsRequest, dict]] = None, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> iam_policy_pb2.TestIamPermissionsResponse: - r"""Gets your permissions on a resource. Returns an empty - set of permissions if the resource doesn't exist. - - Supported resources are: - - - Reservations - - No Google IAM permissions are required to call this - method. - - .. 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 bigquery_reservation_v1 - from google.iam.v1 import iam_policy_pb2 # type: ignore - - def sample_test_iam_permissions(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = iam_policy_pb2.TestIamPermissionsRequest( - resource="resource_value", - permissions=['permissions_value1', 'permissions_value2'], - ) - - # Make the request - response = client.test_iam_permissions(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]): - The request object. Request message for ``TestIamPermissions`` 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse: - Response message for TestIamPermissions method. - """ - # Create or coerce a protobuf request object. - if isinstance(request, dict): - # - The request isn't a proto-plus wrapped type, - # so it must be constructed via keyword expansion. - request = iam_policy_pb2.TestIamPermissionsRequest(**request) - elif not request: - # Null request, just make one. - request = iam_policy_pb2.TestIamPermissionsRequest() - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.test_iam_permissions] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("resource", request.resource), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def create_reservation_group(self, - request: Optional[Union[reservation.CreateReservationGroupRequest, dict]] = None, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> reservation.ReservationGroup: - r"""Creates a new reservation group. - - .. 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 bigquery_reservation_v1 - - def sample_create_reservation_group(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.CreateReservationGroupRequest( - parent="parent_value", - reservation_group_id="reservation_group_id_value", - ) - - # Make the request - response = client.create_reservation_group(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.CreateReservationGroupRequest, dict]): - The request object. The request for - [ReservationService.CreateReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.CreateReservationGroup]. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.types.ReservationGroup: - A reservation group is a container - for reservations. - - """ - # Create or coerce a protobuf request object. - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.CreateReservationGroupRequest): - request = reservation.CreateReservationGroupRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.create_reservation_group] - - # 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), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_reservation_group(self, - request: Optional[Union[reservation.GetReservationGroupRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> reservation.ReservationGroup: - r"""Returns information about the reservation group. - - .. 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 bigquery_reservation_v1 - - def sample_get_reservation_group(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.GetReservationGroupRequest( - name="name_value", - ) - - # Make the request - response = client.get_reservation_group(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.GetReservationGroupRequest, dict]): - The request object. The request for - [ReservationService.GetReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.GetReservationGroup]. - name (str): - Required. Resource name of the reservation group to - retrieve. E.g., - ``projects/myproject/locations/US/reservationGroups/team1-prod`` - - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.types.ReservationGroup: - A reservation group is a container - for reservations. - - """ - # 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. - flattened_params = [name] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.') - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.GetReservationGroupRequest): - request = reservation.GetReservationGroupRequest(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_reservation_group] - - # 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), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def delete_reservation_group(self, - request: Optional[Union[reservation.DeleteReservationGroupRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> None: - r"""Deletes a reservation. Returns - ``google.rpc.Code.FAILED_PRECONDITION`` when reservation has - assignments. - - .. 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 bigquery_reservation_v1 - - def sample_delete_reservation_group(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.DeleteReservationGroupRequest( - name="name_value", - ) - - # Make the request - client.delete_reservation_group(request=request) - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.DeleteReservationGroupRequest, dict]): - The request object. The request for - [ReservationService.DeleteReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservationGroup]. - name (str): - Required. Resource name of the reservation group to - retrieve. E.g., - ``projects/myproject/locations/US/reservationGroups/team1-prod`` - - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - """ - # 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. - flattened_params = [name] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.') - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.DeleteReservationGroupRequest): - request = reservation.DeleteReservationGroupRequest(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_reservation_group] - - # 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), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # Send the request. - rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - def list_reservation_groups(self, - request: Optional[Union[reservation.ListReservationGroupsRequest, dict]] = None, - *, - parent: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> pagers.ListReservationGroupsPager: - r"""Lists all the reservation groups for the project in - the specified location. - - .. 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 bigquery_reservation_v1 - - def sample_list_reservation_groups(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.ListReservationGroupsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_reservation_groups(request=request) - - # Handle the response - for response in page_result: - print(response) - - Args: - request (Union[google.cloud.bigquery_reservation_v1.types.ListReservationGroupsRequest, dict]): - The request object. The request for - [ReservationService.ListReservationGroups][google.cloud.bigquery.reservation.v1.ReservationService.ListReservationGroups]. - parent (str): - Required. The parent resource name containing project - and location, e.g.: ``projects/myproject/locations/US`` - - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListReservationGroupsPager: - The response for - [ReservationService.ListReservationGroups][google.cloud.bigquery.reservation.v1.ReservationService.ListReservationGroups]. - - 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. - flattened_params = [parent] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - 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.') - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, reservation.ListReservationGroupsRequest): - request = reservation.ListReservationGroupsRequest(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_reservation_groups] - - # 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), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # 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.ListReservationGroupsPager( - method=rpc, - request=request, - response=response, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def __enter__(self) -> "ReservationServiceClient": - 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() - - - - - - - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - -if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER - DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ - -__all__ = ( - "ReservationServiceClient", -) diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/pagers.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/pagers.py deleted file mode 100644 index 62a3e9a5acb7..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/pagers.py +++ /dev/null @@ -1,861 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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.api_core import gapic_v1 -from google.api_core import retry as retries -from google.api_core import retry_async as retries_async -from typing import Any, AsyncIterator, Awaitable, Callable, Sequence, Tuple, Optional, Iterator, Union -try: - OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None] - OptionalAsyncRetry = Union[retries_async.AsyncRetry, gapic_v1.method._MethodDefault, None] -except AttributeError: # pragma: NO COVER - OptionalRetry = Union[retries.Retry, object, None] # type: ignore - OptionalAsyncRetry = Union[retries_async.AsyncRetry, object, None] # type: ignore - -from google.cloud.bigquery_reservation_v1.types import reservation - - -class ListReservationsPager: - """A pager for iterating through ``list_reservations`` requests. - - This class thinly wraps an initial - :class:`google.cloud.bigquery_reservation_v1.types.ListReservationsResponse` object, and - provides an ``__iter__`` method to iterate through its - ``reservations`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``ListReservations`` requests and continue to iterate - through the ``reservations`` field on the - corresponding responses. - - All the usual :class:`google.cloud.bigquery_reservation_v1.types.ListReservationsResponse` - 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[..., reservation.ListReservationsResponse], - request: reservation.ListReservationsRequest, - response: reservation.ListReservationsResponse, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()): - """Instantiate the pager. - - Args: - method (Callable): The method that was originally called, and - which instantiated this pager. - request (google.cloud.bigquery_reservation_v1.types.ListReservationsRequest): - The initial request object. - response (google.cloud.bigquery_reservation_v1.types.ListReservationsResponse): - The initial response object. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - """ - self._method = method - self._request = reservation.ListReservationsRequest(request) - self._response = response - self._retry = retry - self._timeout = timeout - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterator[reservation.ListReservationsResponse]: - yield self._response - while self._response.next_page_token: - self._request.page_token = self._response.next_page_token - self._response = self._method(self._request, retry=self._retry, timeout=self._timeout, metadata=self._metadata) - yield self._response - - def __iter__(self) -> Iterator[reservation.Reservation]: - for page in self.pages: - yield from page.reservations - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListReservationsAsyncPager: - """A pager for iterating through ``list_reservations`` requests. - - This class thinly wraps an initial - :class:`google.cloud.bigquery_reservation_v1.types.ListReservationsResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``reservations`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``ListReservations`` requests and continue to iterate - through the ``reservations`` field on the - corresponding responses. - - All the usual :class:`google.cloud.bigquery_reservation_v1.types.ListReservationsResponse` - 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[reservation.ListReservationsResponse]], - request: reservation.ListReservationsRequest, - response: reservation.ListReservationsResponse, - *, - retry: OptionalAsyncRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()): - """Instantiates the pager. - - Args: - method (Callable): The method that was originally called, and - which instantiated this pager. - request (google.cloud.bigquery_reservation_v1.types.ListReservationsRequest): - The initial request object. - response (google.cloud.bigquery_reservation_v1.types.ListReservationsResponse): - The initial response object. - retry (google.api_core.retry.AsyncRetry): Designation of what errors, - if any, should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - """ - self._method = method - self._request = reservation.ListReservationsRequest(request) - self._response = response - self._retry = retry - self._timeout = timeout - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterator[reservation.ListReservationsResponse]: - 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, retry=self._retry, timeout=self._timeout, metadata=self._metadata) - yield self._response - def __aiter__(self) -> AsyncIterator[reservation.Reservation]: - async def async_generator(): - async for page in self.pages: - for response in page.reservations: - yield response - - return async_generator() - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListCapacityCommitmentsPager: - """A pager for iterating through ``list_capacity_commitments`` requests. - - This class thinly wraps an initial - :class:`google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsResponse` object, and - provides an ``__iter__`` method to iterate through its - ``capacity_commitments`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``ListCapacityCommitments`` requests and continue to iterate - through the ``capacity_commitments`` field on the - corresponding responses. - - All the usual :class:`google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsResponse` - 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[..., reservation.ListCapacityCommitmentsResponse], - request: reservation.ListCapacityCommitmentsRequest, - response: reservation.ListCapacityCommitmentsResponse, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()): - """Instantiate the pager. - - Args: - method (Callable): The method that was originally called, and - which instantiated this pager. - request (google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsRequest): - The initial request object. - response (google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsResponse): - The initial response object. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - """ - self._method = method - self._request = reservation.ListCapacityCommitmentsRequest(request) - self._response = response - self._retry = retry - self._timeout = timeout - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterator[reservation.ListCapacityCommitmentsResponse]: - yield self._response - while self._response.next_page_token: - self._request.page_token = self._response.next_page_token - self._response = self._method(self._request, retry=self._retry, timeout=self._timeout, metadata=self._metadata) - yield self._response - - def __iter__(self) -> Iterator[reservation.CapacityCommitment]: - for page in self.pages: - yield from page.capacity_commitments - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListCapacityCommitmentsAsyncPager: - """A pager for iterating through ``list_capacity_commitments`` requests. - - This class thinly wraps an initial - :class:`google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``capacity_commitments`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``ListCapacityCommitments`` requests and continue to iterate - through the ``capacity_commitments`` field on the - corresponding responses. - - All the usual :class:`google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsResponse` - 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[reservation.ListCapacityCommitmentsResponse]], - request: reservation.ListCapacityCommitmentsRequest, - response: reservation.ListCapacityCommitmentsResponse, - *, - retry: OptionalAsyncRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()): - """Instantiates the pager. - - Args: - method (Callable): The method that was originally called, and - which instantiated this pager. - request (google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsRequest): - The initial request object. - response (google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsResponse): - The initial response object. - retry (google.api_core.retry.AsyncRetry): Designation of what errors, - if any, should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - """ - self._method = method - self._request = reservation.ListCapacityCommitmentsRequest(request) - self._response = response - self._retry = retry - self._timeout = timeout - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterator[reservation.ListCapacityCommitmentsResponse]: - 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, retry=self._retry, timeout=self._timeout, metadata=self._metadata) - yield self._response - def __aiter__(self) -> AsyncIterator[reservation.CapacityCommitment]: - async def async_generator(): - async for page in self.pages: - for response in page.capacity_commitments: - yield response - - return async_generator() - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListAssignmentsPager: - """A pager for iterating through ``list_assignments`` requests. - - This class thinly wraps an initial - :class:`google.cloud.bigquery_reservation_v1.types.ListAssignmentsResponse` object, and - provides an ``__iter__`` method to iterate through its - ``assignments`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``ListAssignments`` requests and continue to iterate - through the ``assignments`` field on the - corresponding responses. - - All the usual :class:`google.cloud.bigquery_reservation_v1.types.ListAssignmentsResponse` - 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[..., reservation.ListAssignmentsResponse], - request: reservation.ListAssignmentsRequest, - response: reservation.ListAssignmentsResponse, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()): - """Instantiate the pager. - - Args: - method (Callable): The method that was originally called, and - which instantiated this pager. - request (google.cloud.bigquery_reservation_v1.types.ListAssignmentsRequest): - The initial request object. - response (google.cloud.bigquery_reservation_v1.types.ListAssignmentsResponse): - The initial response object. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - """ - self._method = method - self._request = reservation.ListAssignmentsRequest(request) - self._response = response - self._retry = retry - self._timeout = timeout - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterator[reservation.ListAssignmentsResponse]: - yield self._response - while self._response.next_page_token: - self._request.page_token = self._response.next_page_token - self._response = self._method(self._request, retry=self._retry, timeout=self._timeout, metadata=self._metadata) - yield self._response - - def __iter__(self) -> Iterator[reservation.Assignment]: - for page in self.pages: - yield from page.assignments - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListAssignmentsAsyncPager: - """A pager for iterating through ``list_assignments`` requests. - - This class thinly wraps an initial - :class:`google.cloud.bigquery_reservation_v1.types.ListAssignmentsResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``assignments`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``ListAssignments`` requests and continue to iterate - through the ``assignments`` field on the - corresponding responses. - - All the usual :class:`google.cloud.bigquery_reservation_v1.types.ListAssignmentsResponse` - 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[reservation.ListAssignmentsResponse]], - request: reservation.ListAssignmentsRequest, - response: reservation.ListAssignmentsResponse, - *, - retry: OptionalAsyncRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()): - """Instantiates the pager. - - Args: - method (Callable): The method that was originally called, and - which instantiated this pager. - request (google.cloud.bigquery_reservation_v1.types.ListAssignmentsRequest): - The initial request object. - response (google.cloud.bigquery_reservation_v1.types.ListAssignmentsResponse): - The initial response object. - retry (google.api_core.retry.AsyncRetry): Designation of what errors, - if any, should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - """ - self._method = method - self._request = reservation.ListAssignmentsRequest(request) - self._response = response - self._retry = retry - self._timeout = timeout - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterator[reservation.ListAssignmentsResponse]: - 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, retry=self._retry, timeout=self._timeout, metadata=self._metadata) - yield self._response - def __aiter__(self) -> AsyncIterator[reservation.Assignment]: - async def async_generator(): - async for page in self.pages: - for response in page.assignments: - yield response - - return async_generator() - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class SearchAssignmentsPager: - """A pager for iterating through ``search_assignments`` requests. - - This class thinly wraps an initial - :class:`google.cloud.bigquery_reservation_v1.types.SearchAssignmentsResponse` object, and - provides an ``__iter__`` method to iterate through its - ``assignments`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``SearchAssignments`` requests and continue to iterate - through the ``assignments`` field on the - corresponding responses. - - All the usual :class:`google.cloud.bigquery_reservation_v1.types.SearchAssignmentsResponse` - 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[..., reservation.SearchAssignmentsResponse], - request: reservation.SearchAssignmentsRequest, - response: reservation.SearchAssignmentsResponse, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()): - """Instantiate the pager. - - Args: - method (Callable): The method that was originally called, and - which instantiated this pager. - request (google.cloud.bigquery_reservation_v1.types.SearchAssignmentsRequest): - The initial request object. - response (google.cloud.bigquery_reservation_v1.types.SearchAssignmentsResponse): - The initial response object. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - """ - self._method = method - self._request = reservation.SearchAssignmentsRequest(request) - self._response = response - self._retry = retry - self._timeout = timeout - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterator[reservation.SearchAssignmentsResponse]: - yield self._response - while self._response.next_page_token: - self._request.page_token = self._response.next_page_token - self._response = self._method(self._request, retry=self._retry, timeout=self._timeout, metadata=self._metadata) - yield self._response - - def __iter__(self) -> Iterator[reservation.Assignment]: - for page in self.pages: - yield from page.assignments - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class SearchAssignmentsAsyncPager: - """A pager for iterating through ``search_assignments`` requests. - - This class thinly wraps an initial - :class:`google.cloud.bigquery_reservation_v1.types.SearchAssignmentsResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``assignments`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``SearchAssignments`` requests and continue to iterate - through the ``assignments`` field on the - corresponding responses. - - All the usual :class:`google.cloud.bigquery_reservation_v1.types.SearchAssignmentsResponse` - 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[reservation.SearchAssignmentsResponse]], - request: reservation.SearchAssignmentsRequest, - response: reservation.SearchAssignmentsResponse, - *, - retry: OptionalAsyncRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()): - """Instantiates the pager. - - Args: - method (Callable): The method that was originally called, and - which instantiated this pager. - request (google.cloud.bigquery_reservation_v1.types.SearchAssignmentsRequest): - The initial request object. - response (google.cloud.bigquery_reservation_v1.types.SearchAssignmentsResponse): - The initial response object. - retry (google.api_core.retry.AsyncRetry): Designation of what errors, - if any, should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - """ - self._method = method - self._request = reservation.SearchAssignmentsRequest(request) - self._response = response - self._retry = retry - self._timeout = timeout - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterator[reservation.SearchAssignmentsResponse]: - 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, retry=self._retry, timeout=self._timeout, metadata=self._metadata) - yield self._response - def __aiter__(self) -> AsyncIterator[reservation.Assignment]: - async def async_generator(): - async for page in self.pages: - for response in page.assignments: - yield response - - return async_generator() - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class SearchAllAssignmentsPager: - """A pager for iterating through ``search_all_assignments`` requests. - - This class thinly wraps an initial - :class:`google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsResponse` object, and - provides an ``__iter__`` method to iterate through its - ``assignments`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``SearchAllAssignments`` requests and continue to iterate - through the ``assignments`` field on the - corresponding responses. - - All the usual :class:`google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsResponse` - 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[..., reservation.SearchAllAssignmentsResponse], - request: reservation.SearchAllAssignmentsRequest, - response: reservation.SearchAllAssignmentsResponse, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()): - """Instantiate the pager. - - Args: - method (Callable): The method that was originally called, and - which instantiated this pager. - request (google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsRequest): - The initial request object. - response (google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsResponse): - The initial response object. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - """ - self._method = method - self._request = reservation.SearchAllAssignmentsRequest(request) - self._response = response - self._retry = retry - self._timeout = timeout - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterator[reservation.SearchAllAssignmentsResponse]: - yield self._response - while self._response.next_page_token: - self._request.page_token = self._response.next_page_token - self._response = self._method(self._request, retry=self._retry, timeout=self._timeout, metadata=self._metadata) - yield self._response - - def __iter__(self) -> Iterator[reservation.Assignment]: - for page in self.pages: - yield from page.assignments - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class SearchAllAssignmentsAsyncPager: - """A pager for iterating through ``search_all_assignments`` requests. - - This class thinly wraps an initial - :class:`google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``assignments`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``SearchAllAssignments`` requests and continue to iterate - through the ``assignments`` field on the - corresponding responses. - - All the usual :class:`google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsResponse` - 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[reservation.SearchAllAssignmentsResponse]], - request: reservation.SearchAllAssignmentsRequest, - response: reservation.SearchAllAssignmentsResponse, - *, - retry: OptionalAsyncRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()): - """Instantiates the pager. - - Args: - method (Callable): The method that was originally called, and - which instantiated this pager. - request (google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsRequest): - The initial request object. - response (google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsResponse): - The initial response object. - retry (google.api_core.retry.AsyncRetry): Designation of what errors, - if any, should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - """ - self._method = method - self._request = reservation.SearchAllAssignmentsRequest(request) - self._response = response - self._retry = retry - self._timeout = timeout - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterator[reservation.SearchAllAssignmentsResponse]: - 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, retry=self._retry, timeout=self._timeout, metadata=self._metadata) - yield self._response - def __aiter__(self) -> AsyncIterator[reservation.Assignment]: - async def async_generator(): - async for page in self.pages: - for response in page.assignments: - yield response - - return async_generator() - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListReservationGroupsPager: - """A pager for iterating through ``list_reservation_groups`` requests. - - This class thinly wraps an initial - :class:`google.cloud.bigquery_reservation_v1.types.ListReservationGroupsResponse` object, and - provides an ``__iter__`` method to iterate through its - ``reservation_groups`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``ListReservationGroups`` requests and continue to iterate - through the ``reservation_groups`` field on the - corresponding responses. - - All the usual :class:`google.cloud.bigquery_reservation_v1.types.ListReservationGroupsResponse` - 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[..., reservation.ListReservationGroupsResponse], - request: reservation.ListReservationGroupsRequest, - response: reservation.ListReservationGroupsResponse, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()): - """Instantiate the pager. - - Args: - method (Callable): The method that was originally called, and - which instantiated this pager. - request (google.cloud.bigquery_reservation_v1.types.ListReservationGroupsRequest): - The initial request object. - response (google.cloud.bigquery_reservation_v1.types.ListReservationGroupsResponse): - The initial response object. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - """ - self._method = method - self._request = reservation.ListReservationGroupsRequest(request) - self._response = response - self._retry = retry - self._timeout = timeout - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterator[reservation.ListReservationGroupsResponse]: - yield self._response - while self._response.next_page_token: - self._request.page_token = self._response.next_page_token - self._response = self._method(self._request, retry=self._retry, timeout=self._timeout, metadata=self._metadata) - yield self._response - - def __iter__(self) -> Iterator[reservation.ReservationGroup]: - for page in self.pages: - yield from page.reservation_groups - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListReservationGroupsAsyncPager: - """A pager for iterating through ``list_reservation_groups`` requests. - - This class thinly wraps an initial - :class:`google.cloud.bigquery_reservation_v1.types.ListReservationGroupsResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``reservation_groups`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``ListReservationGroups`` requests and continue to iterate - through the ``reservation_groups`` field on the - corresponding responses. - - All the usual :class:`google.cloud.bigquery_reservation_v1.types.ListReservationGroupsResponse` - 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[reservation.ListReservationGroupsResponse]], - request: reservation.ListReservationGroupsRequest, - response: reservation.ListReservationGroupsResponse, - *, - retry: OptionalAsyncRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()): - """Instantiates the pager. - - Args: - method (Callable): The method that was originally called, and - which instantiated this pager. - request (google.cloud.bigquery_reservation_v1.types.ListReservationGroupsRequest): - The initial request object. - response (google.cloud.bigquery_reservation_v1.types.ListReservationGroupsResponse): - The initial response object. - retry (google.api_core.retry.AsyncRetry): Designation of what errors, - if any, should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - """ - self._method = method - self._request = reservation.ListReservationGroupsRequest(request) - self._response = response - self._retry = retry - self._timeout = timeout - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterator[reservation.ListReservationGroupsResponse]: - 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, retry=self._retry, timeout=self._timeout, metadata=self._metadata) - yield self._response - def __aiter__(self) -> AsyncIterator[reservation.ReservationGroup]: - async def async_generator(): - async for page in self.pages: - for response in page.reservation_groups: - 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/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/README.rst b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/README.rst deleted file mode 100644 index b69ca178e2ae..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/README.rst +++ /dev/null @@ -1,9 +0,0 @@ - -transport inheritance structure -_______________________________ - -`ReservationServiceTransport` is the ABC for all transports. -- public child `ReservationServiceGrpcTransport` for sync gRPC transport (defined in `grpc.py`). -- public child `ReservationServiceGrpcAsyncIOTransport` for async gRPC transport (defined in `grpc_asyncio.py`). -- private child `_BaseReservationServiceRestTransport` for base REST transport with inner classes `_BaseMETHOD` (defined in `rest_base.py`). -- public child `ReservationServiceRestTransport` for sync REST transport with inner classes `METHOD` derived from the parent's corresponding `_BaseMETHOD` classes (defined in `rest.py`). diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/__init__.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/__init__.py deleted file mode 100644 index 709db549531d..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/__init__.py +++ /dev/null @@ -1,38 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 ReservationServiceTransport -from .grpc import ReservationServiceGrpcTransport -from .grpc_asyncio import ReservationServiceGrpcAsyncIOTransport -from .rest import ReservationServiceRestTransport -from .rest import ReservationServiceRestInterceptor - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[ReservationServiceTransport]] -_transport_registry['grpc'] = ReservationServiceGrpcTransport -_transport_registry['grpc_asyncio'] = ReservationServiceGrpcAsyncIOTransport -_transport_registry['rest'] = ReservationServiceRestTransport - -__all__ = ( - 'ReservationServiceTransport', - 'ReservationServiceGrpcTransport', - 'ReservationServiceGrpcAsyncIOTransport', - 'ReservationServiceRestTransport', - 'ReservationServiceRestInterceptor', -) diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/base.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/base.py deleted file mode 100644 index c375a69c7531..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/base.py +++ /dev/null @@ -1,656 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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.bigquery_reservation_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.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore -import google.protobuf - -from google.cloud.bigquery_reservation_v1.types import reservation -from google.cloud.bigquery_reservation_v1.types import reservation as gcbr_reservation -from google.iam.v1 import iam_policy_pb2 # type: ignore -from google.iam.v1 import policy_pb2 # type: ignore -from google.protobuf import empty_pb2 # type: ignore - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - -if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER - DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ - - -class ReservationServiceTransport(abc.ABC): - """Abstract transport class for ReservationService.""" - - AUTH_SCOPES = ( - 'https://www.googleapis.com/auth/bigquery', - 'https://www.googleapis.com/auth/cloud-platform', - ) - - DEFAULT_HOST: str = 'bigqueryreservation.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 (default: 'bigqueryreservation.googleapis.com'). - 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 not hasattr(self, "_ignore_credentials"): - self._ignore_credentials: bool = False - - # 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 and not self._ignore_credentials: - 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 - - @property - def host(self): - return self._host - - def _prep_wrapped_messages(self, client_info): - # Precompute the wrapped methods. - self._wrapped_methods = { - self.create_reservation: gapic_v1.method.wrap_method( - self.create_reservation, - default_timeout=300.0, - client_info=client_info, - ), - self.list_reservations: gapic_v1.method.wrap_method( - self.list_reservations, - default_retry=retries.Retry( - initial=0.1, - maximum=60.0, - multiplier=1.3, - predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=300.0, - ), - default_timeout=300.0, - client_info=client_info, - ), - self.get_reservation: gapic_v1.method.wrap_method( - self.get_reservation, - default_retry=retries.Retry( - initial=0.1, - maximum=60.0, - multiplier=1.3, - predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=300.0, - ), - default_timeout=300.0, - client_info=client_info, - ), - self.delete_reservation: gapic_v1.method.wrap_method( - self.delete_reservation, - default_retry=retries.Retry( - initial=0.1, - maximum=60.0, - multiplier=1.3, - predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=300.0, - ), - default_timeout=300.0, - client_info=client_info, - ), - self.update_reservation: gapic_v1.method.wrap_method( - self.update_reservation, - default_timeout=300.0, - client_info=client_info, - ), - self.failover_reservation: gapic_v1.method.wrap_method( - self.failover_reservation, - default_timeout=300.0, - client_info=client_info, - ), - self.create_capacity_commitment: gapic_v1.method.wrap_method( - self.create_capacity_commitment, - default_timeout=300.0, - client_info=client_info, - ), - self.list_capacity_commitments: gapic_v1.method.wrap_method( - self.list_capacity_commitments, - default_retry=retries.Retry( - initial=0.1, - maximum=60.0, - multiplier=1.3, - predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=300.0, - ), - default_timeout=300.0, - client_info=client_info, - ), - self.get_capacity_commitment: gapic_v1.method.wrap_method( - self.get_capacity_commitment, - default_retry=retries.Retry( - initial=0.1, - maximum=60.0, - multiplier=1.3, - predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=300.0, - ), - default_timeout=300.0, - client_info=client_info, - ), - self.delete_capacity_commitment: gapic_v1.method.wrap_method( - self.delete_capacity_commitment, - default_retry=retries.Retry( - initial=0.1, - maximum=60.0, - multiplier=1.3, - predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=300.0, - ), - default_timeout=300.0, - client_info=client_info, - ), - self.update_capacity_commitment: gapic_v1.method.wrap_method( - self.update_capacity_commitment, - default_timeout=300.0, - client_info=client_info, - ), - self.split_capacity_commitment: gapic_v1.method.wrap_method( - self.split_capacity_commitment, - default_timeout=300.0, - client_info=client_info, - ), - self.merge_capacity_commitments: gapic_v1.method.wrap_method( - self.merge_capacity_commitments, - default_timeout=300.0, - client_info=client_info, - ), - self.create_assignment: gapic_v1.method.wrap_method( - self.create_assignment, - default_timeout=300.0, - client_info=client_info, - ), - self.list_assignments: gapic_v1.method.wrap_method( - self.list_assignments, - default_retry=retries.Retry( - initial=0.1, - maximum=60.0, - multiplier=1.3, - predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=300.0, - ), - default_timeout=300.0, - client_info=client_info, - ), - self.delete_assignment: gapic_v1.method.wrap_method( - self.delete_assignment, - default_retry=retries.Retry( - initial=0.1, - maximum=60.0, - multiplier=1.3, - predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=300.0, - ), - default_timeout=300.0, - client_info=client_info, - ), - self.search_assignments: gapic_v1.method.wrap_method( - self.search_assignments, - default_retry=retries.Retry( - initial=0.1, - maximum=60.0, - multiplier=1.3, - predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=300.0, - ), - default_timeout=300.0, - client_info=client_info, - ), - self.search_all_assignments: gapic_v1.method.wrap_method( - self.search_all_assignments, - default_timeout=None, - client_info=client_info, - ), - self.move_assignment: gapic_v1.method.wrap_method( - self.move_assignment, - default_timeout=300.0, - client_info=client_info, - ), - self.update_assignment: gapic_v1.method.wrap_method( - self.update_assignment, - default_timeout=None, - client_info=client_info, - ), - self.get_bi_reservation: gapic_v1.method.wrap_method( - self.get_bi_reservation, - default_retry=retries.Retry( - initial=0.1, - maximum=60.0, - multiplier=1.3, - predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=300.0, - ), - default_timeout=300.0, - client_info=client_info, - ), - self.update_bi_reservation: gapic_v1.method.wrap_method( - self.update_bi_reservation, - default_timeout=300.0, - client_info=client_info, - ), - self.get_iam_policy: gapic_v1.method.wrap_method( - self.get_iam_policy, - default_timeout=None, - client_info=client_info, - ), - self.set_iam_policy: gapic_v1.method.wrap_method( - self.set_iam_policy, - default_timeout=None, - client_info=client_info, - ), - self.test_iam_permissions: gapic_v1.method.wrap_method( - self.test_iam_permissions, - default_timeout=None, - client_info=client_info, - ), - self.create_reservation_group: gapic_v1.method.wrap_method( - self.create_reservation_group, - default_timeout=None, - client_info=client_info, - ), - self.get_reservation_group: gapic_v1.method.wrap_method( - self.get_reservation_group, - default_timeout=None, - client_info=client_info, - ), - self.delete_reservation_group: gapic_v1.method.wrap_method( - self.delete_reservation_group, - default_timeout=None, - client_info=client_info, - ), - self.list_reservation_groups: gapic_v1.method.wrap_method( - self.list_reservation_groups, - 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 create_reservation(self) -> Callable[ - [gcbr_reservation.CreateReservationRequest], - Union[ - gcbr_reservation.Reservation, - Awaitable[gcbr_reservation.Reservation] - ]]: - raise NotImplementedError() - - @property - def list_reservations(self) -> Callable[ - [reservation.ListReservationsRequest], - Union[ - reservation.ListReservationsResponse, - Awaitable[reservation.ListReservationsResponse] - ]]: - raise NotImplementedError() - - @property - def get_reservation(self) -> Callable[ - [reservation.GetReservationRequest], - Union[ - reservation.Reservation, - Awaitable[reservation.Reservation] - ]]: - raise NotImplementedError() - - @property - def delete_reservation(self) -> Callable[ - [reservation.DeleteReservationRequest], - Union[ - empty_pb2.Empty, - Awaitable[empty_pb2.Empty] - ]]: - raise NotImplementedError() - - @property - def update_reservation(self) -> Callable[ - [gcbr_reservation.UpdateReservationRequest], - Union[ - gcbr_reservation.Reservation, - Awaitable[gcbr_reservation.Reservation] - ]]: - raise NotImplementedError() - - @property - def failover_reservation(self) -> Callable[ - [reservation.FailoverReservationRequest], - Union[ - reservation.Reservation, - Awaitable[reservation.Reservation] - ]]: - raise NotImplementedError() - - @property - def create_capacity_commitment(self) -> Callable[ - [reservation.CreateCapacityCommitmentRequest], - Union[ - reservation.CapacityCommitment, - Awaitable[reservation.CapacityCommitment] - ]]: - raise NotImplementedError() - - @property - def list_capacity_commitments(self) -> Callable[ - [reservation.ListCapacityCommitmentsRequest], - Union[ - reservation.ListCapacityCommitmentsResponse, - Awaitable[reservation.ListCapacityCommitmentsResponse] - ]]: - raise NotImplementedError() - - @property - def get_capacity_commitment(self) -> Callable[ - [reservation.GetCapacityCommitmentRequest], - Union[ - reservation.CapacityCommitment, - Awaitable[reservation.CapacityCommitment] - ]]: - raise NotImplementedError() - - @property - def delete_capacity_commitment(self) -> Callable[ - [reservation.DeleteCapacityCommitmentRequest], - Union[ - empty_pb2.Empty, - Awaitable[empty_pb2.Empty] - ]]: - raise NotImplementedError() - - @property - def update_capacity_commitment(self) -> Callable[ - [reservation.UpdateCapacityCommitmentRequest], - Union[ - reservation.CapacityCommitment, - Awaitable[reservation.CapacityCommitment] - ]]: - raise NotImplementedError() - - @property - def split_capacity_commitment(self) -> Callable[ - [reservation.SplitCapacityCommitmentRequest], - Union[ - reservation.SplitCapacityCommitmentResponse, - Awaitable[reservation.SplitCapacityCommitmentResponse] - ]]: - raise NotImplementedError() - - @property - def merge_capacity_commitments(self) -> Callable[ - [reservation.MergeCapacityCommitmentsRequest], - Union[ - reservation.CapacityCommitment, - Awaitable[reservation.CapacityCommitment] - ]]: - raise NotImplementedError() - - @property - def create_assignment(self) -> Callable[ - [reservation.CreateAssignmentRequest], - Union[ - reservation.Assignment, - Awaitable[reservation.Assignment] - ]]: - raise NotImplementedError() - - @property - def list_assignments(self) -> Callable[ - [reservation.ListAssignmentsRequest], - Union[ - reservation.ListAssignmentsResponse, - Awaitable[reservation.ListAssignmentsResponse] - ]]: - raise NotImplementedError() - - @property - def delete_assignment(self) -> Callable[ - [reservation.DeleteAssignmentRequest], - Union[ - empty_pb2.Empty, - Awaitable[empty_pb2.Empty] - ]]: - raise NotImplementedError() - - @property - def search_assignments(self) -> Callable[ - [reservation.SearchAssignmentsRequest], - Union[ - reservation.SearchAssignmentsResponse, - Awaitable[reservation.SearchAssignmentsResponse] - ]]: - raise NotImplementedError() - - @property - def search_all_assignments(self) -> Callable[ - [reservation.SearchAllAssignmentsRequest], - Union[ - reservation.SearchAllAssignmentsResponse, - Awaitable[reservation.SearchAllAssignmentsResponse] - ]]: - raise NotImplementedError() - - @property - def move_assignment(self) -> Callable[ - [reservation.MoveAssignmentRequest], - Union[ - reservation.Assignment, - Awaitable[reservation.Assignment] - ]]: - raise NotImplementedError() - - @property - def update_assignment(self) -> Callable[ - [reservation.UpdateAssignmentRequest], - Union[ - reservation.Assignment, - Awaitable[reservation.Assignment] - ]]: - raise NotImplementedError() - - @property - def get_bi_reservation(self) -> Callable[ - [reservation.GetBiReservationRequest], - Union[ - reservation.BiReservation, - Awaitable[reservation.BiReservation] - ]]: - raise NotImplementedError() - - @property - def update_bi_reservation(self) -> Callable[ - [reservation.UpdateBiReservationRequest], - Union[ - reservation.BiReservation, - Awaitable[reservation.BiReservation] - ]]: - raise NotImplementedError() - - @property - def get_iam_policy(self) -> Callable[ - [iam_policy_pb2.GetIamPolicyRequest], - Union[ - policy_pb2.Policy, - Awaitable[policy_pb2.Policy] - ]]: - raise NotImplementedError() - - @property - def set_iam_policy(self) -> Callable[ - [iam_policy_pb2.SetIamPolicyRequest], - Union[ - policy_pb2.Policy, - Awaitable[policy_pb2.Policy] - ]]: - raise NotImplementedError() - - @property - def test_iam_permissions(self) -> Callable[ - [iam_policy_pb2.TestIamPermissionsRequest], - Union[ - iam_policy_pb2.TestIamPermissionsResponse, - Awaitable[iam_policy_pb2.TestIamPermissionsResponse] - ]]: - raise NotImplementedError() - - @property - def create_reservation_group(self) -> Callable[ - [reservation.CreateReservationGroupRequest], - Union[ - reservation.ReservationGroup, - Awaitable[reservation.ReservationGroup] - ]]: - raise NotImplementedError() - - @property - def get_reservation_group(self) -> Callable[ - [reservation.GetReservationGroupRequest], - Union[ - reservation.ReservationGroup, - Awaitable[reservation.ReservationGroup] - ]]: - raise NotImplementedError() - - @property - def delete_reservation_group(self) -> Callable[ - [reservation.DeleteReservationGroupRequest], - Union[ - empty_pb2.Empty, - Awaitable[empty_pb2.Empty] - ]]: - raise NotImplementedError() - - @property - def list_reservation_groups(self) -> Callable[ - [reservation.ListReservationGroupsRequest], - Union[ - reservation.ListReservationGroupsResponse, - Awaitable[reservation.ListReservationGroupsResponse] - ]]: - raise NotImplementedError() - - @property - def kind(self) -> str: - raise NotImplementedError() - - -__all__ = ( - 'ReservationServiceTransport', -) diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc.py deleted file mode 100644 index 37820571ef6c..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc.py +++ /dev/null @@ -1,1299 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 json -import logging as std_logging -import pickle -import warnings -from typing import Callable, Dict, Optional, Sequence, Tuple, Union - -from google.api_core import grpc_helpers -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 -from google.protobuf.json_format import MessageToJson -import google.protobuf.message - -import grpc # type: ignore -import proto # type: ignore - -from google.cloud.bigquery_reservation_v1.types import reservation -from google.cloud.bigquery_reservation_v1.types import reservation as gcbr_reservation -from google.iam.v1 import iam_policy_pb2 # type: ignore -from google.iam.v1 import policy_pb2 # type: ignore -from google.protobuf import empty_pb2 # type: ignore -from .base import ReservationServiceTransport, DEFAULT_CLIENT_INFO - -try: - from google.api_core import client_logging # type: ignore - CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER -except ImportError: # pragma: NO COVER - CLIENT_LOGGING_SUPPORTED = False - -_LOGGER = std_logging.getLogger(__name__) - - -class _LoggingClientInterceptor(grpc.UnaryUnaryClientInterceptor): # pragma: NO COVER - def intercept_unary_unary(self, continuation, client_call_details, request): - logging_enabled = CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(std_logging.DEBUG) - if logging_enabled: # pragma: NO COVER - request_metadata = client_call_details.metadata - if isinstance(request, proto.Message): - request_payload = type(request).to_json(request) - elif isinstance(request, google.protobuf.message.Message): - request_payload = MessageToJson(request) - else: - request_payload = f"{type(request).__name__}: {pickle.dumps(request)}" - - request_metadata = { - key: value.decode("utf-8") if isinstance(value, bytes) else value - for key, value in request_metadata - } - grpc_request = { - "payload": request_payload, - "requestMethod": "grpc", - "metadata": dict(request_metadata), - } - _LOGGER.debug( - f"Sending request for {client_call_details.method}", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": str(client_call_details.method), - "request": grpc_request, - "metadata": grpc_request["metadata"], - }, - ) - response = continuation(client_call_details, request) - if logging_enabled: # pragma: NO COVER - response_metadata = response.trailing_metadata() - # Convert gRPC metadata `` to list of tuples - metadata = dict([(k, str(v)) for k, v in response_metadata]) if response_metadata else None - result = response.result() - if isinstance(result, proto.Message): - response_payload = type(result).to_json(result) - elif isinstance(result, google.protobuf.message.Message): - response_payload = MessageToJson(result) - else: - response_payload = f"{type(result).__name__}: {pickle.dumps(result)}" - grpc_response = { - "payload": response_payload, - "metadata": metadata, - "status": "OK", - } - _LOGGER.debug( - f"Received response for {client_call_details.method}.", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": client_call_details.method, - "response": grpc_response, - "metadata": grpc_response["metadata"], - }, - ) - return response - - -class ReservationServiceGrpcTransport(ReservationServiceTransport): - """gRPC backend transport for ReservationService. - - This API allows users to manage their BigQuery reservations. - - A reservation provides computational resource guarantees, in the - form of `slots `__, to - users. A slot is a unit of computational power in BigQuery, and - serves as the basic unit of parallelism. In a scan of a - multi-partitioned table, a single slot operates on a single - partition of the table. A reservation resource exists as a child - resource of the admin project and location, e.g.: - ``projects/myproject/locations/US/reservations/reservationName``. - - A capacity commitment is a way to purchase compute capacity for - BigQuery jobs (in the form of slots) with some committed period of - usage. A capacity commitment resource exists as a child resource of - the admin project and location, e.g.: - ``projects/myproject/locations/US/capacityCommitments/id``. - - 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 = 'bigqueryreservation.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[Union[grpc.Channel, Callable[..., 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 (default: 'bigqueryreservation.googleapis.com'). - 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 a ``channel`` instance 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 a ``channel`` instance is provided. - scopes (Optional(Sequence[str])): A list of scopes. This argument is - ignored if a ``channel`` instance is provided. - channel (Optional[Union[grpc.Channel, Callable[..., grpc.Channel]]]): - A ``Channel`` instance through which to make calls, or a Callable - that constructs and returns one. If set to None, ``self.create_channel`` - is used to create the channel. If a Callable is given, it will be called - with the same arguments as used in ``self.create_channel``. - 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 a ``channel`` instance 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 a ``channel`` instance 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] = {} - - 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 isinstance(channel, grpc.Channel): - # Ignore credentials if a channel was passed. - credentials = None - self._ignore_credentials = True - # 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: - # initialize with the provided callable or the default channel - channel_init = channel or type(self).create_channel - self._grpc_channel = channel_init( - 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), - ], - ) - - self._interceptor = _LoggingClientInterceptor() - self._logged_channel = grpc.intercept_channel(self._grpc_channel, self._interceptor) - - # Wrap messages. This must be done after self._logged_channel exists - self._prep_wrapped_messages(client_info) - - @classmethod - def create_channel(cls, - host: str = 'bigqueryreservation.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 create_reservation(self) -> Callable[ - [gcbr_reservation.CreateReservationRequest], - gcbr_reservation.Reservation]: - r"""Return a callable for the create reservation method over gRPC. - - Creates a new reservation resource. - - Returns: - Callable[[~.CreateReservationRequest], - ~.Reservation]: - 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_reservation' not in self._stubs: - self._stubs['create_reservation'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/CreateReservation', - request_serializer=gcbr_reservation.CreateReservationRequest.serialize, - response_deserializer=gcbr_reservation.Reservation.deserialize, - ) - return self._stubs['create_reservation'] - - @property - def list_reservations(self) -> Callable[ - [reservation.ListReservationsRequest], - reservation.ListReservationsResponse]: - r"""Return a callable for the list reservations method over gRPC. - - Lists all the reservations for the project in the - specified location. - - Returns: - Callable[[~.ListReservationsRequest], - ~.ListReservationsResponse]: - 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_reservations' not in self._stubs: - self._stubs['list_reservations'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/ListReservations', - request_serializer=reservation.ListReservationsRequest.serialize, - response_deserializer=reservation.ListReservationsResponse.deserialize, - ) - return self._stubs['list_reservations'] - - @property - def get_reservation(self) -> Callable[ - [reservation.GetReservationRequest], - reservation.Reservation]: - r"""Return a callable for the get reservation method over gRPC. - - Returns information about the reservation. - - Returns: - Callable[[~.GetReservationRequest], - ~.Reservation]: - 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_reservation' not in self._stubs: - self._stubs['get_reservation'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/GetReservation', - request_serializer=reservation.GetReservationRequest.serialize, - response_deserializer=reservation.Reservation.deserialize, - ) - return self._stubs['get_reservation'] - - @property - def delete_reservation(self) -> Callable[ - [reservation.DeleteReservationRequest], - empty_pb2.Empty]: - r"""Return a callable for the delete reservation method over gRPC. - - Deletes a reservation. Returns - ``google.rpc.Code.FAILED_PRECONDITION`` when reservation has - assignments. - - Returns: - Callable[[~.DeleteReservationRequest], - ~.Empty]: - 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_reservation' not in self._stubs: - self._stubs['delete_reservation'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/DeleteReservation', - request_serializer=reservation.DeleteReservationRequest.serialize, - response_deserializer=empty_pb2.Empty.FromString, - ) - return self._stubs['delete_reservation'] - - @property - def update_reservation(self) -> Callable[ - [gcbr_reservation.UpdateReservationRequest], - gcbr_reservation.Reservation]: - r"""Return a callable for the update reservation method over gRPC. - - Updates an existing reservation resource. - - Returns: - Callable[[~.UpdateReservationRequest], - ~.Reservation]: - 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_reservation' not in self._stubs: - self._stubs['update_reservation'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/UpdateReservation', - request_serializer=gcbr_reservation.UpdateReservationRequest.serialize, - response_deserializer=gcbr_reservation.Reservation.deserialize, - ) - return self._stubs['update_reservation'] - - @property - def failover_reservation(self) -> Callable[ - [reservation.FailoverReservationRequest], - reservation.Reservation]: - r"""Return a callable for the failover reservation method over gRPC. - - Fail over a reservation to the secondary location. The operation - should be done in the current secondary location, which will be - promoted to the new primary location for the reservation. - Attempting to failover a reservation in the current primary - location will fail with the error code - ``google.rpc.Code.FAILED_PRECONDITION``. - - Returns: - Callable[[~.FailoverReservationRequest], - ~.Reservation]: - 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 'failover_reservation' not in self._stubs: - self._stubs['failover_reservation'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/FailoverReservation', - request_serializer=reservation.FailoverReservationRequest.serialize, - response_deserializer=reservation.Reservation.deserialize, - ) - return self._stubs['failover_reservation'] - - @property - def create_capacity_commitment(self) -> Callable[ - [reservation.CreateCapacityCommitmentRequest], - reservation.CapacityCommitment]: - r"""Return a callable for the create capacity commitment method over gRPC. - - Creates a new capacity commitment resource. - - Returns: - Callable[[~.CreateCapacityCommitmentRequest], - ~.CapacityCommitment]: - 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_capacity_commitment' not in self._stubs: - self._stubs['create_capacity_commitment'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/CreateCapacityCommitment', - request_serializer=reservation.CreateCapacityCommitmentRequest.serialize, - response_deserializer=reservation.CapacityCommitment.deserialize, - ) - return self._stubs['create_capacity_commitment'] - - @property - def list_capacity_commitments(self) -> Callable[ - [reservation.ListCapacityCommitmentsRequest], - reservation.ListCapacityCommitmentsResponse]: - r"""Return a callable for the list capacity commitments method over gRPC. - - Lists all the capacity commitments for the admin - project. - - Returns: - Callable[[~.ListCapacityCommitmentsRequest], - ~.ListCapacityCommitmentsResponse]: - 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_capacity_commitments' not in self._stubs: - self._stubs['list_capacity_commitments'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/ListCapacityCommitments', - request_serializer=reservation.ListCapacityCommitmentsRequest.serialize, - response_deserializer=reservation.ListCapacityCommitmentsResponse.deserialize, - ) - return self._stubs['list_capacity_commitments'] - - @property - def get_capacity_commitment(self) -> Callable[ - [reservation.GetCapacityCommitmentRequest], - reservation.CapacityCommitment]: - r"""Return a callable for the get capacity commitment method over gRPC. - - Returns information about the capacity commitment. - - Returns: - Callable[[~.GetCapacityCommitmentRequest], - ~.CapacityCommitment]: - 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_capacity_commitment' not in self._stubs: - self._stubs['get_capacity_commitment'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/GetCapacityCommitment', - request_serializer=reservation.GetCapacityCommitmentRequest.serialize, - response_deserializer=reservation.CapacityCommitment.deserialize, - ) - return self._stubs['get_capacity_commitment'] - - @property - def delete_capacity_commitment(self) -> Callable[ - [reservation.DeleteCapacityCommitmentRequest], - empty_pb2.Empty]: - r"""Return a callable for the delete capacity commitment method over gRPC. - - Deletes a capacity commitment. Attempting to delete capacity - commitment before its commitment_end_time will fail with the - error code ``google.rpc.Code.FAILED_PRECONDITION``. - - Returns: - Callable[[~.DeleteCapacityCommitmentRequest], - ~.Empty]: - 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_capacity_commitment' not in self._stubs: - self._stubs['delete_capacity_commitment'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/DeleteCapacityCommitment', - request_serializer=reservation.DeleteCapacityCommitmentRequest.serialize, - response_deserializer=empty_pb2.Empty.FromString, - ) - return self._stubs['delete_capacity_commitment'] - - @property - def update_capacity_commitment(self) -> Callable[ - [reservation.UpdateCapacityCommitmentRequest], - reservation.CapacityCommitment]: - r"""Return a callable for the update capacity commitment method over gRPC. - - Updates an existing capacity commitment. - - Only ``plan`` and ``renewal_plan`` fields can be updated. - - Plan can only be changed to a plan of a longer commitment - period. Attempting to change to a plan with shorter commitment - period will fail with the error code - ``google.rpc.Code.FAILED_PRECONDITION``. - - Returns: - Callable[[~.UpdateCapacityCommitmentRequest], - ~.CapacityCommitment]: - 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_capacity_commitment' not in self._stubs: - self._stubs['update_capacity_commitment'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/UpdateCapacityCommitment', - request_serializer=reservation.UpdateCapacityCommitmentRequest.serialize, - response_deserializer=reservation.CapacityCommitment.deserialize, - ) - return self._stubs['update_capacity_commitment'] - - @property - def split_capacity_commitment(self) -> Callable[ - [reservation.SplitCapacityCommitmentRequest], - reservation.SplitCapacityCommitmentResponse]: - r"""Return a callable for the split capacity commitment method over gRPC. - - Splits capacity commitment to two commitments of the same plan - and ``commitment_end_time``. - - A common use case is to enable downgrading commitments. - - For example, in order to downgrade from 10000 slots to 8000, you - might split a 10000 capacity commitment into commitments of 2000 - and 8000. Then, you delete the first one after the commitment - end time passes. - - Returns: - Callable[[~.SplitCapacityCommitmentRequest], - ~.SplitCapacityCommitmentResponse]: - 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 'split_capacity_commitment' not in self._stubs: - self._stubs['split_capacity_commitment'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/SplitCapacityCommitment', - request_serializer=reservation.SplitCapacityCommitmentRequest.serialize, - response_deserializer=reservation.SplitCapacityCommitmentResponse.deserialize, - ) - return self._stubs['split_capacity_commitment'] - - @property - def merge_capacity_commitments(self) -> Callable[ - [reservation.MergeCapacityCommitmentsRequest], - reservation.CapacityCommitment]: - r"""Return a callable for the merge capacity commitments method over gRPC. - - Merges capacity commitments of the same plan into a single - commitment. - - The resulting capacity commitment has the greater - commitment_end_time out of the to-be-merged capacity - commitments. - - Attempting to merge capacity commitments of different plan will - fail with the error code - ``google.rpc.Code.FAILED_PRECONDITION``. - - Returns: - Callable[[~.MergeCapacityCommitmentsRequest], - ~.CapacityCommitment]: - 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 'merge_capacity_commitments' not in self._stubs: - self._stubs['merge_capacity_commitments'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/MergeCapacityCommitments', - request_serializer=reservation.MergeCapacityCommitmentsRequest.serialize, - response_deserializer=reservation.CapacityCommitment.deserialize, - ) - return self._stubs['merge_capacity_commitments'] - - @property - def create_assignment(self) -> Callable[ - [reservation.CreateAssignmentRequest], - reservation.Assignment]: - r"""Return a callable for the create assignment method over gRPC. - - Creates an assignment object which allows the given project to - submit jobs of a certain type using slots from the specified - reservation. - - Currently a resource (project, folder, organization) can only - have one assignment per each (job_type, location) combination, - and that reservation will be used for all jobs of the matching - type. - - Different assignments can be created on different levels of the - projects, folders or organization hierarchy. During query - execution, the assignment is looked up at the project, folder - and organization levels in that order. The first assignment - found is applied to the query. - - When creating assignments, it does not matter if other - assignments exist at higher levels. - - Example: - - - The organization ``organizationA`` contains two projects, - ``project1`` and ``project2``. - - Assignments for all three entities (``organizationA``, - ``project1``, and ``project2``) could all be created and - mapped to the same or different reservations. - - "None" assignments represent an absence of the assignment. - Projects assigned to None use on-demand pricing. To create a - "None" assignment, use "none" as a reservation_id in the parent. - Example parent: - ``projects/myproject/locations/US/reservations/none``. - - Returns ``google.rpc.Code.PERMISSION_DENIED`` if user does not - have 'bigquery.admin' permissions on the project using the - reservation and the project that owns this reservation. - - Returns ``google.rpc.Code.INVALID_ARGUMENT`` when location of - the assignment does not match location of the reservation. - - Returns: - Callable[[~.CreateAssignmentRequest], - ~.Assignment]: - 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_assignment' not in self._stubs: - self._stubs['create_assignment'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/CreateAssignment', - request_serializer=reservation.CreateAssignmentRequest.serialize, - response_deserializer=reservation.Assignment.deserialize, - ) - return self._stubs['create_assignment'] - - @property - def list_assignments(self) -> Callable[ - [reservation.ListAssignmentsRequest], - reservation.ListAssignmentsResponse]: - r"""Return a callable for the list assignments method over gRPC. - - Lists assignments. - - Only explicitly created assignments will be returned. - - Example: - - - Organization ``organizationA`` contains two projects, - ``project1`` and ``project2``. - - Reservation ``res1`` exists and was created previously. - - CreateAssignment was used previously to define the following - associations between entities and reservations: - ```` and ```` - - In this example, ListAssignments will just return the above two - assignments for reservation ``res1``, and no expansion/merge - will happen. - - The wildcard "-" can be used for reservations in the request. In - that case all assignments belongs to the specified project and - location will be listed. - - **Note** "-" cannot be used for projects nor locations. - - Returns: - Callable[[~.ListAssignmentsRequest], - ~.ListAssignmentsResponse]: - 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_assignments' not in self._stubs: - self._stubs['list_assignments'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/ListAssignments', - request_serializer=reservation.ListAssignmentsRequest.serialize, - response_deserializer=reservation.ListAssignmentsResponse.deserialize, - ) - return self._stubs['list_assignments'] - - @property - def delete_assignment(self) -> Callable[ - [reservation.DeleteAssignmentRequest], - empty_pb2.Empty]: - r"""Return a callable for the delete assignment method over gRPC. - - Deletes a assignment. No expansion will happen. - - Example: - - - Organization ``organizationA`` contains two projects, - ``project1`` and ``project2``. - - Reservation ``res1`` exists and was created previously. - - CreateAssignment was used previously to define the following - associations between entities and reservations: - ```` and ```` - - In this example, deletion of the ```` - assignment won't affect the other assignment - ````. After said deletion, queries from - ``project1`` will still use ``res1`` while queries from - ``project2`` will switch to use on-demand mode. - - Returns: - Callable[[~.DeleteAssignmentRequest], - ~.Empty]: - 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_assignment' not in self._stubs: - self._stubs['delete_assignment'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/DeleteAssignment', - request_serializer=reservation.DeleteAssignmentRequest.serialize, - response_deserializer=empty_pb2.Empty.FromString, - ) - return self._stubs['delete_assignment'] - - @property - def search_assignments(self) -> Callable[ - [reservation.SearchAssignmentsRequest], - reservation.SearchAssignmentsResponse]: - r"""Return a callable for the search assignments method over gRPC. - - Deprecated: Looks up assignments for a specified resource for a - particular region. If the request is about a project: - - 1. Assignments created on the project will be returned if they - exist. - 2. Otherwise assignments created on the closest ancestor will be - returned. - 3. Assignments for different JobTypes will all be returned. - - The same logic applies if the request is about a folder. - - If the request is about an organization, then assignments - created on the organization will be returned (organization - doesn't have ancestors). - - Comparing to ListAssignments, there are some behavior - differences: - - 1. permission on the assignee will be verified in this API. - 2. Hierarchy lookup (project->folder->organization) happens in - this API. - 3. Parent here is ``projects/*/locations/*``, instead of - ``projects/*/locations/*reservations/*``. - - **Note** "-" cannot be used for projects nor locations. - - Returns: - Callable[[~.SearchAssignmentsRequest], - ~.SearchAssignmentsResponse]: - 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 'search_assignments' not in self._stubs: - self._stubs['search_assignments'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/SearchAssignments', - request_serializer=reservation.SearchAssignmentsRequest.serialize, - response_deserializer=reservation.SearchAssignmentsResponse.deserialize, - ) - return self._stubs['search_assignments'] - - @property - def search_all_assignments(self) -> Callable[ - [reservation.SearchAllAssignmentsRequest], - reservation.SearchAllAssignmentsResponse]: - r"""Return a callable for the search all assignments method over gRPC. - - Looks up assignments for a specified resource for a particular - region. If the request is about a project: - - 1. Assignments created on the project will be returned if they - exist. - 2. Otherwise assignments created on the closest ancestor will be - returned. - 3. Assignments for different JobTypes will all be returned. - - The same logic applies if the request is about a folder. - - If the request is about an organization, then assignments - created on the organization will be returned (organization - doesn't have ancestors). - - Comparing to ListAssignments, there are some behavior - differences: - - 1. permission on the assignee will be verified in this API. - 2. Hierarchy lookup (project->folder->organization) happens in - this API. - 3. Parent here is ``projects/*/locations/*``, instead of - ``projects/*/locations/*reservations/*``. - - Returns: - Callable[[~.SearchAllAssignmentsRequest], - ~.SearchAllAssignmentsResponse]: - 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 'search_all_assignments' not in self._stubs: - self._stubs['search_all_assignments'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/SearchAllAssignments', - request_serializer=reservation.SearchAllAssignmentsRequest.serialize, - response_deserializer=reservation.SearchAllAssignmentsResponse.deserialize, - ) - return self._stubs['search_all_assignments'] - - @property - def move_assignment(self) -> Callable[ - [reservation.MoveAssignmentRequest], - reservation.Assignment]: - r"""Return a callable for the move assignment method over gRPC. - - Moves an assignment under a new reservation. - - This differs from removing an existing assignment and - recreating a new one by providing a transactional change - that ensures an assignee always has an associated - reservation. - - Returns: - Callable[[~.MoveAssignmentRequest], - ~.Assignment]: - 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 'move_assignment' not in self._stubs: - self._stubs['move_assignment'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/MoveAssignment', - request_serializer=reservation.MoveAssignmentRequest.serialize, - response_deserializer=reservation.Assignment.deserialize, - ) - return self._stubs['move_assignment'] - - @property - def update_assignment(self) -> Callable[ - [reservation.UpdateAssignmentRequest], - reservation.Assignment]: - r"""Return a callable for the update assignment method over gRPC. - - Updates an existing assignment. - - Only the ``priority`` field can be updated. - - Returns: - Callable[[~.UpdateAssignmentRequest], - ~.Assignment]: - 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_assignment' not in self._stubs: - self._stubs['update_assignment'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/UpdateAssignment', - request_serializer=reservation.UpdateAssignmentRequest.serialize, - response_deserializer=reservation.Assignment.deserialize, - ) - return self._stubs['update_assignment'] - - @property - def get_bi_reservation(self) -> Callable[ - [reservation.GetBiReservationRequest], - reservation.BiReservation]: - r"""Return a callable for the get bi reservation method over gRPC. - - Retrieves a BI reservation. - - Returns: - Callable[[~.GetBiReservationRequest], - ~.BiReservation]: - 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_bi_reservation' not in self._stubs: - self._stubs['get_bi_reservation'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/GetBiReservation', - request_serializer=reservation.GetBiReservationRequest.serialize, - response_deserializer=reservation.BiReservation.deserialize, - ) - return self._stubs['get_bi_reservation'] - - @property - def update_bi_reservation(self) -> Callable[ - [reservation.UpdateBiReservationRequest], - reservation.BiReservation]: - r"""Return a callable for the update bi reservation method over gRPC. - - Updates a BI reservation. - - Only fields specified in the ``field_mask`` are updated. - - A singleton BI reservation always exists with default size 0. In - order to reserve BI capacity it needs to be updated to an amount - greater than 0. In order to release BI capacity reservation size - must be set to 0. - - Returns: - Callable[[~.UpdateBiReservationRequest], - ~.BiReservation]: - 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_bi_reservation' not in self._stubs: - self._stubs['update_bi_reservation'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/UpdateBiReservation', - request_serializer=reservation.UpdateBiReservationRequest.serialize, - response_deserializer=reservation.BiReservation.deserialize, - ) - return self._stubs['update_bi_reservation'] - - @property - def get_iam_policy(self) -> Callable[ - [iam_policy_pb2.GetIamPolicyRequest], - policy_pb2.Policy]: - r"""Return a callable for the get iam policy method over gRPC. - - Gets the access control policy for a resource. May return: - - - A\ ``NOT_FOUND`` error if the resource doesn't exist or you - don't have the permission to view it. - - An empty policy if the resource exists but doesn't have a set - policy. - - Supported resources are: - - - Reservations - - ReservationAssignments - - To call this method, you must have the following Google IAM - permissions: - - - ``bigqueryreservation.reservations.getIamPolicy`` to get - policies on reservations. - - Returns: - Callable[[~.GetIamPolicyRequest], - ~.Policy]: - 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_iam_policy' not in self._stubs: - self._stubs['get_iam_policy'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/GetIamPolicy', - request_serializer=iam_policy_pb2.GetIamPolicyRequest.SerializeToString, - response_deserializer=policy_pb2.Policy.FromString, - ) - return self._stubs['get_iam_policy'] - - @property - def set_iam_policy(self) -> Callable[ - [iam_policy_pb2.SetIamPolicyRequest], - policy_pb2.Policy]: - r"""Return a callable for the set iam policy method over gRPC. - - Sets an access control policy for a resource. Replaces any - existing policy. - - Supported resources are: - - - Reservations - - To call this method, you must have the following Google IAM - permissions: - - - ``bigqueryreservation.reservations.setIamPolicy`` to set - policies on reservations. - - Returns: - Callable[[~.SetIamPolicyRequest], - ~.Policy]: - 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 'set_iam_policy' not in self._stubs: - self._stubs['set_iam_policy'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/SetIamPolicy', - request_serializer=iam_policy_pb2.SetIamPolicyRequest.SerializeToString, - response_deserializer=policy_pb2.Policy.FromString, - ) - return self._stubs['set_iam_policy'] - - @property - def test_iam_permissions(self) -> Callable[ - [iam_policy_pb2.TestIamPermissionsRequest], - iam_policy_pb2.TestIamPermissionsResponse]: - r"""Return a callable for the test iam permissions method over gRPC. - - Gets your permissions on a resource. Returns an empty - set of permissions if the resource doesn't exist. - - Supported resources are: - - - Reservations - - No Google IAM permissions are required to call this - method. - - Returns: - Callable[[~.TestIamPermissionsRequest], - ~.TestIamPermissionsResponse]: - 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 'test_iam_permissions' not in self._stubs: - self._stubs['test_iam_permissions'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/TestIamPermissions', - request_serializer=iam_policy_pb2.TestIamPermissionsRequest.SerializeToString, - response_deserializer=iam_policy_pb2.TestIamPermissionsResponse.FromString, - ) - return self._stubs['test_iam_permissions'] - - @property - def create_reservation_group(self) -> Callable[ - [reservation.CreateReservationGroupRequest], - reservation.ReservationGroup]: - r"""Return a callable for the create reservation group method over gRPC. - - Creates a new reservation group. - - Returns: - Callable[[~.CreateReservationGroupRequest], - ~.ReservationGroup]: - 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_reservation_group' not in self._stubs: - self._stubs['create_reservation_group'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/CreateReservationGroup', - request_serializer=reservation.CreateReservationGroupRequest.serialize, - response_deserializer=reservation.ReservationGroup.deserialize, - ) - return self._stubs['create_reservation_group'] - - @property - def get_reservation_group(self) -> Callable[ - [reservation.GetReservationGroupRequest], - reservation.ReservationGroup]: - r"""Return a callable for the get reservation group method over gRPC. - - Returns information about the reservation group. - - Returns: - Callable[[~.GetReservationGroupRequest], - ~.ReservationGroup]: - 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_reservation_group' not in self._stubs: - self._stubs['get_reservation_group'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/GetReservationGroup', - request_serializer=reservation.GetReservationGroupRequest.serialize, - response_deserializer=reservation.ReservationGroup.deserialize, - ) - return self._stubs['get_reservation_group'] - - @property - def delete_reservation_group(self) -> Callable[ - [reservation.DeleteReservationGroupRequest], - empty_pb2.Empty]: - r"""Return a callable for the delete reservation group method over gRPC. - - Deletes a reservation. Returns - ``google.rpc.Code.FAILED_PRECONDITION`` when reservation has - assignments. - - Returns: - Callable[[~.DeleteReservationGroupRequest], - ~.Empty]: - 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_reservation_group' not in self._stubs: - self._stubs['delete_reservation_group'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/DeleteReservationGroup', - request_serializer=reservation.DeleteReservationGroupRequest.serialize, - response_deserializer=empty_pb2.Empty.FromString, - ) - return self._stubs['delete_reservation_group'] - - @property - def list_reservation_groups(self) -> Callable[ - [reservation.ListReservationGroupsRequest], - reservation.ListReservationGroupsResponse]: - r"""Return a callable for the list reservation groups method over gRPC. - - Lists all the reservation groups for the project in - the specified location. - - Returns: - Callable[[~.ListReservationGroupsRequest], - ~.ListReservationGroupsResponse]: - 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_reservation_groups' not in self._stubs: - self._stubs['list_reservation_groups'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/ListReservationGroups', - request_serializer=reservation.ListReservationGroupsRequest.serialize, - response_deserializer=reservation.ListReservationGroupsResponse.deserialize, - ) - return self._stubs['list_reservation_groups'] - - def close(self): - self._logged_channel.close() - - @property - def kind(self) -> str: - return "grpc" - - -__all__ = ( - 'ReservationServiceGrpcTransport', -) diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc_asyncio.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc_asyncio.py deleted file mode 100644 index e7eb71b138c7..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc_asyncio.py +++ /dev/null @@ -1,1560 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 inspect -import json -import pickle -import logging as std_logging -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 exceptions as core_exceptions -from google.api_core import retry_async as retries -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.protobuf.json_format import MessageToJson -import google.protobuf.message - -import grpc # type: ignore -import proto # type: ignore -from grpc.experimental import aio # type: ignore - -from google.cloud.bigquery_reservation_v1.types import reservation -from google.cloud.bigquery_reservation_v1.types import reservation as gcbr_reservation -from google.iam.v1 import iam_policy_pb2 # type: ignore -from google.iam.v1 import policy_pb2 # type: ignore -from google.protobuf import empty_pb2 # type: ignore -from .base import ReservationServiceTransport, DEFAULT_CLIENT_INFO -from .grpc import ReservationServiceGrpcTransport - -try: - from google.api_core import client_logging # type: ignore - CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER -except ImportError: # pragma: NO COVER - CLIENT_LOGGING_SUPPORTED = False - -_LOGGER = std_logging.getLogger(__name__) - - -class _LoggingClientAIOInterceptor(grpc.aio.UnaryUnaryClientInterceptor): # pragma: NO COVER - async def intercept_unary_unary(self, continuation, client_call_details, request): - logging_enabled = CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(std_logging.DEBUG) - if logging_enabled: # pragma: NO COVER - request_metadata = client_call_details.metadata - if isinstance(request, proto.Message): - request_payload = type(request).to_json(request) - elif isinstance(request, google.protobuf.message.Message): - request_payload = MessageToJson(request) - else: - request_payload = f"{type(request).__name__}: {pickle.dumps(request)}" - - request_metadata = { - key: value.decode("utf-8") if isinstance(value, bytes) else value - for key, value in request_metadata - } - grpc_request = { - "payload": request_payload, - "requestMethod": "grpc", - "metadata": dict(request_metadata), - } - _LOGGER.debug( - f"Sending request for {client_call_details.method}", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": str(client_call_details.method), - "request": grpc_request, - "metadata": grpc_request["metadata"], - }, - ) - response = await continuation(client_call_details, request) - if logging_enabled: # pragma: NO COVER - response_metadata = await response.trailing_metadata() - # Convert gRPC metadata `` to list of tuples - metadata = dict([(k, str(v)) for k, v in response_metadata]) if response_metadata else None - result = await response - if isinstance(result, proto.Message): - response_payload = type(result).to_json(result) - elif isinstance(result, google.protobuf.message.Message): - response_payload = MessageToJson(result) - else: - response_payload = f"{type(result).__name__}: {pickle.dumps(result)}" - grpc_response = { - "payload": response_payload, - "metadata": metadata, - "status": "OK", - } - _LOGGER.debug( - f"Received response to rpc {client_call_details.method}.", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": str(client_call_details.method), - "response": grpc_response, - "metadata": grpc_response["metadata"], - }, - ) - return response - - -class ReservationServiceGrpcAsyncIOTransport(ReservationServiceTransport): - """gRPC AsyncIO backend transport for ReservationService. - - This API allows users to manage their BigQuery reservations. - - A reservation provides computational resource guarantees, in the - form of `slots `__, to - users. A slot is a unit of computational power in BigQuery, and - serves as the basic unit of parallelism. In a scan of a - multi-partitioned table, a single slot operates on a single - partition of the table. A reservation resource exists as a child - resource of the admin project and location, e.g.: - ``projects/myproject/locations/US/reservations/reservationName``. - - A capacity commitment is a way to purchase compute capacity for - BigQuery jobs (in the form of slots) with some committed period of - usage. A capacity commitment resource exists as a child resource of - the admin project and location, e.g.: - ``projects/myproject/locations/US/capacityCommitments/id``. - - 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 = 'bigqueryreservation.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`. - 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 = 'bigqueryreservation.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[Union[aio.Channel, Callable[..., 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 (default: 'bigqueryreservation.googleapis.com'). - 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 a ``channel`` instance 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 a ``channel`` instance 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[Union[aio.Channel, Callable[..., aio.Channel]]]): - A ``Channel`` instance through which to make calls, or a Callable - that constructs and returns one. If set to None, ``self.create_channel`` - is used to create the channel. If a Callable is given, it will be called - with the same arguments as used in ``self.create_channel``. - 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 a ``channel`` instance 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 a ``channel`` instance 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] = {} - - 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 isinstance(channel, aio.Channel): - # Ignore credentials if a channel was passed. - credentials = None - self._ignore_credentials = True - # 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: - # initialize with the provided callable or the default channel - channel_init = channel or type(self).create_channel - self._grpc_channel = channel_init( - 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), - ], - ) - - self._interceptor = _LoggingClientAIOInterceptor() - self._grpc_channel._unary_unary_interceptors.append(self._interceptor) - self._logged_channel = self._grpc_channel - self._wrap_with_kind = "kind" in inspect.signature(gapic_v1.method_async.wrap_method).parameters - # Wrap messages. This must be done after self._logged_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 create_reservation(self) -> Callable[ - [gcbr_reservation.CreateReservationRequest], - Awaitable[gcbr_reservation.Reservation]]: - r"""Return a callable for the create reservation method over gRPC. - - Creates a new reservation resource. - - Returns: - Callable[[~.CreateReservationRequest], - Awaitable[~.Reservation]]: - 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_reservation' not in self._stubs: - self._stubs['create_reservation'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/CreateReservation', - request_serializer=gcbr_reservation.CreateReservationRequest.serialize, - response_deserializer=gcbr_reservation.Reservation.deserialize, - ) - return self._stubs['create_reservation'] - - @property - def list_reservations(self) -> Callable[ - [reservation.ListReservationsRequest], - Awaitable[reservation.ListReservationsResponse]]: - r"""Return a callable for the list reservations method over gRPC. - - Lists all the reservations for the project in the - specified location. - - Returns: - Callable[[~.ListReservationsRequest], - Awaitable[~.ListReservationsResponse]]: - 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_reservations' not in self._stubs: - self._stubs['list_reservations'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/ListReservations', - request_serializer=reservation.ListReservationsRequest.serialize, - response_deserializer=reservation.ListReservationsResponse.deserialize, - ) - return self._stubs['list_reservations'] - - @property - def get_reservation(self) -> Callable[ - [reservation.GetReservationRequest], - Awaitable[reservation.Reservation]]: - r"""Return a callable for the get reservation method over gRPC. - - Returns information about the reservation. - - Returns: - Callable[[~.GetReservationRequest], - Awaitable[~.Reservation]]: - 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_reservation' not in self._stubs: - self._stubs['get_reservation'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/GetReservation', - request_serializer=reservation.GetReservationRequest.serialize, - response_deserializer=reservation.Reservation.deserialize, - ) - return self._stubs['get_reservation'] - - @property - def delete_reservation(self) -> Callable[ - [reservation.DeleteReservationRequest], - Awaitable[empty_pb2.Empty]]: - r"""Return a callable for the delete reservation method over gRPC. - - Deletes a reservation. Returns - ``google.rpc.Code.FAILED_PRECONDITION`` when reservation has - assignments. - - Returns: - Callable[[~.DeleteReservationRequest], - Awaitable[~.Empty]]: - 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_reservation' not in self._stubs: - self._stubs['delete_reservation'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/DeleteReservation', - request_serializer=reservation.DeleteReservationRequest.serialize, - response_deserializer=empty_pb2.Empty.FromString, - ) - return self._stubs['delete_reservation'] - - @property - def update_reservation(self) -> Callable[ - [gcbr_reservation.UpdateReservationRequest], - Awaitable[gcbr_reservation.Reservation]]: - r"""Return a callable for the update reservation method over gRPC. - - Updates an existing reservation resource. - - Returns: - Callable[[~.UpdateReservationRequest], - Awaitable[~.Reservation]]: - 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_reservation' not in self._stubs: - self._stubs['update_reservation'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/UpdateReservation', - request_serializer=gcbr_reservation.UpdateReservationRequest.serialize, - response_deserializer=gcbr_reservation.Reservation.deserialize, - ) - return self._stubs['update_reservation'] - - @property - def failover_reservation(self) -> Callable[ - [reservation.FailoverReservationRequest], - Awaitable[reservation.Reservation]]: - r"""Return a callable for the failover reservation method over gRPC. - - Fail over a reservation to the secondary location. The operation - should be done in the current secondary location, which will be - promoted to the new primary location for the reservation. - Attempting to failover a reservation in the current primary - location will fail with the error code - ``google.rpc.Code.FAILED_PRECONDITION``. - - Returns: - Callable[[~.FailoverReservationRequest], - Awaitable[~.Reservation]]: - 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 'failover_reservation' not in self._stubs: - self._stubs['failover_reservation'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/FailoverReservation', - request_serializer=reservation.FailoverReservationRequest.serialize, - response_deserializer=reservation.Reservation.deserialize, - ) - return self._stubs['failover_reservation'] - - @property - def create_capacity_commitment(self) -> Callable[ - [reservation.CreateCapacityCommitmentRequest], - Awaitable[reservation.CapacityCommitment]]: - r"""Return a callable for the create capacity commitment method over gRPC. - - Creates a new capacity commitment resource. - - Returns: - Callable[[~.CreateCapacityCommitmentRequest], - Awaitable[~.CapacityCommitment]]: - 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_capacity_commitment' not in self._stubs: - self._stubs['create_capacity_commitment'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/CreateCapacityCommitment', - request_serializer=reservation.CreateCapacityCommitmentRequest.serialize, - response_deserializer=reservation.CapacityCommitment.deserialize, - ) - return self._stubs['create_capacity_commitment'] - - @property - def list_capacity_commitments(self) -> Callable[ - [reservation.ListCapacityCommitmentsRequest], - Awaitable[reservation.ListCapacityCommitmentsResponse]]: - r"""Return a callable for the list capacity commitments method over gRPC. - - Lists all the capacity commitments for the admin - project. - - Returns: - Callable[[~.ListCapacityCommitmentsRequest], - Awaitable[~.ListCapacityCommitmentsResponse]]: - 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_capacity_commitments' not in self._stubs: - self._stubs['list_capacity_commitments'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/ListCapacityCommitments', - request_serializer=reservation.ListCapacityCommitmentsRequest.serialize, - response_deserializer=reservation.ListCapacityCommitmentsResponse.deserialize, - ) - return self._stubs['list_capacity_commitments'] - - @property - def get_capacity_commitment(self) -> Callable[ - [reservation.GetCapacityCommitmentRequest], - Awaitable[reservation.CapacityCommitment]]: - r"""Return a callable for the get capacity commitment method over gRPC. - - Returns information about the capacity commitment. - - Returns: - Callable[[~.GetCapacityCommitmentRequest], - Awaitable[~.CapacityCommitment]]: - 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_capacity_commitment' not in self._stubs: - self._stubs['get_capacity_commitment'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/GetCapacityCommitment', - request_serializer=reservation.GetCapacityCommitmentRequest.serialize, - response_deserializer=reservation.CapacityCommitment.deserialize, - ) - return self._stubs['get_capacity_commitment'] - - @property - def delete_capacity_commitment(self) -> Callable[ - [reservation.DeleteCapacityCommitmentRequest], - Awaitable[empty_pb2.Empty]]: - r"""Return a callable for the delete capacity commitment method over gRPC. - - Deletes a capacity commitment. Attempting to delete capacity - commitment before its commitment_end_time will fail with the - error code ``google.rpc.Code.FAILED_PRECONDITION``. - - Returns: - Callable[[~.DeleteCapacityCommitmentRequest], - Awaitable[~.Empty]]: - 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_capacity_commitment' not in self._stubs: - self._stubs['delete_capacity_commitment'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/DeleteCapacityCommitment', - request_serializer=reservation.DeleteCapacityCommitmentRequest.serialize, - response_deserializer=empty_pb2.Empty.FromString, - ) - return self._stubs['delete_capacity_commitment'] - - @property - def update_capacity_commitment(self) -> Callable[ - [reservation.UpdateCapacityCommitmentRequest], - Awaitable[reservation.CapacityCommitment]]: - r"""Return a callable for the update capacity commitment method over gRPC. - - Updates an existing capacity commitment. - - Only ``plan`` and ``renewal_plan`` fields can be updated. - - Plan can only be changed to a plan of a longer commitment - period. Attempting to change to a plan with shorter commitment - period will fail with the error code - ``google.rpc.Code.FAILED_PRECONDITION``. - - Returns: - Callable[[~.UpdateCapacityCommitmentRequest], - Awaitable[~.CapacityCommitment]]: - 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_capacity_commitment' not in self._stubs: - self._stubs['update_capacity_commitment'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/UpdateCapacityCommitment', - request_serializer=reservation.UpdateCapacityCommitmentRequest.serialize, - response_deserializer=reservation.CapacityCommitment.deserialize, - ) - return self._stubs['update_capacity_commitment'] - - @property - def split_capacity_commitment(self) -> Callable[ - [reservation.SplitCapacityCommitmentRequest], - Awaitable[reservation.SplitCapacityCommitmentResponse]]: - r"""Return a callable for the split capacity commitment method over gRPC. - - Splits capacity commitment to two commitments of the same plan - and ``commitment_end_time``. - - A common use case is to enable downgrading commitments. - - For example, in order to downgrade from 10000 slots to 8000, you - might split a 10000 capacity commitment into commitments of 2000 - and 8000. Then, you delete the first one after the commitment - end time passes. - - Returns: - Callable[[~.SplitCapacityCommitmentRequest], - Awaitable[~.SplitCapacityCommitmentResponse]]: - 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 'split_capacity_commitment' not in self._stubs: - self._stubs['split_capacity_commitment'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/SplitCapacityCommitment', - request_serializer=reservation.SplitCapacityCommitmentRequest.serialize, - response_deserializer=reservation.SplitCapacityCommitmentResponse.deserialize, - ) - return self._stubs['split_capacity_commitment'] - - @property - def merge_capacity_commitments(self) -> Callable[ - [reservation.MergeCapacityCommitmentsRequest], - Awaitable[reservation.CapacityCommitment]]: - r"""Return a callable for the merge capacity commitments method over gRPC. - - Merges capacity commitments of the same plan into a single - commitment. - - The resulting capacity commitment has the greater - commitment_end_time out of the to-be-merged capacity - commitments. - - Attempting to merge capacity commitments of different plan will - fail with the error code - ``google.rpc.Code.FAILED_PRECONDITION``. - - Returns: - Callable[[~.MergeCapacityCommitmentsRequest], - Awaitable[~.CapacityCommitment]]: - 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 'merge_capacity_commitments' not in self._stubs: - self._stubs['merge_capacity_commitments'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/MergeCapacityCommitments', - request_serializer=reservation.MergeCapacityCommitmentsRequest.serialize, - response_deserializer=reservation.CapacityCommitment.deserialize, - ) - return self._stubs['merge_capacity_commitments'] - - @property - def create_assignment(self) -> Callable[ - [reservation.CreateAssignmentRequest], - Awaitable[reservation.Assignment]]: - r"""Return a callable for the create assignment method over gRPC. - - Creates an assignment object which allows the given project to - submit jobs of a certain type using slots from the specified - reservation. - - Currently a resource (project, folder, organization) can only - have one assignment per each (job_type, location) combination, - and that reservation will be used for all jobs of the matching - type. - - Different assignments can be created on different levels of the - projects, folders or organization hierarchy. During query - execution, the assignment is looked up at the project, folder - and organization levels in that order. The first assignment - found is applied to the query. - - When creating assignments, it does not matter if other - assignments exist at higher levels. - - Example: - - - The organization ``organizationA`` contains two projects, - ``project1`` and ``project2``. - - Assignments for all three entities (``organizationA``, - ``project1``, and ``project2``) could all be created and - mapped to the same or different reservations. - - "None" assignments represent an absence of the assignment. - Projects assigned to None use on-demand pricing. To create a - "None" assignment, use "none" as a reservation_id in the parent. - Example parent: - ``projects/myproject/locations/US/reservations/none``. - - Returns ``google.rpc.Code.PERMISSION_DENIED`` if user does not - have 'bigquery.admin' permissions on the project using the - reservation and the project that owns this reservation. - - Returns ``google.rpc.Code.INVALID_ARGUMENT`` when location of - the assignment does not match location of the reservation. - - Returns: - Callable[[~.CreateAssignmentRequest], - Awaitable[~.Assignment]]: - 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_assignment' not in self._stubs: - self._stubs['create_assignment'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/CreateAssignment', - request_serializer=reservation.CreateAssignmentRequest.serialize, - response_deserializer=reservation.Assignment.deserialize, - ) - return self._stubs['create_assignment'] - - @property - def list_assignments(self) -> Callable[ - [reservation.ListAssignmentsRequest], - Awaitable[reservation.ListAssignmentsResponse]]: - r"""Return a callable for the list assignments method over gRPC. - - Lists assignments. - - Only explicitly created assignments will be returned. - - Example: - - - Organization ``organizationA`` contains two projects, - ``project1`` and ``project2``. - - Reservation ``res1`` exists and was created previously. - - CreateAssignment was used previously to define the following - associations between entities and reservations: - ```` and ```` - - In this example, ListAssignments will just return the above two - assignments for reservation ``res1``, and no expansion/merge - will happen. - - The wildcard "-" can be used for reservations in the request. In - that case all assignments belongs to the specified project and - location will be listed. - - **Note** "-" cannot be used for projects nor locations. - - Returns: - Callable[[~.ListAssignmentsRequest], - Awaitable[~.ListAssignmentsResponse]]: - 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_assignments' not in self._stubs: - self._stubs['list_assignments'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/ListAssignments', - request_serializer=reservation.ListAssignmentsRequest.serialize, - response_deserializer=reservation.ListAssignmentsResponse.deserialize, - ) - return self._stubs['list_assignments'] - - @property - def delete_assignment(self) -> Callable[ - [reservation.DeleteAssignmentRequest], - Awaitable[empty_pb2.Empty]]: - r"""Return a callable for the delete assignment method over gRPC. - - Deletes a assignment. No expansion will happen. - - Example: - - - Organization ``organizationA`` contains two projects, - ``project1`` and ``project2``. - - Reservation ``res1`` exists and was created previously. - - CreateAssignment was used previously to define the following - associations between entities and reservations: - ```` and ```` - - In this example, deletion of the ```` - assignment won't affect the other assignment - ````. After said deletion, queries from - ``project1`` will still use ``res1`` while queries from - ``project2`` will switch to use on-demand mode. - - Returns: - Callable[[~.DeleteAssignmentRequest], - Awaitable[~.Empty]]: - 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_assignment' not in self._stubs: - self._stubs['delete_assignment'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/DeleteAssignment', - request_serializer=reservation.DeleteAssignmentRequest.serialize, - response_deserializer=empty_pb2.Empty.FromString, - ) - return self._stubs['delete_assignment'] - - @property - def search_assignments(self) -> Callable[ - [reservation.SearchAssignmentsRequest], - Awaitable[reservation.SearchAssignmentsResponse]]: - r"""Return a callable for the search assignments method over gRPC. - - Deprecated: Looks up assignments for a specified resource for a - particular region. If the request is about a project: - - 1. Assignments created on the project will be returned if they - exist. - 2. Otherwise assignments created on the closest ancestor will be - returned. - 3. Assignments for different JobTypes will all be returned. - - The same logic applies if the request is about a folder. - - If the request is about an organization, then assignments - created on the organization will be returned (organization - doesn't have ancestors). - - Comparing to ListAssignments, there are some behavior - differences: - - 1. permission on the assignee will be verified in this API. - 2. Hierarchy lookup (project->folder->organization) happens in - this API. - 3. Parent here is ``projects/*/locations/*``, instead of - ``projects/*/locations/*reservations/*``. - - **Note** "-" cannot be used for projects nor locations. - - Returns: - Callable[[~.SearchAssignmentsRequest], - Awaitable[~.SearchAssignmentsResponse]]: - 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 'search_assignments' not in self._stubs: - self._stubs['search_assignments'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/SearchAssignments', - request_serializer=reservation.SearchAssignmentsRequest.serialize, - response_deserializer=reservation.SearchAssignmentsResponse.deserialize, - ) - return self._stubs['search_assignments'] - - @property - def search_all_assignments(self) -> Callable[ - [reservation.SearchAllAssignmentsRequest], - Awaitable[reservation.SearchAllAssignmentsResponse]]: - r"""Return a callable for the search all assignments method over gRPC. - - Looks up assignments for a specified resource for a particular - region. If the request is about a project: - - 1. Assignments created on the project will be returned if they - exist. - 2. Otherwise assignments created on the closest ancestor will be - returned. - 3. Assignments for different JobTypes will all be returned. - - The same logic applies if the request is about a folder. - - If the request is about an organization, then assignments - created on the organization will be returned (organization - doesn't have ancestors). - - Comparing to ListAssignments, there are some behavior - differences: - - 1. permission on the assignee will be verified in this API. - 2. Hierarchy lookup (project->folder->organization) happens in - this API. - 3. Parent here is ``projects/*/locations/*``, instead of - ``projects/*/locations/*reservations/*``. - - Returns: - Callable[[~.SearchAllAssignmentsRequest], - Awaitable[~.SearchAllAssignmentsResponse]]: - 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 'search_all_assignments' not in self._stubs: - self._stubs['search_all_assignments'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/SearchAllAssignments', - request_serializer=reservation.SearchAllAssignmentsRequest.serialize, - response_deserializer=reservation.SearchAllAssignmentsResponse.deserialize, - ) - return self._stubs['search_all_assignments'] - - @property - def move_assignment(self) -> Callable[ - [reservation.MoveAssignmentRequest], - Awaitable[reservation.Assignment]]: - r"""Return a callable for the move assignment method over gRPC. - - Moves an assignment under a new reservation. - - This differs from removing an existing assignment and - recreating a new one by providing a transactional change - that ensures an assignee always has an associated - reservation. - - Returns: - Callable[[~.MoveAssignmentRequest], - Awaitable[~.Assignment]]: - 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 'move_assignment' not in self._stubs: - self._stubs['move_assignment'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/MoveAssignment', - request_serializer=reservation.MoveAssignmentRequest.serialize, - response_deserializer=reservation.Assignment.deserialize, - ) - return self._stubs['move_assignment'] - - @property - def update_assignment(self) -> Callable[ - [reservation.UpdateAssignmentRequest], - Awaitable[reservation.Assignment]]: - r"""Return a callable for the update assignment method over gRPC. - - Updates an existing assignment. - - Only the ``priority`` field can be updated. - - Returns: - Callable[[~.UpdateAssignmentRequest], - Awaitable[~.Assignment]]: - 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_assignment' not in self._stubs: - self._stubs['update_assignment'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/UpdateAssignment', - request_serializer=reservation.UpdateAssignmentRequest.serialize, - response_deserializer=reservation.Assignment.deserialize, - ) - return self._stubs['update_assignment'] - - @property - def get_bi_reservation(self) -> Callable[ - [reservation.GetBiReservationRequest], - Awaitable[reservation.BiReservation]]: - r"""Return a callable for the get bi reservation method over gRPC. - - Retrieves a BI reservation. - - Returns: - Callable[[~.GetBiReservationRequest], - Awaitable[~.BiReservation]]: - 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_bi_reservation' not in self._stubs: - self._stubs['get_bi_reservation'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/GetBiReservation', - request_serializer=reservation.GetBiReservationRequest.serialize, - response_deserializer=reservation.BiReservation.deserialize, - ) - return self._stubs['get_bi_reservation'] - - @property - def update_bi_reservation(self) -> Callable[ - [reservation.UpdateBiReservationRequest], - Awaitable[reservation.BiReservation]]: - r"""Return a callable for the update bi reservation method over gRPC. - - Updates a BI reservation. - - Only fields specified in the ``field_mask`` are updated. - - A singleton BI reservation always exists with default size 0. In - order to reserve BI capacity it needs to be updated to an amount - greater than 0. In order to release BI capacity reservation size - must be set to 0. - - Returns: - Callable[[~.UpdateBiReservationRequest], - Awaitable[~.BiReservation]]: - 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_bi_reservation' not in self._stubs: - self._stubs['update_bi_reservation'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/UpdateBiReservation', - request_serializer=reservation.UpdateBiReservationRequest.serialize, - response_deserializer=reservation.BiReservation.deserialize, - ) - return self._stubs['update_bi_reservation'] - - @property - def get_iam_policy(self) -> Callable[ - [iam_policy_pb2.GetIamPolicyRequest], - Awaitable[policy_pb2.Policy]]: - r"""Return a callable for the get iam policy method over gRPC. - - Gets the access control policy for a resource. May return: - - - A\ ``NOT_FOUND`` error if the resource doesn't exist or you - don't have the permission to view it. - - An empty policy if the resource exists but doesn't have a set - policy. - - Supported resources are: - - - Reservations - - ReservationAssignments - - To call this method, you must have the following Google IAM - permissions: - - - ``bigqueryreservation.reservations.getIamPolicy`` to get - policies on reservations. - - Returns: - Callable[[~.GetIamPolicyRequest], - Awaitable[~.Policy]]: - 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_iam_policy' not in self._stubs: - self._stubs['get_iam_policy'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/GetIamPolicy', - request_serializer=iam_policy_pb2.GetIamPolicyRequest.SerializeToString, - response_deserializer=policy_pb2.Policy.FromString, - ) - return self._stubs['get_iam_policy'] - - @property - def set_iam_policy(self) -> Callable[ - [iam_policy_pb2.SetIamPolicyRequest], - Awaitable[policy_pb2.Policy]]: - r"""Return a callable for the set iam policy method over gRPC. - - Sets an access control policy for a resource. Replaces any - existing policy. - - Supported resources are: - - - Reservations - - To call this method, you must have the following Google IAM - permissions: - - - ``bigqueryreservation.reservations.setIamPolicy`` to set - policies on reservations. - - Returns: - Callable[[~.SetIamPolicyRequest], - Awaitable[~.Policy]]: - 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 'set_iam_policy' not in self._stubs: - self._stubs['set_iam_policy'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/SetIamPolicy', - request_serializer=iam_policy_pb2.SetIamPolicyRequest.SerializeToString, - response_deserializer=policy_pb2.Policy.FromString, - ) - return self._stubs['set_iam_policy'] - - @property - def test_iam_permissions(self) -> Callable[ - [iam_policy_pb2.TestIamPermissionsRequest], - Awaitable[iam_policy_pb2.TestIamPermissionsResponse]]: - r"""Return a callable for the test iam permissions method over gRPC. - - Gets your permissions on a resource. Returns an empty - set of permissions if the resource doesn't exist. - - Supported resources are: - - - Reservations - - No Google IAM permissions are required to call this - method. - - Returns: - Callable[[~.TestIamPermissionsRequest], - Awaitable[~.TestIamPermissionsResponse]]: - 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 'test_iam_permissions' not in self._stubs: - self._stubs['test_iam_permissions'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/TestIamPermissions', - request_serializer=iam_policy_pb2.TestIamPermissionsRequest.SerializeToString, - response_deserializer=iam_policy_pb2.TestIamPermissionsResponse.FromString, - ) - return self._stubs['test_iam_permissions'] - - @property - def create_reservation_group(self) -> Callable[ - [reservation.CreateReservationGroupRequest], - Awaitable[reservation.ReservationGroup]]: - r"""Return a callable for the create reservation group method over gRPC. - - Creates a new reservation group. - - Returns: - Callable[[~.CreateReservationGroupRequest], - Awaitable[~.ReservationGroup]]: - 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_reservation_group' not in self._stubs: - self._stubs['create_reservation_group'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/CreateReservationGroup', - request_serializer=reservation.CreateReservationGroupRequest.serialize, - response_deserializer=reservation.ReservationGroup.deserialize, - ) - return self._stubs['create_reservation_group'] - - @property - def get_reservation_group(self) -> Callable[ - [reservation.GetReservationGroupRequest], - Awaitable[reservation.ReservationGroup]]: - r"""Return a callable for the get reservation group method over gRPC. - - Returns information about the reservation group. - - Returns: - Callable[[~.GetReservationGroupRequest], - Awaitable[~.ReservationGroup]]: - 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_reservation_group' not in self._stubs: - self._stubs['get_reservation_group'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/GetReservationGroup', - request_serializer=reservation.GetReservationGroupRequest.serialize, - response_deserializer=reservation.ReservationGroup.deserialize, - ) - return self._stubs['get_reservation_group'] - - @property - def delete_reservation_group(self) -> Callable[ - [reservation.DeleteReservationGroupRequest], - Awaitable[empty_pb2.Empty]]: - r"""Return a callable for the delete reservation group method over gRPC. - - Deletes a reservation. Returns - ``google.rpc.Code.FAILED_PRECONDITION`` when reservation has - assignments. - - Returns: - Callable[[~.DeleteReservationGroupRequest], - Awaitable[~.Empty]]: - 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_reservation_group' not in self._stubs: - self._stubs['delete_reservation_group'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/DeleteReservationGroup', - request_serializer=reservation.DeleteReservationGroupRequest.serialize, - response_deserializer=empty_pb2.Empty.FromString, - ) - return self._stubs['delete_reservation_group'] - - @property - def list_reservation_groups(self) -> Callable[ - [reservation.ListReservationGroupsRequest], - Awaitable[reservation.ListReservationGroupsResponse]]: - r"""Return a callable for the list reservation groups method over gRPC. - - Lists all the reservation groups for the project in - the specified location. - - Returns: - Callable[[~.ListReservationGroupsRequest], - Awaitable[~.ListReservationGroupsResponse]]: - 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_reservation_groups' not in self._stubs: - self._stubs['list_reservation_groups'] = self._logged_channel.unary_unary( - '/google.cloud.bigquery.reservation.v1.ReservationService/ListReservationGroups', - request_serializer=reservation.ListReservationGroupsRequest.serialize, - response_deserializer=reservation.ListReservationGroupsResponse.deserialize, - ) - return self._stubs['list_reservation_groups'] - - def _prep_wrapped_messages(self, client_info): - """ Precompute the wrapped methods, overriding the base class method to use async wrappers.""" - self._wrapped_methods = { - self.create_reservation: self._wrap_method( - self.create_reservation, - default_timeout=300.0, - client_info=client_info, - ), - self.list_reservations: self._wrap_method( - self.list_reservations, - default_retry=retries.AsyncRetry( - initial=0.1, - maximum=60.0, - multiplier=1.3, - predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=300.0, - ), - default_timeout=300.0, - client_info=client_info, - ), - self.get_reservation: self._wrap_method( - self.get_reservation, - default_retry=retries.AsyncRetry( - initial=0.1, - maximum=60.0, - multiplier=1.3, - predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=300.0, - ), - default_timeout=300.0, - client_info=client_info, - ), - self.delete_reservation: self._wrap_method( - self.delete_reservation, - default_retry=retries.AsyncRetry( - initial=0.1, - maximum=60.0, - multiplier=1.3, - predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=300.0, - ), - default_timeout=300.0, - client_info=client_info, - ), - self.update_reservation: self._wrap_method( - self.update_reservation, - default_timeout=300.0, - client_info=client_info, - ), - self.failover_reservation: self._wrap_method( - self.failover_reservation, - default_timeout=300.0, - client_info=client_info, - ), - self.create_capacity_commitment: self._wrap_method( - self.create_capacity_commitment, - default_timeout=300.0, - client_info=client_info, - ), - self.list_capacity_commitments: self._wrap_method( - self.list_capacity_commitments, - default_retry=retries.AsyncRetry( - initial=0.1, - maximum=60.0, - multiplier=1.3, - predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=300.0, - ), - default_timeout=300.0, - client_info=client_info, - ), - self.get_capacity_commitment: self._wrap_method( - self.get_capacity_commitment, - default_retry=retries.AsyncRetry( - initial=0.1, - maximum=60.0, - multiplier=1.3, - predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=300.0, - ), - default_timeout=300.0, - client_info=client_info, - ), - self.delete_capacity_commitment: self._wrap_method( - self.delete_capacity_commitment, - default_retry=retries.AsyncRetry( - initial=0.1, - maximum=60.0, - multiplier=1.3, - predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=300.0, - ), - default_timeout=300.0, - client_info=client_info, - ), - self.update_capacity_commitment: self._wrap_method( - self.update_capacity_commitment, - default_timeout=300.0, - client_info=client_info, - ), - self.split_capacity_commitment: self._wrap_method( - self.split_capacity_commitment, - default_timeout=300.0, - client_info=client_info, - ), - self.merge_capacity_commitments: self._wrap_method( - self.merge_capacity_commitments, - default_timeout=300.0, - client_info=client_info, - ), - self.create_assignment: self._wrap_method( - self.create_assignment, - default_timeout=300.0, - client_info=client_info, - ), - self.list_assignments: self._wrap_method( - self.list_assignments, - default_retry=retries.AsyncRetry( - initial=0.1, - maximum=60.0, - multiplier=1.3, - predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=300.0, - ), - default_timeout=300.0, - client_info=client_info, - ), - self.delete_assignment: self._wrap_method( - self.delete_assignment, - default_retry=retries.AsyncRetry( - initial=0.1, - maximum=60.0, - multiplier=1.3, - predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=300.0, - ), - default_timeout=300.0, - client_info=client_info, - ), - self.search_assignments: self._wrap_method( - self.search_assignments, - default_retry=retries.AsyncRetry( - initial=0.1, - maximum=60.0, - multiplier=1.3, - predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=300.0, - ), - default_timeout=300.0, - client_info=client_info, - ), - self.search_all_assignments: self._wrap_method( - self.search_all_assignments, - default_timeout=None, - client_info=client_info, - ), - self.move_assignment: self._wrap_method( - self.move_assignment, - default_timeout=300.0, - client_info=client_info, - ), - self.update_assignment: self._wrap_method( - self.update_assignment, - default_timeout=None, - client_info=client_info, - ), - self.get_bi_reservation: self._wrap_method( - self.get_bi_reservation, - default_retry=retries.AsyncRetry( - initial=0.1, - maximum=60.0, - multiplier=1.3, - predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=300.0, - ), - default_timeout=300.0, - client_info=client_info, - ), - self.update_bi_reservation: self._wrap_method( - self.update_bi_reservation, - default_timeout=300.0, - client_info=client_info, - ), - self.get_iam_policy: self._wrap_method( - self.get_iam_policy, - default_timeout=None, - client_info=client_info, - ), - self.set_iam_policy: self._wrap_method( - self.set_iam_policy, - default_timeout=None, - client_info=client_info, - ), - self.test_iam_permissions: self._wrap_method( - self.test_iam_permissions, - default_timeout=None, - client_info=client_info, - ), - self.create_reservation_group: self._wrap_method( - self.create_reservation_group, - default_timeout=None, - client_info=client_info, - ), - self.get_reservation_group: self._wrap_method( - self.get_reservation_group, - default_timeout=None, - client_info=client_info, - ), - self.delete_reservation_group: self._wrap_method( - self.delete_reservation_group, - default_timeout=None, - client_info=client_info, - ), - self.list_reservation_groups: self._wrap_method( - self.list_reservation_groups, - default_timeout=None, - client_info=client_info, - ), - } - - def _wrap_method(self, func, *args, **kwargs): - if self._wrap_with_kind: # pragma: NO COVER - kwargs["kind"] = self.kind - return gapic_v1.method_async.wrap_method(func, *args, **kwargs) - - def close(self): - return self._logged_channel.close() - - @property - def kind(self) -> str: - return "grpc_asyncio" - - -__all__ = ( - 'ReservationServiceGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/rest.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/rest.py deleted file mode 100644 index a14b23460d5f..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/rest.py +++ /dev/null @@ -1,5221 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 logging -import json # type: ignore - -from google.auth.transport.requests import AuthorizedSession # 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 gapic_v1 -import google.protobuf - -from google.protobuf import json_format - -from requests import __version__ as requests_version -import dataclasses -from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union -import warnings - - -from google.cloud.bigquery_reservation_v1.types import reservation -from google.cloud.bigquery_reservation_v1.types import reservation as gcbr_reservation -from google.iam.v1 import iam_policy_pb2 # type: ignore -from google.iam.v1 import policy_pb2 # type: ignore -from google.protobuf import empty_pb2 # type: ignore - - -from .rest_base import _BaseReservationServiceRestTransport -from .base import DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO - -try: - OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None] -except AttributeError: # pragma: NO COVER - OptionalRetry = Union[retries.Retry, object, None] # type: ignore - -try: - from google.api_core import client_logging # type: ignore - CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER -except ImportError: # pragma: NO COVER - CLIENT_LOGGING_SUPPORTED = False - -_LOGGER = logging.getLogger(__name__) - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, - grpc_version=None, - rest_version=f"requests@{requests_version}", -) - -if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER - DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ - - -class ReservationServiceRestInterceptor: - """Interceptor for ReservationService. - - 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 ReservationServiceRestTransport. - - .. code-block:: python - class MyCustomReservationServiceInterceptor(ReservationServiceRestInterceptor): - def pre_create_assignment(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_create_assignment(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_create_capacity_commitment(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_create_capacity_commitment(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_create_reservation(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_create_reservation(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_create_reservation_group(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_create_reservation_group(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_delete_assignment(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def pre_delete_capacity_commitment(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def pre_delete_reservation(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def pre_delete_reservation_group(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def pre_failover_reservation(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_failover_reservation(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_get_bi_reservation(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_get_bi_reservation(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_get_capacity_commitment(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_get_capacity_commitment(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_get_iam_policy(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_get_iam_policy(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_get_reservation(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_get_reservation(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_get_reservation_group(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_get_reservation_group(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_list_assignments(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_list_assignments(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_list_capacity_commitments(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_list_capacity_commitments(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_list_reservation_groups(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_list_reservation_groups(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_list_reservations(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_list_reservations(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_merge_capacity_commitments(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_merge_capacity_commitments(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_move_assignment(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_move_assignment(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_search_all_assignments(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_search_all_assignments(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_search_assignments(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_search_assignments(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_set_iam_policy(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_set_iam_policy(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_split_capacity_commitment(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_split_capacity_commitment(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_test_iam_permissions(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_test_iam_permissions(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_update_assignment(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_update_assignment(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_update_bi_reservation(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_update_bi_reservation(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_update_capacity_commitment(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_update_capacity_commitment(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_update_reservation(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_update_reservation(self, response): - logging.log(f"Received response: {response}") - return response - - transport = ReservationServiceRestTransport(interceptor=MyCustomReservationServiceInterceptor()) - client = ReservationServiceClient(transport=transport) - - - """ - def pre_create_assignment(self, request: reservation.CreateAssignmentRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.CreateAssignmentRequest, Sequence[Tuple[str, Union[str, bytes]]]]: - """Pre-rpc interceptor for create_assignment - - Override in a subclass to manipulate the request or metadata - before they are sent to the ReservationService server. - """ - return request, metadata - - def post_create_assignment(self, response: reservation.Assignment) -> reservation.Assignment: - """Post-rpc interceptor for create_assignment - - DEPRECATED. Please use the `post_create_assignment_with_metadata` - interceptor instead. - - Override in a subclass to read or manipulate the response - after it is returned by the ReservationService server but before - it is returned to user code. This `post_create_assignment` interceptor runs - before the `post_create_assignment_with_metadata` interceptor. - """ - return response - - def post_create_assignment_with_metadata(self, response: reservation.Assignment, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.Assignment, Sequence[Tuple[str, Union[str, bytes]]]]: - """Post-rpc interceptor for create_assignment - - Override in a subclass to read or manipulate the response or metadata after it - is returned by the ReservationService server but before it is returned to user code. - - We recommend only using this `post_create_assignment_with_metadata` - interceptor in new development instead of the `post_create_assignment` interceptor. - When both interceptors are used, this `post_create_assignment_with_metadata` interceptor runs after the - `post_create_assignment` interceptor. The (possibly modified) response returned by - `post_create_assignment` will be passed to - `post_create_assignment_with_metadata`. - """ - return response, metadata - - def pre_create_capacity_commitment(self, request: reservation.CreateCapacityCommitmentRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.CreateCapacityCommitmentRequest, Sequence[Tuple[str, Union[str, bytes]]]]: - """Pre-rpc interceptor for create_capacity_commitment - - Override in a subclass to manipulate the request or metadata - before they are sent to the ReservationService server. - """ - return request, metadata - - def post_create_capacity_commitment(self, response: reservation.CapacityCommitment) -> reservation.CapacityCommitment: - """Post-rpc interceptor for create_capacity_commitment - - DEPRECATED. Please use the `post_create_capacity_commitment_with_metadata` - interceptor instead. - - Override in a subclass to read or manipulate the response - after it is returned by the ReservationService server but before - it is returned to user code. This `post_create_capacity_commitment` interceptor runs - before the `post_create_capacity_commitment_with_metadata` interceptor. - """ - return response - - def post_create_capacity_commitment_with_metadata(self, response: reservation.CapacityCommitment, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.CapacityCommitment, Sequence[Tuple[str, Union[str, bytes]]]]: - """Post-rpc interceptor for create_capacity_commitment - - Override in a subclass to read or manipulate the response or metadata after it - is returned by the ReservationService server but before it is returned to user code. - - We recommend only using this `post_create_capacity_commitment_with_metadata` - interceptor in new development instead of the `post_create_capacity_commitment` interceptor. - When both interceptors are used, this `post_create_capacity_commitment_with_metadata` interceptor runs after the - `post_create_capacity_commitment` interceptor. The (possibly modified) response returned by - `post_create_capacity_commitment` will be passed to - `post_create_capacity_commitment_with_metadata`. - """ - return response, metadata - - def pre_create_reservation(self, request: gcbr_reservation.CreateReservationRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[gcbr_reservation.CreateReservationRequest, Sequence[Tuple[str, Union[str, bytes]]]]: - """Pre-rpc interceptor for create_reservation - - Override in a subclass to manipulate the request or metadata - before they are sent to the ReservationService server. - """ - return request, metadata - - def post_create_reservation(self, response: gcbr_reservation.Reservation) -> gcbr_reservation.Reservation: - """Post-rpc interceptor for create_reservation - - DEPRECATED. Please use the `post_create_reservation_with_metadata` - interceptor instead. - - Override in a subclass to read or manipulate the response - after it is returned by the ReservationService server but before - it is returned to user code. This `post_create_reservation` interceptor runs - before the `post_create_reservation_with_metadata` interceptor. - """ - return response - - def post_create_reservation_with_metadata(self, response: gcbr_reservation.Reservation, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[gcbr_reservation.Reservation, Sequence[Tuple[str, Union[str, bytes]]]]: - """Post-rpc interceptor for create_reservation - - Override in a subclass to read or manipulate the response or metadata after it - is returned by the ReservationService server but before it is returned to user code. - - We recommend only using this `post_create_reservation_with_metadata` - interceptor in new development instead of the `post_create_reservation` interceptor. - When both interceptors are used, this `post_create_reservation_with_metadata` interceptor runs after the - `post_create_reservation` interceptor. The (possibly modified) response returned by - `post_create_reservation` will be passed to - `post_create_reservation_with_metadata`. - """ - return response, metadata - - def pre_create_reservation_group(self, request: reservation.CreateReservationGroupRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.CreateReservationGroupRequest, Sequence[Tuple[str, Union[str, bytes]]]]: - """Pre-rpc interceptor for create_reservation_group - - Override in a subclass to manipulate the request or metadata - before they are sent to the ReservationService server. - """ - return request, metadata - - def post_create_reservation_group(self, response: reservation.ReservationGroup) -> reservation.ReservationGroup: - """Post-rpc interceptor for create_reservation_group - - DEPRECATED. Please use the `post_create_reservation_group_with_metadata` - interceptor instead. - - Override in a subclass to read or manipulate the response - after it is returned by the ReservationService server but before - it is returned to user code. This `post_create_reservation_group` interceptor runs - before the `post_create_reservation_group_with_metadata` interceptor. - """ - return response - - def post_create_reservation_group_with_metadata(self, response: reservation.ReservationGroup, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.ReservationGroup, Sequence[Tuple[str, Union[str, bytes]]]]: - """Post-rpc interceptor for create_reservation_group - - Override in a subclass to read or manipulate the response or metadata after it - is returned by the ReservationService server but before it is returned to user code. - - We recommend only using this `post_create_reservation_group_with_metadata` - interceptor in new development instead of the `post_create_reservation_group` interceptor. - When both interceptors are used, this `post_create_reservation_group_with_metadata` interceptor runs after the - `post_create_reservation_group` interceptor. The (possibly modified) response returned by - `post_create_reservation_group` will be passed to - `post_create_reservation_group_with_metadata`. - """ - return response, metadata - - def pre_delete_assignment(self, request: reservation.DeleteAssignmentRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.DeleteAssignmentRequest, Sequence[Tuple[str, Union[str, bytes]]]]: - """Pre-rpc interceptor for delete_assignment - - Override in a subclass to manipulate the request or metadata - before they are sent to the ReservationService server. - """ - return request, metadata - - def pre_delete_capacity_commitment(self, request: reservation.DeleteCapacityCommitmentRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.DeleteCapacityCommitmentRequest, Sequence[Tuple[str, Union[str, bytes]]]]: - """Pre-rpc interceptor for delete_capacity_commitment - - Override in a subclass to manipulate the request or metadata - before they are sent to the ReservationService server. - """ - return request, metadata - - def pre_delete_reservation(self, request: reservation.DeleteReservationRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.DeleteReservationRequest, Sequence[Tuple[str, Union[str, bytes]]]]: - """Pre-rpc interceptor for delete_reservation - - Override in a subclass to manipulate the request or metadata - before they are sent to the ReservationService server. - """ - return request, metadata - - def pre_delete_reservation_group(self, request: reservation.DeleteReservationGroupRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.DeleteReservationGroupRequest, Sequence[Tuple[str, Union[str, bytes]]]]: - """Pre-rpc interceptor for delete_reservation_group - - Override in a subclass to manipulate the request or metadata - before they are sent to the ReservationService server. - """ - return request, metadata - - def pre_failover_reservation(self, request: reservation.FailoverReservationRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.FailoverReservationRequest, Sequence[Tuple[str, Union[str, bytes]]]]: - """Pre-rpc interceptor for failover_reservation - - Override in a subclass to manipulate the request or metadata - before they are sent to the ReservationService server. - """ - return request, metadata - - def post_failover_reservation(self, response: reservation.Reservation) -> reservation.Reservation: - """Post-rpc interceptor for failover_reservation - - DEPRECATED. Please use the `post_failover_reservation_with_metadata` - interceptor instead. - - Override in a subclass to read or manipulate the response - after it is returned by the ReservationService server but before - it is returned to user code. This `post_failover_reservation` interceptor runs - before the `post_failover_reservation_with_metadata` interceptor. - """ - return response - - def post_failover_reservation_with_metadata(self, response: reservation.Reservation, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.Reservation, Sequence[Tuple[str, Union[str, bytes]]]]: - """Post-rpc interceptor for failover_reservation - - Override in a subclass to read or manipulate the response or metadata after it - is returned by the ReservationService server but before it is returned to user code. - - We recommend only using this `post_failover_reservation_with_metadata` - interceptor in new development instead of the `post_failover_reservation` interceptor. - When both interceptors are used, this `post_failover_reservation_with_metadata` interceptor runs after the - `post_failover_reservation` interceptor. The (possibly modified) response returned by - `post_failover_reservation` will be passed to - `post_failover_reservation_with_metadata`. - """ - return response, metadata - - def pre_get_bi_reservation(self, request: reservation.GetBiReservationRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.GetBiReservationRequest, Sequence[Tuple[str, Union[str, bytes]]]]: - """Pre-rpc interceptor for get_bi_reservation - - Override in a subclass to manipulate the request or metadata - before they are sent to the ReservationService server. - """ - return request, metadata - - def post_get_bi_reservation(self, response: reservation.BiReservation) -> reservation.BiReservation: - """Post-rpc interceptor for get_bi_reservation - - DEPRECATED. Please use the `post_get_bi_reservation_with_metadata` - interceptor instead. - - Override in a subclass to read or manipulate the response - after it is returned by the ReservationService server but before - it is returned to user code. This `post_get_bi_reservation` interceptor runs - before the `post_get_bi_reservation_with_metadata` interceptor. - """ - return response - - def post_get_bi_reservation_with_metadata(self, response: reservation.BiReservation, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.BiReservation, Sequence[Tuple[str, Union[str, bytes]]]]: - """Post-rpc interceptor for get_bi_reservation - - Override in a subclass to read or manipulate the response or metadata after it - is returned by the ReservationService server but before it is returned to user code. - - We recommend only using this `post_get_bi_reservation_with_metadata` - interceptor in new development instead of the `post_get_bi_reservation` interceptor. - When both interceptors are used, this `post_get_bi_reservation_with_metadata` interceptor runs after the - `post_get_bi_reservation` interceptor. The (possibly modified) response returned by - `post_get_bi_reservation` will be passed to - `post_get_bi_reservation_with_metadata`. - """ - return response, metadata - - def pre_get_capacity_commitment(self, request: reservation.GetCapacityCommitmentRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.GetCapacityCommitmentRequest, Sequence[Tuple[str, Union[str, bytes]]]]: - """Pre-rpc interceptor for get_capacity_commitment - - Override in a subclass to manipulate the request or metadata - before they are sent to the ReservationService server. - """ - return request, metadata - - def post_get_capacity_commitment(self, response: reservation.CapacityCommitment) -> reservation.CapacityCommitment: - """Post-rpc interceptor for get_capacity_commitment - - DEPRECATED. Please use the `post_get_capacity_commitment_with_metadata` - interceptor instead. - - Override in a subclass to read or manipulate the response - after it is returned by the ReservationService server but before - it is returned to user code. This `post_get_capacity_commitment` interceptor runs - before the `post_get_capacity_commitment_with_metadata` interceptor. - """ - return response - - def post_get_capacity_commitment_with_metadata(self, response: reservation.CapacityCommitment, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.CapacityCommitment, Sequence[Tuple[str, Union[str, bytes]]]]: - """Post-rpc interceptor for get_capacity_commitment - - Override in a subclass to read or manipulate the response or metadata after it - is returned by the ReservationService server but before it is returned to user code. - - We recommend only using this `post_get_capacity_commitment_with_metadata` - interceptor in new development instead of the `post_get_capacity_commitment` interceptor. - When both interceptors are used, this `post_get_capacity_commitment_with_metadata` interceptor runs after the - `post_get_capacity_commitment` interceptor. The (possibly modified) response returned by - `post_get_capacity_commitment` will be passed to - `post_get_capacity_commitment_with_metadata`. - """ - return response, metadata - - def pre_get_iam_policy(self, request: iam_policy_pb2.GetIamPolicyRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[iam_policy_pb2.GetIamPolicyRequest, Sequence[Tuple[str, Union[str, bytes]]]]: - """Pre-rpc interceptor for get_iam_policy - - Override in a subclass to manipulate the request or metadata - before they are sent to the ReservationService server. - """ - return request, metadata - - def post_get_iam_policy(self, response: policy_pb2.Policy) -> policy_pb2.Policy: - """Post-rpc interceptor for get_iam_policy - - DEPRECATED. Please use the `post_get_iam_policy_with_metadata` - interceptor instead. - - Override in a subclass to read or manipulate the response - after it is returned by the ReservationService server but before - it is returned to user code. This `post_get_iam_policy` interceptor runs - before the `post_get_iam_policy_with_metadata` interceptor. - """ - return response - - def post_get_iam_policy_with_metadata(self, response: policy_pb2.Policy, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[policy_pb2.Policy, Sequence[Tuple[str, Union[str, bytes]]]]: - """Post-rpc interceptor for get_iam_policy - - Override in a subclass to read or manipulate the response or metadata after it - is returned by the ReservationService server but before it is returned to user code. - - We recommend only using this `post_get_iam_policy_with_metadata` - interceptor in new development instead of the `post_get_iam_policy` interceptor. - When both interceptors are used, this `post_get_iam_policy_with_metadata` interceptor runs after the - `post_get_iam_policy` interceptor. The (possibly modified) response returned by - `post_get_iam_policy` will be passed to - `post_get_iam_policy_with_metadata`. - """ - return response, metadata - - def pre_get_reservation(self, request: reservation.GetReservationRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.GetReservationRequest, Sequence[Tuple[str, Union[str, bytes]]]]: - """Pre-rpc interceptor for get_reservation - - Override in a subclass to manipulate the request or metadata - before they are sent to the ReservationService server. - """ - return request, metadata - - def post_get_reservation(self, response: reservation.Reservation) -> reservation.Reservation: - """Post-rpc interceptor for get_reservation - - DEPRECATED. Please use the `post_get_reservation_with_metadata` - interceptor instead. - - Override in a subclass to read or manipulate the response - after it is returned by the ReservationService server but before - it is returned to user code. This `post_get_reservation` interceptor runs - before the `post_get_reservation_with_metadata` interceptor. - """ - return response - - def post_get_reservation_with_metadata(self, response: reservation.Reservation, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.Reservation, Sequence[Tuple[str, Union[str, bytes]]]]: - """Post-rpc interceptor for get_reservation - - Override in a subclass to read or manipulate the response or metadata after it - is returned by the ReservationService server but before it is returned to user code. - - We recommend only using this `post_get_reservation_with_metadata` - interceptor in new development instead of the `post_get_reservation` interceptor. - When both interceptors are used, this `post_get_reservation_with_metadata` interceptor runs after the - `post_get_reservation` interceptor. The (possibly modified) response returned by - `post_get_reservation` will be passed to - `post_get_reservation_with_metadata`. - """ - return response, metadata - - def pre_get_reservation_group(self, request: reservation.GetReservationGroupRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.GetReservationGroupRequest, Sequence[Tuple[str, Union[str, bytes]]]]: - """Pre-rpc interceptor for get_reservation_group - - Override in a subclass to manipulate the request or metadata - before they are sent to the ReservationService server. - """ - return request, metadata - - def post_get_reservation_group(self, response: reservation.ReservationGroup) -> reservation.ReservationGroup: - """Post-rpc interceptor for get_reservation_group - - DEPRECATED. Please use the `post_get_reservation_group_with_metadata` - interceptor instead. - - Override in a subclass to read or manipulate the response - after it is returned by the ReservationService server but before - it is returned to user code. This `post_get_reservation_group` interceptor runs - before the `post_get_reservation_group_with_metadata` interceptor. - """ - return response - - def post_get_reservation_group_with_metadata(self, response: reservation.ReservationGroup, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.ReservationGroup, Sequence[Tuple[str, Union[str, bytes]]]]: - """Post-rpc interceptor for get_reservation_group - - Override in a subclass to read or manipulate the response or metadata after it - is returned by the ReservationService server but before it is returned to user code. - - We recommend only using this `post_get_reservation_group_with_metadata` - interceptor in new development instead of the `post_get_reservation_group` interceptor. - When both interceptors are used, this `post_get_reservation_group_with_metadata` interceptor runs after the - `post_get_reservation_group` interceptor. The (possibly modified) response returned by - `post_get_reservation_group` will be passed to - `post_get_reservation_group_with_metadata`. - """ - return response, metadata - - def pre_list_assignments(self, request: reservation.ListAssignmentsRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.ListAssignmentsRequest, Sequence[Tuple[str, Union[str, bytes]]]]: - """Pre-rpc interceptor for list_assignments - - Override in a subclass to manipulate the request or metadata - before they are sent to the ReservationService server. - """ - return request, metadata - - def post_list_assignments(self, response: reservation.ListAssignmentsResponse) -> reservation.ListAssignmentsResponse: - """Post-rpc interceptor for list_assignments - - DEPRECATED. Please use the `post_list_assignments_with_metadata` - interceptor instead. - - Override in a subclass to read or manipulate the response - after it is returned by the ReservationService server but before - it is returned to user code. This `post_list_assignments` interceptor runs - before the `post_list_assignments_with_metadata` interceptor. - """ - return response - - def post_list_assignments_with_metadata(self, response: reservation.ListAssignmentsResponse, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.ListAssignmentsResponse, Sequence[Tuple[str, Union[str, bytes]]]]: - """Post-rpc interceptor for list_assignments - - Override in a subclass to read or manipulate the response or metadata after it - is returned by the ReservationService server but before it is returned to user code. - - We recommend only using this `post_list_assignments_with_metadata` - interceptor in new development instead of the `post_list_assignments` interceptor. - When both interceptors are used, this `post_list_assignments_with_metadata` interceptor runs after the - `post_list_assignments` interceptor. The (possibly modified) response returned by - `post_list_assignments` will be passed to - `post_list_assignments_with_metadata`. - """ - return response, metadata - - def pre_list_capacity_commitments(self, request: reservation.ListCapacityCommitmentsRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.ListCapacityCommitmentsRequest, Sequence[Tuple[str, Union[str, bytes]]]]: - """Pre-rpc interceptor for list_capacity_commitments - - Override in a subclass to manipulate the request or metadata - before they are sent to the ReservationService server. - """ - return request, metadata - - def post_list_capacity_commitments(self, response: reservation.ListCapacityCommitmentsResponse) -> reservation.ListCapacityCommitmentsResponse: - """Post-rpc interceptor for list_capacity_commitments - - DEPRECATED. Please use the `post_list_capacity_commitments_with_metadata` - interceptor instead. - - Override in a subclass to read or manipulate the response - after it is returned by the ReservationService server but before - it is returned to user code. This `post_list_capacity_commitments` interceptor runs - before the `post_list_capacity_commitments_with_metadata` interceptor. - """ - return response - - def post_list_capacity_commitments_with_metadata(self, response: reservation.ListCapacityCommitmentsResponse, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.ListCapacityCommitmentsResponse, Sequence[Tuple[str, Union[str, bytes]]]]: - """Post-rpc interceptor for list_capacity_commitments - - Override in a subclass to read or manipulate the response or metadata after it - is returned by the ReservationService server but before it is returned to user code. - - We recommend only using this `post_list_capacity_commitments_with_metadata` - interceptor in new development instead of the `post_list_capacity_commitments` interceptor. - When both interceptors are used, this `post_list_capacity_commitments_with_metadata` interceptor runs after the - `post_list_capacity_commitments` interceptor. The (possibly modified) response returned by - `post_list_capacity_commitments` will be passed to - `post_list_capacity_commitments_with_metadata`. - """ - return response, metadata - - def pre_list_reservation_groups(self, request: reservation.ListReservationGroupsRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.ListReservationGroupsRequest, Sequence[Tuple[str, Union[str, bytes]]]]: - """Pre-rpc interceptor for list_reservation_groups - - Override in a subclass to manipulate the request or metadata - before they are sent to the ReservationService server. - """ - return request, metadata - - def post_list_reservation_groups(self, response: reservation.ListReservationGroupsResponse) -> reservation.ListReservationGroupsResponse: - """Post-rpc interceptor for list_reservation_groups - - DEPRECATED. Please use the `post_list_reservation_groups_with_metadata` - interceptor instead. - - Override in a subclass to read or manipulate the response - after it is returned by the ReservationService server but before - it is returned to user code. This `post_list_reservation_groups` interceptor runs - before the `post_list_reservation_groups_with_metadata` interceptor. - """ - return response - - def post_list_reservation_groups_with_metadata(self, response: reservation.ListReservationGroupsResponse, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.ListReservationGroupsResponse, Sequence[Tuple[str, Union[str, bytes]]]]: - """Post-rpc interceptor for list_reservation_groups - - Override in a subclass to read or manipulate the response or metadata after it - is returned by the ReservationService server but before it is returned to user code. - - We recommend only using this `post_list_reservation_groups_with_metadata` - interceptor in new development instead of the `post_list_reservation_groups` interceptor. - When both interceptors are used, this `post_list_reservation_groups_with_metadata` interceptor runs after the - `post_list_reservation_groups` interceptor. The (possibly modified) response returned by - `post_list_reservation_groups` will be passed to - `post_list_reservation_groups_with_metadata`. - """ - return response, metadata - - def pre_list_reservations(self, request: reservation.ListReservationsRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.ListReservationsRequest, Sequence[Tuple[str, Union[str, bytes]]]]: - """Pre-rpc interceptor for list_reservations - - Override in a subclass to manipulate the request or metadata - before they are sent to the ReservationService server. - """ - return request, metadata - - def post_list_reservations(self, response: reservation.ListReservationsResponse) -> reservation.ListReservationsResponse: - """Post-rpc interceptor for list_reservations - - DEPRECATED. Please use the `post_list_reservations_with_metadata` - interceptor instead. - - Override in a subclass to read or manipulate the response - after it is returned by the ReservationService server but before - it is returned to user code. This `post_list_reservations` interceptor runs - before the `post_list_reservations_with_metadata` interceptor. - """ - return response - - def post_list_reservations_with_metadata(self, response: reservation.ListReservationsResponse, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.ListReservationsResponse, Sequence[Tuple[str, Union[str, bytes]]]]: - """Post-rpc interceptor for list_reservations - - Override in a subclass to read or manipulate the response or metadata after it - is returned by the ReservationService server but before it is returned to user code. - - We recommend only using this `post_list_reservations_with_metadata` - interceptor in new development instead of the `post_list_reservations` interceptor. - When both interceptors are used, this `post_list_reservations_with_metadata` interceptor runs after the - `post_list_reservations` interceptor. The (possibly modified) response returned by - `post_list_reservations` will be passed to - `post_list_reservations_with_metadata`. - """ - return response, metadata - - def pre_merge_capacity_commitments(self, request: reservation.MergeCapacityCommitmentsRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.MergeCapacityCommitmentsRequest, Sequence[Tuple[str, Union[str, bytes]]]]: - """Pre-rpc interceptor for merge_capacity_commitments - - Override in a subclass to manipulate the request or metadata - before they are sent to the ReservationService server. - """ - return request, metadata - - def post_merge_capacity_commitments(self, response: reservation.CapacityCommitment) -> reservation.CapacityCommitment: - """Post-rpc interceptor for merge_capacity_commitments - - DEPRECATED. Please use the `post_merge_capacity_commitments_with_metadata` - interceptor instead. - - Override in a subclass to read or manipulate the response - after it is returned by the ReservationService server but before - it is returned to user code. This `post_merge_capacity_commitments` interceptor runs - before the `post_merge_capacity_commitments_with_metadata` interceptor. - """ - return response - - def post_merge_capacity_commitments_with_metadata(self, response: reservation.CapacityCommitment, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.CapacityCommitment, Sequence[Tuple[str, Union[str, bytes]]]]: - """Post-rpc interceptor for merge_capacity_commitments - - Override in a subclass to read or manipulate the response or metadata after it - is returned by the ReservationService server but before it is returned to user code. - - We recommend only using this `post_merge_capacity_commitments_with_metadata` - interceptor in new development instead of the `post_merge_capacity_commitments` interceptor. - When both interceptors are used, this `post_merge_capacity_commitments_with_metadata` interceptor runs after the - `post_merge_capacity_commitments` interceptor. The (possibly modified) response returned by - `post_merge_capacity_commitments` will be passed to - `post_merge_capacity_commitments_with_metadata`. - """ - return response, metadata - - def pre_move_assignment(self, request: reservation.MoveAssignmentRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.MoveAssignmentRequest, Sequence[Tuple[str, Union[str, bytes]]]]: - """Pre-rpc interceptor for move_assignment - - Override in a subclass to manipulate the request or metadata - before they are sent to the ReservationService server. - """ - return request, metadata - - def post_move_assignment(self, response: reservation.Assignment) -> reservation.Assignment: - """Post-rpc interceptor for move_assignment - - DEPRECATED. Please use the `post_move_assignment_with_metadata` - interceptor instead. - - Override in a subclass to read or manipulate the response - after it is returned by the ReservationService server but before - it is returned to user code. This `post_move_assignment` interceptor runs - before the `post_move_assignment_with_metadata` interceptor. - """ - return response - - def post_move_assignment_with_metadata(self, response: reservation.Assignment, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.Assignment, Sequence[Tuple[str, Union[str, bytes]]]]: - """Post-rpc interceptor for move_assignment - - Override in a subclass to read or manipulate the response or metadata after it - is returned by the ReservationService server but before it is returned to user code. - - We recommend only using this `post_move_assignment_with_metadata` - interceptor in new development instead of the `post_move_assignment` interceptor. - When both interceptors are used, this `post_move_assignment_with_metadata` interceptor runs after the - `post_move_assignment` interceptor. The (possibly modified) response returned by - `post_move_assignment` will be passed to - `post_move_assignment_with_metadata`. - """ - return response, metadata - - def pre_search_all_assignments(self, request: reservation.SearchAllAssignmentsRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.SearchAllAssignmentsRequest, Sequence[Tuple[str, Union[str, bytes]]]]: - """Pre-rpc interceptor for search_all_assignments - - Override in a subclass to manipulate the request or metadata - before they are sent to the ReservationService server. - """ - return request, metadata - - def post_search_all_assignments(self, response: reservation.SearchAllAssignmentsResponse) -> reservation.SearchAllAssignmentsResponse: - """Post-rpc interceptor for search_all_assignments - - DEPRECATED. Please use the `post_search_all_assignments_with_metadata` - interceptor instead. - - Override in a subclass to read or manipulate the response - after it is returned by the ReservationService server but before - it is returned to user code. This `post_search_all_assignments` interceptor runs - before the `post_search_all_assignments_with_metadata` interceptor. - """ - return response - - def post_search_all_assignments_with_metadata(self, response: reservation.SearchAllAssignmentsResponse, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.SearchAllAssignmentsResponse, Sequence[Tuple[str, Union[str, bytes]]]]: - """Post-rpc interceptor for search_all_assignments - - Override in a subclass to read or manipulate the response or metadata after it - is returned by the ReservationService server but before it is returned to user code. - - We recommend only using this `post_search_all_assignments_with_metadata` - interceptor in new development instead of the `post_search_all_assignments` interceptor. - When both interceptors are used, this `post_search_all_assignments_with_metadata` interceptor runs after the - `post_search_all_assignments` interceptor. The (possibly modified) response returned by - `post_search_all_assignments` will be passed to - `post_search_all_assignments_with_metadata`. - """ - return response, metadata - - def pre_search_assignments(self, request: reservation.SearchAssignmentsRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.SearchAssignmentsRequest, Sequence[Tuple[str, Union[str, bytes]]]]: - """Pre-rpc interceptor for search_assignments - - Override in a subclass to manipulate the request or metadata - before they are sent to the ReservationService server. - """ - return request, metadata - - def post_search_assignments(self, response: reservation.SearchAssignmentsResponse) -> reservation.SearchAssignmentsResponse: - """Post-rpc interceptor for search_assignments - - DEPRECATED. Please use the `post_search_assignments_with_metadata` - interceptor instead. - - Override in a subclass to read or manipulate the response - after it is returned by the ReservationService server but before - it is returned to user code. This `post_search_assignments` interceptor runs - before the `post_search_assignments_with_metadata` interceptor. - """ - return response - - def post_search_assignments_with_metadata(self, response: reservation.SearchAssignmentsResponse, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.SearchAssignmentsResponse, Sequence[Tuple[str, Union[str, bytes]]]]: - """Post-rpc interceptor for search_assignments - - Override in a subclass to read or manipulate the response or metadata after it - is returned by the ReservationService server but before it is returned to user code. - - We recommend only using this `post_search_assignments_with_metadata` - interceptor in new development instead of the `post_search_assignments` interceptor. - When both interceptors are used, this `post_search_assignments_with_metadata` interceptor runs after the - `post_search_assignments` interceptor. The (possibly modified) response returned by - `post_search_assignments` will be passed to - `post_search_assignments_with_metadata`. - """ - return response, metadata - - def pre_set_iam_policy(self, request: iam_policy_pb2.SetIamPolicyRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[iam_policy_pb2.SetIamPolicyRequest, Sequence[Tuple[str, Union[str, bytes]]]]: - """Pre-rpc interceptor for set_iam_policy - - Override in a subclass to manipulate the request or metadata - before they are sent to the ReservationService server. - """ - return request, metadata - - def post_set_iam_policy(self, response: policy_pb2.Policy) -> policy_pb2.Policy: - """Post-rpc interceptor for set_iam_policy - - DEPRECATED. Please use the `post_set_iam_policy_with_metadata` - interceptor instead. - - Override in a subclass to read or manipulate the response - after it is returned by the ReservationService server but before - it is returned to user code. This `post_set_iam_policy` interceptor runs - before the `post_set_iam_policy_with_metadata` interceptor. - """ - return response - - def post_set_iam_policy_with_metadata(self, response: policy_pb2.Policy, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[policy_pb2.Policy, Sequence[Tuple[str, Union[str, bytes]]]]: - """Post-rpc interceptor for set_iam_policy - - Override in a subclass to read or manipulate the response or metadata after it - is returned by the ReservationService server but before it is returned to user code. - - We recommend only using this `post_set_iam_policy_with_metadata` - interceptor in new development instead of the `post_set_iam_policy` interceptor. - When both interceptors are used, this `post_set_iam_policy_with_metadata` interceptor runs after the - `post_set_iam_policy` interceptor. The (possibly modified) response returned by - `post_set_iam_policy` will be passed to - `post_set_iam_policy_with_metadata`. - """ - return response, metadata - - def pre_split_capacity_commitment(self, request: reservation.SplitCapacityCommitmentRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.SplitCapacityCommitmentRequest, Sequence[Tuple[str, Union[str, bytes]]]]: - """Pre-rpc interceptor for split_capacity_commitment - - Override in a subclass to manipulate the request or metadata - before they are sent to the ReservationService server. - """ - return request, metadata - - def post_split_capacity_commitment(self, response: reservation.SplitCapacityCommitmentResponse) -> reservation.SplitCapacityCommitmentResponse: - """Post-rpc interceptor for split_capacity_commitment - - DEPRECATED. Please use the `post_split_capacity_commitment_with_metadata` - interceptor instead. - - Override in a subclass to read or manipulate the response - after it is returned by the ReservationService server but before - it is returned to user code. This `post_split_capacity_commitment` interceptor runs - before the `post_split_capacity_commitment_with_metadata` interceptor. - """ - return response - - def post_split_capacity_commitment_with_metadata(self, response: reservation.SplitCapacityCommitmentResponse, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.SplitCapacityCommitmentResponse, Sequence[Tuple[str, Union[str, bytes]]]]: - """Post-rpc interceptor for split_capacity_commitment - - Override in a subclass to read or manipulate the response or metadata after it - is returned by the ReservationService server but before it is returned to user code. - - We recommend only using this `post_split_capacity_commitment_with_metadata` - interceptor in new development instead of the `post_split_capacity_commitment` interceptor. - When both interceptors are used, this `post_split_capacity_commitment_with_metadata` interceptor runs after the - `post_split_capacity_commitment` interceptor. The (possibly modified) response returned by - `post_split_capacity_commitment` will be passed to - `post_split_capacity_commitment_with_metadata`. - """ - return response, metadata - - def pre_test_iam_permissions(self, request: iam_policy_pb2.TestIamPermissionsRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[iam_policy_pb2.TestIamPermissionsRequest, Sequence[Tuple[str, Union[str, bytes]]]]: - """Pre-rpc interceptor for test_iam_permissions - - Override in a subclass to manipulate the request or metadata - before they are sent to the ReservationService server. - """ - return request, metadata - - def post_test_iam_permissions(self, response: iam_policy_pb2.TestIamPermissionsResponse) -> iam_policy_pb2.TestIamPermissionsResponse: - """Post-rpc interceptor for test_iam_permissions - - DEPRECATED. Please use the `post_test_iam_permissions_with_metadata` - interceptor instead. - - Override in a subclass to read or manipulate the response - after it is returned by the ReservationService server but before - it is returned to user code. This `post_test_iam_permissions` interceptor runs - before the `post_test_iam_permissions_with_metadata` interceptor. - """ - return response - - def post_test_iam_permissions_with_metadata(self, response: iam_policy_pb2.TestIamPermissionsResponse, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[iam_policy_pb2.TestIamPermissionsResponse, Sequence[Tuple[str, Union[str, bytes]]]]: - """Post-rpc interceptor for test_iam_permissions - - Override in a subclass to read or manipulate the response or metadata after it - is returned by the ReservationService server but before it is returned to user code. - - We recommend only using this `post_test_iam_permissions_with_metadata` - interceptor in new development instead of the `post_test_iam_permissions` interceptor. - When both interceptors are used, this `post_test_iam_permissions_with_metadata` interceptor runs after the - `post_test_iam_permissions` interceptor. The (possibly modified) response returned by - `post_test_iam_permissions` will be passed to - `post_test_iam_permissions_with_metadata`. - """ - return response, metadata - - def pre_update_assignment(self, request: reservation.UpdateAssignmentRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.UpdateAssignmentRequest, Sequence[Tuple[str, Union[str, bytes]]]]: - """Pre-rpc interceptor for update_assignment - - Override in a subclass to manipulate the request or metadata - before they are sent to the ReservationService server. - """ - return request, metadata - - def post_update_assignment(self, response: reservation.Assignment) -> reservation.Assignment: - """Post-rpc interceptor for update_assignment - - DEPRECATED. Please use the `post_update_assignment_with_metadata` - interceptor instead. - - Override in a subclass to read or manipulate the response - after it is returned by the ReservationService server but before - it is returned to user code. This `post_update_assignment` interceptor runs - before the `post_update_assignment_with_metadata` interceptor. - """ - return response - - def post_update_assignment_with_metadata(self, response: reservation.Assignment, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.Assignment, Sequence[Tuple[str, Union[str, bytes]]]]: - """Post-rpc interceptor for update_assignment - - Override in a subclass to read or manipulate the response or metadata after it - is returned by the ReservationService server but before it is returned to user code. - - We recommend only using this `post_update_assignment_with_metadata` - interceptor in new development instead of the `post_update_assignment` interceptor. - When both interceptors are used, this `post_update_assignment_with_metadata` interceptor runs after the - `post_update_assignment` interceptor. The (possibly modified) response returned by - `post_update_assignment` will be passed to - `post_update_assignment_with_metadata`. - """ - return response, metadata - - def pre_update_bi_reservation(self, request: reservation.UpdateBiReservationRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.UpdateBiReservationRequest, Sequence[Tuple[str, Union[str, bytes]]]]: - """Pre-rpc interceptor for update_bi_reservation - - Override in a subclass to manipulate the request or metadata - before they are sent to the ReservationService server. - """ - return request, metadata - - def post_update_bi_reservation(self, response: reservation.BiReservation) -> reservation.BiReservation: - """Post-rpc interceptor for update_bi_reservation - - DEPRECATED. Please use the `post_update_bi_reservation_with_metadata` - interceptor instead. - - Override in a subclass to read or manipulate the response - after it is returned by the ReservationService server but before - it is returned to user code. This `post_update_bi_reservation` interceptor runs - before the `post_update_bi_reservation_with_metadata` interceptor. - """ - return response - - def post_update_bi_reservation_with_metadata(self, response: reservation.BiReservation, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.BiReservation, Sequence[Tuple[str, Union[str, bytes]]]]: - """Post-rpc interceptor for update_bi_reservation - - Override in a subclass to read or manipulate the response or metadata after it - is returned by the ReservationService server but before it is returned to user code. - - We recommend only using this `post_update_bi_reservation_with_metadata` - interceptor in new development instead of the `post_update_bi_reservation` interceptor. - When both interceptors are used, this `post_update_bi_reservation_with_metadata` interceptor runs after the - `post_update_bi_reservation` interceptor. The (possibly modified) response returned by - `post_update_bi_reservation` will be passed to - `post_update_bi_reservation_with_metadata`. - """ - return response, metadata - - def pre_update_capacity_commitment(self, request: reservation.UpdateCapacityCommitmentRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.UpdateCapacityCommitmentRequest, Sequence[Tuple[str, Union[str, bytes]]]]: - """Pre-rpc interceptor for update_capacity_commitment - - Override in a subclass to manipulate the request or metadata - before they are sent to the ReservationService server. - """ - return request, metadata - - def post_update_capacity_commitment(self, response: reservation.CapacityCommitment) -> reservation.CapacityCommitment: - """Post-rpc interceptor for update_capacity_commitment - - DEPRECATED. Please use the `post_update_capacity_commitment_with_metadata` - interceptor instead. - - Override in a subclass to read or manipulate the response - after it is returned by the ReservationService server but before - it is returned to user code. This `post_update_capacity_commitment` interceptor runs - before the `post_update_capacity_commitment_with_metadata` interceptor. - """ - return response - - def post_update_capacity_commitment_with_metadata(self, response: reservation.CapacityCommitment, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[reservation.CapacityCommitment, Sequence[Tuple[str, Union[str, bytes]]]]: - """Post-rpc interceptor for update_capacity_commitment - - Override in a subclass to read or manipulate the response or metadata after it - is returned by the ReservationService server but before it is returned to user code. - - We recommend only using this `post_update_capacity_commitment_with_metadata` - interceptor in new development instead of the `post_update_capacity_commitment` interceptor. - When both interceptors are used, this `post_update_capacity_commitment_with_metadata` interceptor runs after the - `post_update_capacity_commitment` interceptor. The (possibly modified) response returned by - `post_update_capacity_commitment` will be passed to - `post_update_capacity_commitment_with_metadata`. - """ - return response, metadata - - def pre_update_reservation(self, request: gcbr_reservation.UpdateReservationRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[gcbr_reservation.UpdateReservationRequest, Sequence[Tuple[str, Union[str, bytes]]]]: - """Pre-rpc interceptor for update_reservation - - Override in a subclass to manipulate the request or metadata - before they are sent to the ReservationService server. - """ - return request, metadata - - def post_update_reservation(self, response: gcbr_reservation.Reservation) -> gcbr_reservation.Reservation: - """Post-rpc interceptor for update_reservation - - DEPRECATED. Please use the `post_update_reservation_with_metadata` - interceptor instead. - - Override in a subclass to read or manipulate the response - after it is returned by the ReservationService server but before - it is returned to user code. This `post_update_reservation` interceptor runs - before the `post_update_reservation_with_metadata` interceptor. - """ - return response - - def post_update_reservation_with_metadata(self, response: gcbr_reservation.Reservation, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[gcbr_reservation.Reservation, Sequence[Tuple[str, Union[str, bytes]]]]: - """Post-rpc interceptor for update_reservation - - Override in a subclass to read or manipulate the response or metadata after it - is returned by the ReservationService server but before it is returned to user code. - - We recommend only using this `post_update_reservation_with_metadata` - interceptor in new development instead of the `post_update_reservation` interceptor. - When both interceptors are used, this `post_update_reservation_with_metadata` interceptor runs after the - `post_update_reservation` interceptor. The (possibly modified) response returned by - `post_update_reservation` will be passed to - `post_update_reservation_with_metadata`. - """ - return response, metadata - - -@dataclasses.dataclass -class ReservationServiceRestStub: - _session: AuthorizedSession - _host: str - _interceptor: ReservationServiceRestInterceptor - - -class ReservationServiceRestTransport(_BaseReservationServiceRestTransport): - """REST backend synchronous transport for ReservationService. - - This API allows users to manage their BigQuery reservations. - - A reservation provides computational resource guarantees, in the - form of `slots `__, to - users. A slot is a unit of computational power in BigQuery, and - serves as the basic unit of parallelism. In a scan of a - multi-partitioned table, a single slot operates on a single - partition of the table. A reservation resource exists as a child - resource of the admin project and location, e.g.: - ``projects/myproject/locations/US/reservations/reservationName``. - - A capacity commitment is a way to purchase compute capacity for - BigQuery jobs (in the form of slots) with some committed period of - usage. A capacity commitment resource exists as a child resource of - the admin project and location, e.g.: - ``projects/myproject/locations/US/capacityCommitments/id``. - - 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 = 'bigqueryreservation.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[ReservationServiceRestInterceptor] = None, - api_audience: Optional[str] = None, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to (default: 'bigqueryreservation.googleapis.com'). - 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 - super().__init__( - host=host, - credentials=credentials, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - url_scheme=url_scheme, - api_audience=api_audience - ) - self._session = AuthorizedSession( - self._credentials, default_host=self.DEFAULT_HOST) - if client_cert_source_for_mtls: - self._session.configure_mtls_channel(client_cert_source_for_mtls) - self._interceptor = interceptor or ReservationServiceRestInterceptor() - self._prep_wrapped_messages(client_info) - - class _CreateAssignment(_BaseReservationServiceRestTransport._BaseCreateAssignment, ReservationServiceRestStub): - def __hash__(self): - return hash("ReservationServiceRestTransport.CreateAssignment") - - @staticmethod - def _get_response( - host, - metadata, - query_params, - session, - timeout, - transcoded_request, - body=None): - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(session, method)( - "{host}{uri}".format(host=host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - return response - - def __call__(self, - request: reservation.CreateAssignmentRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), - ) -> reservation.Assignment: - r"""Call the create assignment method over HTTP. - - Args: - request (~.reservation.CreateAssignmentRequest): - The request object. The request for - [ReservationService.CreateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.CreateAssignment]. - Note: "bigquery.reservationAssignments.create" - permission is required on the related assignee. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - ~.reservation.Assignment: - An assignment allows a project to - submit jobs of a certain type using - slots from the specified reservation. - - """ - - http_options = _BaseReservationServiceRestTransport._BaseCreateAssignment._get_http_options() - - request, metadata = self._interceptor.pre_create_assignment(request, metadata) - transcoded_request = _BaseReservationServiceRestTransport._BaseCreateAssignment._get_transcoded_request(http_options, request) - - body = _BaseReservationServiceRestTransport._BaseCreateAssignment._get_request_body_json(transcoded_request) - - # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseCreateAssignment._get_query_params_json(transcoded_request) - - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) - method = transcoded_request['method'] - try: - request_payload = type(request).to_json(request) - except: - request_payload = None - http_request = { - "payload": request_payload, - "requestMethod": method, - "requestUrl": request_url, - "headers": dict(metadata), - } - _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.CreateAssignment", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "CreateAssignment", - "httpRequest": http_request, - "metadata": http_request["headers"], - }, - ) - - # Send the request - response = ReservationServiceRestTransport._CreateAssignment._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request, 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 = reservation.Assignment() - pb_resp = reservation.Assignment.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - - resp = self._interceptor.post_create_assignment(resp) - response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_create_assignment_with_metadata(resp, response_metadata) - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - try: - response_payload = reservation.Assignment.to_json(response) - except: - response_payload = None - http_response = { - "payload": response_payload, - "headers": dict(response.headers), - "status": response.status_code, - } - _LOGGER.debug( - "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.create_assignment", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "CreateAssignment", - "metadata": http_response["headers"], - "httpResponse": http_response, - }, - ) - return resp - - class _CreateCapacityCommitment(_BaseReservationServiceRestTransport._BaseCreateCapacityCommitment, ReservationServiceRestStub): - def __hash__(self): - return hash("ReservationServiceRestTransport.CreateCapacityCommitment") - - @staticmethod - def _get_response( - host, - metadata, - query_params, - session, - timeout, - transcoded_request, - body=None): - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(session, method)( - "{host}{uri}".format(host=host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - return response - - def __call__(self, - request: reservation.CreateCapacityCommitmentRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), - ) -> reservation.CapacityCommitment: - r"""Call the create capacity - commitment method over HTTP. - - Args: - request (~.reservation.CreateCapacityCommitmentRequest): - The request object. The request for - [ReservationService.CreateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.CreateCapacityCommitment]. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - ~.reservation.CapacityCommitment: - Capacity commitment is a way to - purchase compute capacity for BigQuery - jobs (in the form of slots) with some - committed period of usage. Annual - commitments renew by default. - Commitments can be removed after their - commitment end time passes. - - In order to remove annual commitment, - its plan needs to be changed to monthly - or flex first. - - A capacity commitment resource exists as - a child resource of the admin project. - - """ - - http_options = _BaseReservationServiceRestTransport._BaseCreateCapacityCommitment._get_http_options() - - request, metadata = self._interceptor.pre_create_capacity_commitment(request, metadata) - transcoded_request = _BaseReservationServiceRestTransport._BaseCreateCapacityCommitment._get_transcoded_request(http_options, request) - - body = _BaseReservationServiceRestTransport._BaseCreateCapacityCommitment._get_request_body_json(transcoded_request) - - # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseCreateCapacityCommitment._get_query_params_json(transcoded_request) - - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) - method = transcoded_request['method'] - try: - request_payload = type(request).to_json(request) - except: - request_payload = None - http_request = { - "payload": request_payload, - "requestMethod": method, - "requestUrl": request_url, - "headers": dict(metadata), - } - _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.CreateCapacityCommitment", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "CreateCapacityCommitment", - "httpRequest": http_request, - "metadata": http_request["headers"], - }, - ) - - # Send the request - response = ReservationServiceRestTransport._CreateCapacityCommitment._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request, 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 = reservation.CapacityCommitment() - pb_resp = reservation.CapacityCommitment.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - - resp = self._interceptor.post_create_capacity_commitment(resp) - response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_create_capacity_commitment_with_metadata(resp, response_metadata) - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - try: - response_payload = reservation.CapacityCommitment.to_json(response) - except: - response_payload = None - http_response = { - "payload": response_payload, - "headers": dict(response.headers), - "status": response.status_code, - } - _LOGGER.debug( - "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.create_capacity_commitment", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "CreateCapacityCommitment", - "metadata": http_response["headers"], - "httpResponse": http_response, - }, - ) - return resp - - class _CreateReservation(_BaseReservationServiceRestTransport._BaseCreateReservation, ReservationServiceRestStub): - def __hash__(self): - return hash("ReservationServiceRestTransport.CreateReservation") - - @staticmethod - def _get_response( - host, - metadata, - query_params, - session, - timeout, - transcoded_request, - body=None): - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(session, method)( - "{host}{uri}".format(host=host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - return response - - def __call__(self, - request: gcbr_reservation.CreateReservationRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), - ) -> gcbr_reservation.Reservation: - r"""Call the create reservation method over HTTP. - - Args: - request (~.gcbr_reservation.CreateReservationRequest): - The request object. The request for - [ReservationService.CreateReservation][google.cloud.bigquery.reservation.v1.ReservationService.CreateReservation]. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - ~.gcbr_reservation.Reservation: - A reservation is a mechanism used to - guarantee slots to users. - - """ - - http_options = _BaseReservationServiceRestTransport._BaseCreateReservation._get_http_options() - - request, metadata = self._interceptor.pre_create_reservation(request, metadata) - transcoded_request = _BaseReservationServiceRestTransport._BaseCreateReservation._get_transcoded_request(http_options, request) - - body = _BaseReservationServiceRestTransport._BaseCreateReservation._get_request_body_json(transcoded_request) - - # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseCreateReservation._get_query_params_json(transcoded_request) - - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) - method = transcoded_request['method'] - try: - request_payload = type(request).to_json(request) - except: - request_payload = None - http_request = { - "payload": request_payload, - "requestMethod": method, - "requestUrl": request_url, - "headers": dict(metadata), - } - _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.CreateReservation", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "CreateReservation", - "httpRequest": http_request, - "metadata": http_request["headers"], - }, - ) - - # Send the request - response = ReservationServiceRestTransport._CreateReservation._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request, 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 = gcbr_reservation.Reservation() - pb_resp = gcbr_reservation.Reservation.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - - resp = self._interceptor.post_create_reservation(resp) - response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_create_reservation_with_metadata(resp, response_metadata) - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - try: - response_payload = gcbr_reservation.Reservation.to_json(response) - except: - response_payload = None - http_response = { - "payload": response_payload, - "headers": dict(response.headers), - "status": response.status_code, - } - _LOGGER.debug( - "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.create_reservation", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "CreateReservation", - "metadata": http_response["headers"], - "httpResponse": http_response, - }, - ) - return resp - - class _CreateReservationGroup(_BaseReservationServiceRestTransport._BaseCreateReservationGroup, ReservationServiceRestStub): - def __hash__(self): - return hash("ReservationServiceRestTransport.CreateReservationGroup") - - @staticmethod - def _get_response( - host, - metadata, - query_params, - session, - timeout, - transcoded_request, - body=None): - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(session, method)( - "{host}{uri}".format(host=host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - return response - - def __call__(self, - request: reservation.CreateReservationGroupRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), - ) -> reservation.ReservationGroup: - r"""Call the create reservation group method over HTTP. - - Args: - request (~.reservation.CreateReservationGroupRequest): - The request object. The request for - [ReservationService.CreateReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.CreateReservationGroup]. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - ~.reservation.ReservationGroup: - A reservation group is a container - for reservations. - - """ - - http_options = _BaseReservationServiceRestTransport._BaseCreateReservationGroup._get_http_options() - - request, metadata = self._interceptor.pre_create_reservation_group(request, metadata) - transcoded_request = _BaseReservationServiceRestTransport._BaseCreateReservationGroup._get_transcoded_request(http_options, request) - - body = _BaseReservationServiceRestTransport._BaseCreateReservationGroup._get_request_body_json(transcoded_request) - - # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseCreateReservationGroup._get_query_params_json(transcoded_request) - - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) - method = transcoded_request['method'] - try: - request_payload = type(request).to_json(request) - except: - request_payload = None - http_request = { - "payload": request_payload, - "requestMethod": method, - "requestUrl": request_url, - "headers": dict(metadata), - } - _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.CreateReservationGroup", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "CreateReservationGroup", - "httpRequest": http_request, - "metadata": http_request["headers"], - }, - ) - - # Send the request - response = ReservationServiceRestTransport._CreateReservationGroup._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request, 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 = reservation.ReservationGroup() - pb_resp = reservation.ReservationGroup.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - - resp = self._interceptor.post_create_reservation_group(resp) - response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_create_reservation_group_with_metadata(resp, response_metadata) - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - try: - response_payload = reservation.ReservationGroup.to_json(response) - except: - response_payload = None - http_response = { - "payload": response_payload, - "headers": dict(response.headers), - "status": response.status_code, - } - _LOGGER.debug( - "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.create_reservation_group", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "CreateReservationGroup", - "metadata": http_response["headers"], - "httpResponse": http_response, - }, - ) - return resp - - class _DeleteAssignment(_BaseReservationServiceRestTransport._BaseDeleteAssignment, ReservationServiceRestStub): - def __hash__(self): - return hash("ReservationServiceRestTransport.DeleteAssignment") - - @staticmethod - def _get_response( - host, - metadata, - query_params, - session, - timeout, - transcoded_request, - body=None): - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(session, method)( - "{host}{uri}".format(host=host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - return response - - def __call__(self, - request: reservation.DeleteAssignmentRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), - ): - r"""Call the delete assignment method over HTTP. - - Args: - request (~.reservation.DeleteAssignmentRequest): - The request object. The request for - [ReservationService.DeleteAssignment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteAssignment]. - Note: "bigquery.reservationAssignments.delete" - permission is required on the related assignee. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - """ - - http_options = _BaseReservationServiceRestTransport._BaseDeleteAssignment._get_http_options() - - request, metadata = self._interceptor.pre_delete_assignment(request, metadata) - transcoded_request = _BaseReservationServiceRestTransport._BaseDeleteAssignment._get_transcoded_request(http_options, request) - - # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseDeleteAssignment._get_query_params_json(transcoded_request) - - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) - method = transcoded_request['method'] - try: - request_payload = json_format.MessageToJson(request) - except: - request_payload = None - http_request = { - "payload": request_payload, - "requestMethod": method, - "requestUrl": request_url, - "headers": dict(metadata), - } - _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.DeleteAssignment", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "DeleteAssignment", - "httpRequest": http_request, - "metadata": http_request["headers"], - }, - ) - - # Send the request - response = ReservationServiceRestTransport._DeleteAssignment._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - class _DeleteCapacityCommitment(_BaseReservationServiceRestTransport._BaseDeleteCapacityCommitment, ReservationServiceRestStub): - def __hash__(self): - return hash("ReservationServiceRestTransport.DeleteCapacityCommitment") - - @staticmethod - def _get_response( - host, - metadata, - query_params, - session, - timeout, - transcoded_request, - body=None): - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(session, method)( - "{host}{uri}".format(host=host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - return response - - def __call__(self, - request: reservation.DeleteCapacityCommitmentRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), - ): - r"""Call the delete capacity - commitment method over HTTP. - - Args: - request (~.reservation.DeleteCapacityCommitmentRequest): - The request object. The request for - [ReservationService.DeleteCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteCapacityCommitment]. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - """ - - http_options = _BaseReservationServiceRestTransport._BaseDeleteCapacityCommitment._get_http_options() - - request, metadata = self._interceptor.pre_delete_capacity_commitment(request, metadata) - transcoded_request = _BaseReservationServiceRestTransport._BaseDeleteCapacityCommitment._get_transcoded_request(http_options, request) - - # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseDeleteCapacityCommitment._get_query_params_json(transcoded_request) - - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) - method = transcoded_request['method'] - try: - request_payload = json_format.MessageToJson(request) - except: - request_payload = None - http_request = { - "payload": request_payload, - "requestMethod": method, - "requestUrl": request_url, - "headers": dict(metadata), - } - _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.DeleteCapacityCommitment", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "DeleteCapacityCommitment", - "httpRequest": http_request, - "metadata": http_request["headers"], - }, - ) - - # Send the request - response = ReservationServiceRestTransport._DeleteCapacityCommitment._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - class _DeleteReservation(_BaseReservationServiceRestTransport._BaseDeleteReservation, ReservationServiceRestStub): - def __hash__(self): - return hash("ReservationServiceRestTransport.DeleteReservation") - - @staticmethod - def _get_response( - host, - metadata, - query_params, - session, - timeout, - transcoded_request, - body=None): - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(session, method)( - "{host}{uri}".format(host=host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - return response - - def __call__(self, - request: reservation.DeleteReservationRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), - ): - r"""Call the delete reservation method over HTTP. - - Args: - request (~.reservation.DeleteReservationRequest): - The request object. The request for - [ReservationService.DeleteReservation][google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservation]. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - """ - - http_options = _BaseReservationServiceRestTransport._BaseDeleteReservation._get_http_options() - - request, metadata = self._interceptor.pre_delete_reservation(request, metadata) - transcoded_request = _BaseReservationServiceRestTransport._BaseDeleteReservation._get_transcoded_request(http_options, request) - - # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseDeleteReservation._get_query_params_json(transcoded_request) - - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) - method = transcoded_request['method'] - try: - request_payload = json_format.MessageToJson(request) - except: - request_payload = None - http_request = { - "payload": request_payload, - "requestMethod": method, - "requestUrl": request_url, - "headers": dict(metadata), - } - _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.DeleteReservation", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "DeleteReservation", - "httpRequest": http_request, - "metadata": http_request["headers"], - }, - ) - - # Send the request - response = ReservationServiceRestTransport._DeleteReservation._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - class _DeleteReservationGroup(_BaseReservationServiceRestTransport._BaseDeleteReservationGroup, ReservationServiceRestStub): - def __hash__(self): - return hash("ReservationServiceRestTransport.DeleteReservationGroup") - - @staticmethod - def _get_response( - host, - metadata, - query_params, - session, - timeout, - transcoded_request, - body=None): - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(session, method)( - "{host}{uri}".format(host=host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - return response - - def __call__(self, - request: reservation.DeleteReservationGroupRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), - ): - r"""Call the delete reservation group method over HTTP. - - Args: - request (~.reservation.DeleteReservationGroupRequest): - The request object. The request for - [ReservationService.DeleteReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservationGroup]. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - """ - - http_options = _BaseReservationServiceRestTransport._BaseDeleteReservationGroup._get_http_options() - - request, metadata = self._interceptor.pre_delete_reservation_group(request, metadata) - transcoded_request = _BaseReservationServiceRestTransport._BaseDeleteReservationGroup._get_transcoded_request(http_options, request) - - # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseDeleteReservationGroup._get_query_params_json(transcoded_request) - - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) - method = transcoded_request['method'] - try: - request_payload = json_format.MessageToJson(request) - except: - request_payload = None - http_request = { - "payload": request_payload, - "requestMethod": method, - "requestUrl": request_url, - "headers": dict(metadata), - } - _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.DeleteReservationGroup", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "DeleteReservationGroup", - "httpRequest": http_request, - "metadata": http_request["headers"], - }, - ) - - # Send the request - response = ReservationServiceRestTransport._DeleteReservationGroup._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - class _FailoverReservation(_BaseReservationServiceRestTransport._BaseFailoverReservation, ReservationServiceRestStub): - def __hash__(self): - return hash("ReservationServiceRestTransport.FailoverReservation") - - @staticmethod - def _get_response( - host, - metadata, - query_params, - session, - timeout, - transcoded_request, - body=None): - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(session, method)( - "{host}{uri}".format(host=host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - return response - - def __call__(self, - request: reservation.FailoverReservationRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), - ) -> reservation.Reservation: - r"""Call the failover reservation method over HTTP. - - Args: - request (~.reservation.FailoverReservationRequest): - The request object. The request for - ReservationService.FailoverReservation. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - ~.reservation.Reservation: - A reservation is a mechanism used to - guarantee slots to users. - - """ - - http_options = _BaseReservationServiceRestTransport._BaseFailoverReservation._get_http_options() - - request, metadata = self._interceptor.pre_failover_reservation(request, metadata) - transcoded_request = _BaseReservationServiceRestTransport._BaseFailoverReservation._get_transcoded_request(http_options, request) - - body = _BaseReservationServiceRestTransport._BaseFailoverReservation._get_request_body_json(transcoded_request) - - # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseFailoverReservation._get_query_params_json(transcoded_request) - - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) - method = transcoded_request['method'] - try: - request_payload = type(request).to_json(request) - except: - request_payload = None - http_request = { - "payload": request_payload, - "requestMethod": method, - "requestUrl": request_url, - "headers": dict(metadata), - } - _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.FailoverReservation", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "FailoverReservation", - "httpRequest": http_request, - "metadata": http_request["headers"], - }, - ) - - # Send the request - response = ReservationServiceRestTransport._FailoverReservation._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request, 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 = reservation.Reservation() - pb_resp = reservation.Reservation.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - - resp = self._interceptor.post_failover_reservation(resp) - response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_failover_reservation_with_metadata(resp, response_metadata) - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - try: - response_payload = reservation.Reservation.to_json(response) - except: - response_payload = None - http_response = { - "payload": response_payload, - "headers": dict(response.headers), - "status": response.status_code, - } - _LOGGER.debug( - "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.failover_reservation", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "FailoverReservation", - "metadata": http_response["headers"], - "httpResponse": http_response, - }, - ) - return resp - - class _GetBiReservation(_BaseReservationServiceRestTransport._BaseGetBiReservation, ReservationServiceRestStub): - def __hash__(self): - return hash("ReservationServiceRestTransport.GetBiReservation") - - @staticmethod - def _get_response( - host, - metadata, - query_params, - session, - timeout, - transcoded_request, - body=None): - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(session, method)( - "{host}{uri}".format(host=host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - return response - - def __call__(self, - request: reservation.GetBiReservationRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), - ) -> reservation.BiReservation: - r"""Call the get bi reservation method over HTTP. - - Args: - request (~.reservation.GetBiReservationRequest): - The request object. A request to get a singleton BI - reservation. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - ~.reservation.BiReservation: - Represents a BI Reservation. - """ - - http_options = _BaseReservationServiceRestTransport._BaseGetBiReservation._get_http_options() - - request, metadata = self._interceptor.pre_get_bi_reservation(request, metadata) - transcoded_request = _BaseReservationServiceRestTransport._BaseGetBiReservation._get_transcoded_request(http_options, request) - - # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseGetBiReservation._get_query_params_json(transcoded_request) - - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) - method = transcoded_request['method'] - try: - request_payload = type(request).to_json(request) - except: - request_payload = None - http_request = { - "payload": request_payload, - "requestMethod": method, - "requestUrl": request_url, - "headers": dict(metadata), - } - _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.GetBiReservation", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "GetBiReservation", - "httpRequest": http_request, - "metadata": http_request["headers"], - }, - ) - - # Send the request - response = ReservationServiceRestTransport._GetBiReservation._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request) - - # 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 = reservation.BiReservation() - pb_resp = reservation.BiReservation.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - - resp = self._interceptor.post_get_bi_reservation(resp) - response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_get_bi_reservation_with_metadata(resp, response_metadata) - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - try: - response_payload = reservation.BiReservation.to_json(response) - except: - response_payload = None - http_response = { - "payload": response_payload, - "headers": dict(response.headers), - "status": response.status_code, - } - _LOGGER.debug( - "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.get_bi_reservation", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "GetBiReservation", - "metadata": http_response["headers"], - "httpResponse": http_response, - }, - ) - return resp - - class _GetCapacityCommitment(_BaseReservationServiceRestTransport._BaseGetCapacityCommitment, ReservationServiceRestStub): - def __hash__(self): - return hash("ReservationServiceRestTransport.GetCapacityCommitment") - - @staticmethod - def _get_response( - host, - metadata, - query_params, - session, - timeout, - transcoded_request, - body=None): - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(session, method)( - "{host}{uri}".format(host=host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - return response - - def __call__(self, - request: reservation.GetCapacityCommitmentRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), - ) -> reservation.CapacityCommitment: - r"""Call the get capacity commitment method over HTTP. - - Args: - request (~.reservation.GetCapacityCommitmentRequest): - The request object. The request for - [ReservationService.GetCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitment]. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - ~.reservation.CapacityCommitment: - Capacity commitment is a way to - purchase compute capacity for BigQuery - jobs (in the form of slots) with some - committed period of usage. Annual - commitments renew by default. - Commitments can be removed after their - commitment end time passes. - - In order to remove annual commitment, - its plan needs to be changed to monthly - or flex first. - - A capacity commitment resource exists as - a child resource of the admin project. - - """ - - http_options = _BaseReservationServiceRestTransport._BaseGetCapacityCommitment._get_http_options() - - request, metadata = self._interceptor.pre_get_capacity_commitment(request, metadata) - transcoded_request = _BaseReservationServiceRestTransport._BaseGetCapacityCommitment._get_transcoded_request(http_options, request) - - # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseGetCapacityCommitment._get_query_params_json(transcoded_request) - - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) - method = transcoded_request['method'] - try: - request_payload = type(request).to_json(request) - except: - request_payload = None - http_request = { - "payload": request_payload, - "requestMethod": method, - "requestUrl": request_url, - "headers": dict(metadata), - } - _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.GetCapacityCommitment", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "GetCapacityCommitment", - "httpRequest": http_request, - "metadata": http_request["headers"], - }, - ) - - # Send the request - response = ReservationServiceRestTransport._GetCapacityCommitment._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request) - - # 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 = reservation.CapacityCommitment() - pb_resp = reservation.CapacityCommitment.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - - resp = self._interceptor.post_get_capacity_commitment(resp) - response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_get_capacity_commitment_with_metadata(resp, response_metadata) - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - try: - response_payload = reservation.CapacityCommitment.to_json(response) - except: - response_payload = None - http_response = { - "payload": response_payload, - "headers": dict(response.headers), - "status": response.status_code, - } - _LOGGER.debug( - "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.get_capacity_commitment", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "GetCapacityCommitment", - "metadata": http_response["headers"], - "httpResponse": http_response, - }, - ) - return resp - - class _GetIamPolicy(_BaseReservationServiceRestTransport._BaseGetIamPolicy, ReservationServiceRestStub): - def __hash__(self): - return hash("ReservationServiceRestTransport.GetIamPolicy") - - @staticmethod - def _get_response( - host, - metadata, - query_params, - session, - timeout, - transcoded_request, - body=None): - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(session, method)( - "{host}{uri}".format(host=host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - return response - - def __call__(self, - request: iam_policy_pb2.GetIamPolicyRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), - ) -> policy_pb2.Policy: - r"""Call the get iam policy method over HTTP. - - Args: - request (~.iam_policy_pb2.GetIamPolicyRequest): - The request object. Request message for ``GetIamPolicy`` 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - ~.policy_pb2.Policy: - An Identity and Access Management (IAM) policy, which - specifies access controls for Google Cloud resources. - - A ``Policy`` is a collection of ``bindings``. A - ``binding`` binds one or more ``members``, or - principals, to a single ``role``. Principals can be user - accounts, service accounts, Google groups, and domains - (such as G Suite). A ``role`` is a named list of - permissions; each ``role`` can be an IAM predefined role - or a user-created custom role. - - For some types of Google Cloud resources, a ``binding`` - can also specify a ``condition``, which is a logical - expression that allows access to a resource only if the - expression evaluates to ``true``. A condition can add - constraints based on attributes of the request, the - resource, or both. To learn which resources support - conditions in their IAM policies, see the `IAM - documentation `__. - - **JSON example:** - - :: - - { - "bindings": [ - { - "role": "roles/resourcemanager.organizationAdmin", - "members": [ - "user:mike@example.com", - "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" - ] - }, - { - "role": "roles/resourcemanager.organizationViewer", - "members": [ - "user:eve@example.com" - ], - "condition": { - "title": "expirable access", - "description": "Does not grant access after Sep 2020", - "expression": "request.time < - timestamp('2020-10-01T00:00:00.000Z')", - } - } - ], - "etag": "BwWWja0YfJA=", - "version": 3 - } - - **YAML example:** - - :: - - bindings: - - members: - - user:mike@example.com - - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com - role: roles/resourcemanager.organizationAdmin - - members: - - user:eve@example.com - role: roles/resourcemanager.organizationViewer - condition: - title: expirable access - description: Does not grant access after Sep 2020 - expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 - - For a description of IAM and its features, see the `IAM - documentation `__. - - """ - - http_options = _BaseReservationServiceRestTransport._BaseGetIamPolicy._get_http_options() - - request, metadata = self._interceptor.pre_get_iam_policy(request, metadata) - transcoded_request = _BaseReservationServiceRestTransport._BaseGetIamPolicy._get_transcoded_request(http_options, request) - - # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseGetIamPolicy._get_query_params_json(transcoded_request) - - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) - method = transcoded_request['method'] - try: - request_payload = json_format.MessageToJson(request) - except: - request_payload = None - http_request = { - "payload": request_payload, - "requestMethod": method, - "requestUrl": request_url, - "headers": dict(metadata), - } - _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.GetIamPolicy", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "GetIamPolicy", - "httpRequest": http_request, - "metadata": http_request["headers"], - }, - ) - - # Send the request - response = ReservationServiceRestTransport._GetIamPolicy._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request) - - # 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 = policy_pb2.Policy() - pb_resp = resp - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - - resp = self._interceptor.post_get_iam_policy(resp) - response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_get_iam_policy_with_metadata(resp, response_metadata) - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - try: - response_payload = json_format.MessageToJson(resp) - except: - response_payload = None - http_response = { - "payload": response_payload, - "headers": dict(response.headers), - "status": response.status_code, - } - _LOGGER.debug( - "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.get_iam_policy", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "GetIamPolicy", - "metadata": http_response["headers"], - "httpResponse": http_response, - }, - ) - return resp - - class _GetReservation(_BaseReservationServiceRestTransport._BaseGetReservation, ReservationServiceRestStub): - def __hash__(self): - return hash("ReservationServiceRestTransport.GetReservation") - - @staticmethod - def _get_response( - host, - metadata, - query_params, - session, - timeout, - transcoded_request, - body=None): - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(session, method)( - "{host}{uri}".format(host=host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - return response - - def __call__(self, - request: reservation.GetReservationRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), - ) -> reservation.Reservation: - r"""Call the get reservation method over HTTP. - - Args: - request (~.reservation.GetReservationRequest): - The request object. The request for - [ReservationService.GetReservation][google.cloud.bigquery.reservation.v1.ReservationService.GetReservation]. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - ~.reservation.Reservation: - A reservation is a mechanism used to - guarantee slots to users. - - """ - - http_options = _BaseReservationServiceRestTransport._BaseGetReservation._get_http_options() - - request, metadata = self._interceptor.pre_get_reservation(request, metadata) - transcoded_request = _BaseReservationServiceRestTransport._BaseGetReservation._get_transcoded_request(http_options, request) - - # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseGetReservation._get_query_params_json(transcoded_request) - - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) - method = transcoded_request['method'] - try: - request_payload = type(request).to_json(request) - except: - request_payload = None - http_request = { - "payload": request_payload, - "requestMethod": method, - "requestUrl": request_url, - "headers": dict(metadata), - } - _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.GetReservation", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "GetReservation", - "httpRequest": http_request, - "metadata": http_request["headers"], - }, - ) - - # Send the request - response = ReservationServiceRestTransport._GetReservation._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request) - - # 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 = reservation.Reservation() - pb_resp = reservation.Reservation.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - - resp = self._interceptor.post_get_reservation(resp) - response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_get_reservation_with_metadata(resp, response_metadata) - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - try: - response_payload = reservation.Reservation.to_json(response) - except: - response_payload = None - http_response = { - "payload": response_payload, - "headers": dict(response.headers), - "status": response.status_code, - } - _LOGGER.debug( - "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.get_reservation", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "GetReservation", - "metadata": http_response["headers"], - "httpResponse": http_response, - }, - ) - return resp - - class _GetReservationGroup(_BaseReservationServiceRestTransport._BaseGetReservationGroup, ReservationServiceRestStub): - def __hash__(self): - return hash("ReservationServiceRestTransport.GetReservationGroup") - - @staticmethod - def _get_response( - host, - metadata, - query_params, - session, - timeout, - transcoded_request, - body=None): - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(session, method)( - "{host}{uri}".format(host=host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - return response - - def __call__(self, - request: reservation.GetReservationGroupRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), - ) -> reservation.ReservationGroup: - r"""Call the get reservation group method over HTTP. - - Args: - request (~.reservation.GetReservationGroupRequest): - The request object. The request for - [ReservationService.GetReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.GetReservationGroup]. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - ~.reservation.ReservationGroup: - A reservation group is a container - for reservations. - - """ - - http_options = _BaseReservationServiceRestTransport._BaseGetReservationGroup._get_http_options() - - request, metadata = self._interceptor.pre_get_reservation_group(request, metadata) - transcoded_request = _BaseReservationServiceRestTransport._BaseGetReservationGroup._get_transcoded_request(http_options, request) - - # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseGetReservationGroup._get_query_params_json(transcoded_request) - - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) - method = transcoded_request['method'] - try: - request_payload = type(request).to_json(request) - except: - request_payload = None - http_request = { - "payload": request_payload, - "requestMethod": method, - "requestUrl": request_url, - "headers": dict(metadata), - } - _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.GetReservationGroup", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "GetReservationGroup", - "httpRequest": http_request, - "metadata": http_request["headers"], - }, - ) - - # Send the request - response = ReservationServiceRestTransport._GetReservationGroup._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request) - - # 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 = reservation.ReservationGroup() - pb_resp = reservation.ReservationGroup.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - - resp = self._interceptor.post_get_reservation_group(resp) - response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_get_reservation_group_with_metadata(resp, response_metadata) - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - try: - response_payload = reservation.ReservationGroup.to_json(response) - except: - response_payload = None - http_response = { - "payload": response_payload, - "headers": dict(response.headers), - "status": response.status_code, - } - _LOGGER.debug( - "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.get_reservation_group", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "GetReservationGroup", - "metadata": http_response["headers"], - "httpResponse": http_response, - }, - ) - return resp - - class _ListAssignments(_BaseReservationServiceRestTransport._BaseListAssignments, ReservationServiceRestStub): - def __hash__(self): - return hash("ReservationServiceRestTransport.ListAssignments") - - @staticmethod - def _get_response( - host, - metadata, - query_params, - session, - timeout, - transcoded_request, - body=None): - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(session, method)( - "{host}{uri}".format(host=host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - return response - - def __call__(self, - request: reservation.ListAssignmentsRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), - ) -> reservation.ListAssignmentsResponse: - r"""Call the list assignments method over HTTP. - - Args: - request (~.reservation.ListAssignmentsRequest): - The request object. The request for - [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments]. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - ~.reservation.ListAssignmentsResponse: - The response for - [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments]. - - """ - - http_options = _BaseReservationServiceRestTransport._BaseListAssignments._get_http_options() - - request, metadata = self._interceptor.pre_list_assignments(request, metadata) - transcoded_request = _BaseReservationServiceRestTransport._BaseListAssignments._get_transcoded_request(http_options, request) - - # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseListAssignments._get_query_params_json(transcoded_request) - - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) - method = transcoded_request['method'] - try: - request_payload = type(request).to_json(request) - except: - request_payload = None - http_request = { - "payload": request_payload, - "requestMethod": method, - "requestUrl": request_url, - "headers": dict(metadata), - } - _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.ListAssignments", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "ListAssignments", - "httpRequest": http_request, - "metadata": http_request["headers"], - }, - ) - - # Send the request - response = ReservationServiceRestTransport._ListAssignments._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request) - - # 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 = reservation.ListAssignmentsResponse() - pb_resp = reservation.ListAssignmentsResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - - resp = self._interceptor.post_list_assignments(resp) - response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_list_assignments_with_metadata(resp, response_metadata) - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - try: - response_payload = reservation.ListAssignmentsResponse.to_json(response) - except: - response_payload = None - http_response = { - "payload": response_payload, - "headers": dict(response.headers), - "status": response.status_code, - } - _LOGGER.debug( - "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.list_assignments", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "ListAssignments", - "metadata": http_response["headers"], - "httpResponse": http_response, - }, - ) - return resp - - class _ListCapacityCommitments(_BaseReservationServiceRestTransport._BaseListCapacityCommitments, ReservationServiceRestStub): - def __hash__(self): - return hash("ReservationServiceRestTransport.ListCapacityCommitments") - - @staticmethod - def _get_response( - host, - metadata, - query_params, - session, - timeout, - transcoded_request, - body=None): - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(session, method)( - "{host}{uri}".format(host=host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - return response - - def __call__(self, - request: reservation.ListCapacityCommitmentsRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), - ) -> reservation.ListCapacityCommitmentsResponse: - r"""Call the list capacity commitments method over HTTP. - - Args: - request (~.reservation.ListCapacityCommitmentsRequest): - The request object. The request for - [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments]. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - ~.reservation.ListCapacityCommitmentsResponse: - The response for - [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments]. - - """ - - http_options = _BaseReservationServiceRestTransport._BaseListCapacityCommitments._get_http_options() - - request, metadata = self._interceptor.pre_list_capacity_commitments(request, metadata) - transcoded_request = _BaseReservationServiceRestTransport._BaseListCapacityCommitments._get_transcoded_request(http_options, request) - - # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseListCapacityCommitments._get_query_params_json(transcoded_request) - - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) - method = transcoded_request['method'] - try: - request_payload = type(request).to_json(request) - except: - request_payload = None - http_request = { - "payload": request_payload, - "requestMethod": method, - "requestUrl": request_url, - "headers": dict(metadata), - } - _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.ListCapacityCommitments", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "ListCapacityCommitments", - "httpRequest": http_request, - "metadata": http_request["headers"], - }, - ) - - # Send the request - response = ReservationServiceRestTransport._ListCapacityCommitments._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request) - - # 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 = reservation.ListCapacityCommitmentsResponse() - pb_resp = reservation.ListCapacityCommitmentsResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - - resp = self._interceptor.post_list_capacity_commitments(resp) - response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_list_capacity_commitments_with_metadata(resp, response_metadata) - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - try: - response_payload = reservation.ListCapacityCommitmentsResponse.to_json(response) - except: - response_payload = None - http_response = { - "payload": response_payload, - "headers": dict(response.headers), - "status": response.status_code, - } - _LOGGER.debug( - "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.list_capacity_commitments", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "ListCapacityCommitments", - "metadata": http_response["headers"], - "httpResponse": http_response, - }, - ) - return resp - - class _ListReservationGroups(_BaseReservationServiceRestTransport._BaseListReservationGroups, ReservationServiceRestStub): - def __hash__(self): - return hash("ReservationServiceRestTransport.ListReservationGroups") - - @staticmethod - def _get_response( - host, - metadata, - query_params, - session, - timeout, - transcoded_request, - body=None): - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(session, method)( - "{host}{uri}".format(host=host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - return response - - def __call__(self, - request: reservation.ListReservationGroupsRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), - ) -> reservation.ListReservationGroupsResponse: - r"""Call the list reservation groups method over HTTP. - - Args: - request (~.reservation.ListReservationGroupsRequest): - The request object. The request for - [ReservationService.ListReservationGroups][google.cloud.bigquery.reservation.v1.ReservationService.ListReservationGroups]. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - ~.reservation.ListReservationGroupsResponse: - The response for - [ReservationService.ListReservationGroups][google.cloud.bigquery.reservation.v1.ReservationService.ListReservationGroups]. - - """ - - http_options = _BaseReservationServiceRestTransport._BaseListReservationGroups._get_http_options() - - request, metadata = self._interceptor.pre_list_reservation_groups(request, metadata) - transcoded_request = _BaseReservationServiceRestTransport._BaseListReservationGroups._get_transcoded_request(http_options, request) - - # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseListReservationGroups._get_query_params_json(transcoded_request) - - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) - method = transcoded_request['method'] - try: - request_payload = type(request).to_json(request) - except: - request_payload = None - http_request = { - "payload": request_payload, - "requestMethod": method, - "requestUrl": request_url, - "headers": dict(metadata), - } - _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.ListReservationGroups", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "ListReservationGroups", - "httpRequest": http_request, - "metadata": http_request["headers"], - }, - ) - - # Send the request - response = ReservationServiceRestTransport._ListReservationGroups._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request) - - # 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 = reservation.ListReservationGroupsResponse() - pb_resp = reservation.ListReservationGroupsResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - - resp = self._interceptor.post_list_reservation_groups(resp) - response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_list_reservation_groups_with_metadata(resp, response_metadata) - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - try: - response_payload = reservation.ListReservationGroupsResponse.to_json(response) - except: - response_payload = None - http_response = { - "payload": response_payload, - "headers": dict(response.headers), - "status": response.status_code, - } - _LOGGER.debug( - "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.list_reservation_groups", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "ListReservationGroups", - "metadata": http_response["headers"], - "httpResponse": http_response, - }, - ) - return resp - - class _ListReservations(_BaseReservationServiceRestTransport._BaseListReservations, ReservationServiceRestStub): - def __hash__(self): - return hash("ReservationServiceRestTransport.ListReservations") - - @staticmethod - def _get_response( - host, - metadata, - query_params, - session, - timeout, - transcoded_request, - body=None): - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(session, method)( - "{host}{uri}".format(host=host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - return response - - def __call__(self, - request: reservation.ListReservationsRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), - ) -> reservation.ListReservationsResponse: - r"""Call the list reservations method over HTTP. - - Args: - request (~.reservation.ListReservationsRequest): - The request object. The request for - [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations]. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - ~.reservation.ListReservationsResponse: - The response for - [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations]. - - """ - - http_options = _BaseReservationServiceRestTransport._BaseListReservations._get_http_options() - - request, metadata = self._interceptor.pre_list_reservations(request, metadata) - transcoded_request = _BaseReservationServiceRestTransport._BaseListReservations._get_transcoded_request(http_options, request) - - # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseListReservations._get_query_params_json(transcoded_request) - - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) - method = transcoded_request['method'] - try: - request_payload = type(request).to_json(request) - except: - request_payload = None - http_request = { - "payload": request_payload, - "requestMethod": method, - "requestUrl": request_url, - "headers": dict(metadata), - } - _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.ListReservations", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "ListReservations", - "httpRequest": http_request, - "metadata": http_request["headers"], - }, - ) - - # Send the request - response = ReservationServiceRestTransport._ListReservations._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request) - - # 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 = reservation.ListReservationsResponse() - pb_resp = reservation.ListReservationsResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - - resp = self._interceptor.post_list_reservations(resp) - response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_list_reservations_with_metadata(resp, response_metadata) - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - try: - response_payload = reservation.ListReservationsResponse.to_json(response) - except: - response_payload = None - http_response = { - "payload": response_payload, - "headers": dict(response.headers), - "status": response.status_code, - } - _LOGGER.debug( - "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.list_reservations", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "ListReservations", - "metadata": http_response["headers"], - "httpResponse": http_response, - }, - ) - return resp - - class _MergeCapacityCommitments(_BaseReservationServiceRestTransport._BaseMergeCapacityCommitments, ReservationServiceRestStub): - def __hash__(self): - return hash("ReservationServiceRestTransport.MergeCapacityCommitments") - - @staticmethod - def _get_response( - host, - metadata, - query_params, - session, - timeout, - transcoded_request, - body=None): - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(session, method)( - "{host}{uri}".format(host=host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - return response - - def __call__(self, - request: reservation.MergeCapacityCommitmentsRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), - ) -> reservation.CapacityCommitment: - r"""Call the merge capacity - commitments method over HTTP. - - Args: - request (~.reservation.MergeCapacityCommitmentsRequest): - The request object. The request for - [ReservationService.MergeCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.MergeCapacityCommitments]. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - ~.reservation.CapacityCommitment: - Capacity commitment is a way to - purchase compute capacity for BigQuery - jobs (in the form of slots) with some - committed period of usage. Annual - commitments renew by default. - Commitments can be removed after their - commitment end time passes. - - In order to remove annual commitment, - its plan needs to be changed to monthly - or flex first. - - A capacity commitment resource exists as - a child resource of the admin project. - - """ - - http_options = _BaseReservationServiceRestTransport._BaseMergeCapacityCommitments._get_http_options() - - request, metadata = self._interceptor.pre_merge_capacity_commitments(request, metadata) - transcoded_request = _BaseReservationServiceRestTransport._BaseMergeCapacityCommitments._get_transcoded_request(http_options, request) - - body = _BaseReservationServiceRestTransport._BaseMergeCapacityCommitments._get_request_body_json(transcoded_request) - - # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseMergeCapacityCommitments._get_query_params_json(transcoded_request) - - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) - method = transcoded_request['method'] - try: - request_payload = type(request).to_json(request) - except: - request_payload = None - http_request = { - "payload": request_payload, - "requestMethod": method, - "requestUrl": request_url, - "headers": dict(metadata), - } - _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.MergeCapacityCommitments", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "MergeCapacityCommitments", - "httpRequest": http_request, - "metadata": http_request["headers"], - }, - ) - - # Send the request - response = ReservationServiceRestTransport._MergeCapacityCommitments._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request, 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 = reservation.CapacityCommitment() - pb_resp = reservation.CapacityCommitment.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - - resp = self._interceptor.post_merge_capacity_commitments(resp) - response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_merge_capacity_commitments_with_metadata(resp, response_metadata) - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - try: - response_payload = reservation.CapacityCommitment.to_json(response) - except: - response_payload = None - http_response = { - "payload": response_payload, - "headers": dict(response.headers), - "status": response.status_code, - } - _LOGGER.debug( - "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.merge_capacity_commitments", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "MergeCapacityCommitments", - "metadata": http_response["headers"], - "httpResponse": http_response, - }, - ) - return resp - - class _MoveAssignment(_BaseReservationServiceRestTransport._BaseMoveAssignment, ReservationServiceRestStub): - def __hash__(self): - return hash("ReservationServiceRestTransport.MoveAssignment") - - @staticmethod - def _get_response( - host, - metadata, - query_params, - session, - timeout, - transcoded_request, - body=None): - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(session, method)( - "{host}{uri}".format(host=host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - return response - - def __call__(self, - request: reservation.MoveAssignmentRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), - ) -> reservation.Assignment: - r"""Call the move assignment method over HTTP. - - Args: - request (~.reservation.MoveAssignmentRequest): - The request object. The request for - [ReservationService.MoveAssignment][google.cloud.bigquery.reservation.v1.ReservationService.MoveAssignment]. - - **Note**: "bigquery.reservationAssignments.create" - permission is required on the destination_id. - - **Note**: "bigquery.reservationAssignments.create" and - "bigquery.reservationAssignments.delete" permission are - required on the related assignee. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - ~.reservation.Assignment: - An assignment allows a project to - submit jobs of a certain type using - slots from the specified reservation. - - """ - - http_options = _BaseReservationServiceRestTransport._BaseMoveAssignment._get_http_options() - - request, metadata = self._interceptor.pre_move_assignment(request, metadata) - transcoded_request = _BaseReservationServiceRestTransport._BaseMoveAssignment._get_transcoded_request(http_options, request) - - body = _BaseReservationServiceRestTransport._BaseMoveAssignment._get_request_body_json(transcoded_request) - - # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseMoveAssignment._get_query_params_json(transcoded_request) - - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) - method = transcoded_request['method'] - try: - request_payload = type(request).to_json(request) - except: - request_payload = None - http_request = { - "payload": request_payload, - "requestMethod": method, - "requestUrl": request_url, - "headers": dict(metadata), - } - _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.MoveAssignment", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "MoveAssignment", - "httpRequest": http_request, - "metadata": http_request["headers"], - }, - ) - - # Send the request - response = ReservationServiceRestTransport._MoveAssignment._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request, 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 = reservation.Assignment() - pb_resp = reservation.Assignment.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - - resp = self._interceptor.post_move_assignment(resp) - response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_move_assignment_with_metadata(resp, response_metadata) - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - try: - response_payload = reservation.Assignment.to_json(response) - except: - response_payload = None - http_response = { - "payload": response_payload, - "headers": dict(response.headers), - "status": response.status_code, - } - _LOGGER.debug( - "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.move_assignment", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "MoveAssignment", - "metadata": http_response["headers"], - "httpResponse": http_response, - }, - ) - return resp - - class _SearchAllAssignments(_BaseReservationServiceRestTransport._BaseSearchAllAssignments, ReservationServiceRestStub): - def __hash__(self): - return hash("ReservationServiceRestTransport.SearchAllAssignments") - - @staticmethod - def _get_response( - host, - metadata, - query_params, - session, - timeout, - transcoded_request, - body=None): - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(session, method)( - "{host}{uri}".format(host=host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - return response - - def __call__(self, - request: reservation.SearchAllAssignmentsRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), - ) -> reservation.SearchAllAssignmentsResponse: - r"""Call the search all assignments method over HTTP. - - Args: - request (~.reservation.SearchAllAssignmentsRequest): - The request object. The request for - [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. - Note: "bigquery.reservationAssignments.search" - permission is required on the related assignee. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - ~.reservation.SearchAllAssignmentsResponse: - The response for - [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. - - """ - - http_options = _BaseReservationServiceRestTransport._BaseSearchAllAssignments._get_http_options() - - request, metadata = self._interceptor.pre_search_all_assignments(request, metadata) - transcoded_request = _BaseReservationServiceRestTransport._BaseSearchAllAssignments._get_transcoded_request(http_options, request) - - # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseSearchAllAssignments._get_query_params_json(transcoded_request) - - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) - method = transcoded_request['method'] - try: - request_payload = type(request).to_json(request) - except: - request_payload = None - http_request = { - "payload": request_payload, - "requestMethod": method, - "requestUrl": request_url, - "headers": dict(metadata), - } - _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.SearchAllAssignments", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "SearchAllAssignments", - "httpRequest": http_request, - "metadata": http_request["headers"], - }, - ) - - # Send the request - response = ReservationServiceRestTransport._SearchAllAssignments._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request) - - # 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 = reservation.SearchAllAssignmentsResponse() - pb_resp = reservation.SearchAllAssignmentsResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - - resp = self._interceptor.post_search_all_assignments(resp) - response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_search_all_assignments_with_metadata(resp, response_metadata) - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - try: - response_payload = reservation.SearchAllAssignmentsResponse.to_json(response) - except: - response_payload = None - http_response = { - "payload": response_payload, - "headers": dict(response.headers), - "status": response.status_code, - } - _LOGGER.debug( - "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.search_all_assignments", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "SearchAllAssignments", - "metadata": http_response["headers"], - "httpResponse": http_response, - }, - ) - return resp - - class _SearchAssignments(_BaseReservationServiceRestTransport._BaseSearchAssignments, ReservationServiceRestStub): - def __hash__(self): - return hash("ReservationServiceRestTransport.SearchAssignments") - - @staticmethod - def _get_response( - host, - metadata, - query_params, - session, - timeout, - transcoded_request, - body=None): - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(session, method)( - "{host}{uri}".format(host=host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - return response - - def __call__(self, - request: reservation.SearchAssignmentsRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), - ) -> reservation.SearchAssignmentsResponse: - r"""Call the search assignments method over HTTP. - - Args: - request (~.reservation.SearchAssignmentsRequest): - The request object. The request for - [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. - Note: "bigquery.reservationAssignments.search" - permission is required on the related assignee. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - ~.reservation.SearchAssignmentsResponse: - The response for - [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. - - """ - - http_options = _BaseReservationServiceRestTransport._BaseSearchAssignments._get_http_options() - - request, metadata = self._interceptor.pre_search_assignments(request, metadata) - transcoded_request = _BaseReservationServiceRestTransport._BaseSearchAssignments._get_transcoded_request(http_options, request) - - # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseSearchAssignments._get_query_params_json(transcoded_request) - - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) - method = transcoded_request['method'] - try: - request_payload = type(request).to_json(request) - except: - request_payload = None - http_request = { - "payload": request_payload, - "requestMethod": method, - "requestUrl": request_url, - "headers": dict(metadata), - } - _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.SearchAssignments", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "SearchAssignments", - "httpRequest": http_request, - "metadata": http_request["headers"], - }, - ) - - # Send the request - response = ReservationServiceRestTransport._SearchAssignments._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request) - - # 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 = reservation.SearchAssignmentsResponse() - pb_resp = reservation.SearchAssignmentsResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - - resp = self._interceptor.post_search_assignments(resp) - response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_search_assignments_with_metadata(resp, response_metadata) - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - try: - response_payload = reservation.SearchAssignmentsResponse.to_json(response) - except: - response_payload = None - http_response = { - "payload": response_payload, - "headers": dict(response.headers), - "status": response.status_code, - } - _LOGGER.debug( - "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.search_assignments", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "SearchAssignments", - "metadata": http_response["headers"], - "httpResponse": http_response, - }, - ) - return resp - - class _SetIamPolicy(_BaseReservationServiceRestTransport._BaseSetIamPolicy, ReservationServiceRestStub): - def __hash__(self): - return hash("ReservationServiceRestTransport.SetIamPolicy") - - @staticmethod - def _get_response( - host, - metadata, - query_params, - session, - timeout, - transcoded_request, - body=None): - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(session, method)( - "{host}{uri}".format(host=host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - return response - - def __call__(self, - request: iam_policy_pb2.SetIamPolicyRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), - ) -> policy_pb2.Policy: - r"""Call the set iam policy method over HTTP. - - Args: - request (~.iam_policy_pb2.SetIamPolicyRequest): - The request object. Request message for ``SetIamPolicy`` 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - ~.policy_pb2.Policy: - An Identity and Access Management (IAM) policy, which - specifies access controls for Google Cloud resources. - - A ``Policy`` is a collection of ``bindings``. A - ``binding`` binds one or more ``members``, or - principals, to a single ``role``. Principals can be user - accounts, service accounts, Google groups, and domains - (such as G Suite). A ``role`` is a named list of - permissions; each ``role`` can be an IAM predefined role - or a user-created custom role. - - For some types of Google Cloud resources, a ``binding`` - can also specify a ``condition``, which is a logical - expression that allows access to a resource only if the - expression evaluates to ``true``. A condition can add - constraints based on attributes of the request, the - resource, or both. To learn which resources support - conditions in their IAM policies, see the `IAM - documentation `__. - - **JSON example:** - - :: - - { - "bindings": [ - { - "role": "roles/resourcemanager.organizationAdmin", - "members": [ - "user:mike@example.com", - "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" - ] - }, - { - "role": "roles/resourcemanager.organizationViewer", - "members": [ - "user:eve@example.com" - ], - "condition": { - "title": "expirable access", - "description": "Does not grant access after Sep 2020", - "expression": "request.time < - timestamp('2020-10-01T00:00:00.000Z')", - } - } - ], - "etag": "BwWWja0YfJA=", - "version": 3 - } - - **YAML example:** - - :: - - bindings: - - members: - - user:mike@example.com - - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com - role: roles/resourcemanager.organizationAdmin - - members: - - user:eve@example.com - role: roles/resourcemanager.organizationViewer - condition: - title: expirable access - description: Does not grant access after Sep 2020 - expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 - - For a description of IAM and its features, see the `IAM - documentation `__. - - """ - - http_options = _BaseReservationServiceRestTransport._BaseSetIamPolicy._get_http_options() - - request, metadata = self._interceptor.pre_set_iam_policy(request, metadata) - transcoded_request = _BaseReservationServiceRestTransport._BaseSetIamPolicy._get_transcoded_request(http_options, request) - - body = _BaseReservationServiceRestTransport._BaseSetIamPolicy._get_request_body_json(transcoded_request) - - # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseSetIamPolicy._get_query_params_json(transcoded_request) - - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) - method = transcoded_request['method'] - try: - request_payload = json_format.MessageToJson(request) - except: - request_payload = None - http_request = { - "payload": request_payload, - "requestMethod": method, - "requestUrl": request_url, - "headers": dict(metadata), - } - _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.SetIamPolicy", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "SetIamPolicy", - "httpRequest": http_request, - "metadata": http_request["headers"], - }, - ) - - # Send the request - response = ReservationServiceRestTransport._SetIamPolicy._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request, 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 = policy_pb2.Policy() - pb_resp = resp - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - - resp = self._interceptor.post_set_iam_policy(resp) - response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_set_iam_policy_with_metadata(resp, response_metadata) - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - try: - response_payload = json_format.MessageToJson(resp) - except: - response_payload = None - http_response = { - "payload": response_payload, - "headers": dict(response.headers), - "status": response.status_code, - } - _LOGGER.debug( - "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.set_iam_policy", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "SetIamPolicy", - "metadata": http_response["headers"], - "httpResponse": http_response, - }, - ) - return resp - - class _SplitCapacityCommitment(_BaseReservationServiceRestTransport._BaseSplitCapacityCommitment, ReservationServiceRestStub): - def __hash__(self): - return hash("ReservationServiceRestTransport.SplitCapacityCommitment") - - @staticmethod - def _get_response( - host, - metadata, - query_params, - session, - timeout, - transcoded_request, - body=None): - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(session, method)( - "{host}{uri}".format(host=host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - return response - - def __call__(self, - request: reservation.SplitCapacityCommitmentRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), - ) -> reservation.SplitCapacityCommitmentResponse: - r"""Call the split capacity commitment method over HTTP. - - Args: - request (~.reservation.SplitCapacityCommitmentRequest): - The request object. The request for - [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment]. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - ~.reservation.SplitCapacityCommitmentResponse: - The response for - [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment]. - - """ - - http_options = _BaseReservationServiceRestTransport._BaseSplitCapacityCommitment._get_http_options() - - request, metadata = self._interceptor.pre_split_capacity_commitment(request, metadata) - transcoded_request = _BaseReservationServiceRestTransport._BaseSplitCapacityCommitment._get_transcoded_request(http_options, request) - - body = _BaseReservationServiceRestTransport._BaseSplitCapacityCommitment._get_request_body_json(transcoded_request) - - # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseSplitCapacityCommitment._get_query_params_json(transcoded_request) - - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) - method = transcoded_request['method'] - try: - request_payload = type(request).to_json(request) - except: - request_payload = None - http_request = { - "payload": request_payload, - "requestMethod": method, - "requestUrl": request_url, - "headers": dict(metadata), - } - _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.SplitCapacityCommitment", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "SplitCapacityCommitment", - "httpRequest": http_request, - "metadata": http_request["headers"], - }, - ) - - # Send the request - response = ReservationServiceRestTransport._SplitCapacityCommitment._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request, 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 = reservation.SplitCapacityCommitmentResponse() - pb_resp = reservation.SplitCapacityCommitmentResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - - resp = self._interceptor.post_split_capacity_commitment(resp) - response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_split_capacity_commitment_with_metadata(resp, response_metadata) - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - try: - response_payload = reservation.SplitCapacityCommitmentResponse.to_json(response) - except: - response_payload = None - http_response = { - "payload": response_payload, - "headers": dict(response.headers), - "status": response.status_code, - } - _LOGGER.debug( - "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.split_capacity_commitment", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "SplitCapacityCommitment", - "metadata": http_response["headers"], - "httpResponse": http_response, - }, - ) - return resp - - class _TestIamPermissions(_BaseReservationServiceRestTransport._BaseTestIamPermissions, ReservationServiceRestStub): - def __hash__(self): - return hash("ReservationServiceRestTransport.TestIamPermissions") - - @staticmethod - def _get_response( - host, - metadata, - query_params, - session, - timeout, - transcoded_request, - body=None): - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(session, method)( - "{host}{uri}".format(host=host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - return response - - def __call__(self, - request: iam_policy_pb2.TestIamPermissionsRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), - ) -> iam_policy_pb2.TestIamPermissionsResponse: - r"""Call the test iam permissions method over HTTP. - - Args: - request (~.iam_policy_pb2.TestIamPermissionsRequest): - The request object. Request message for ``TestIamPermissions`` 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - ~.iam_policy_pb2.TestIamPermissionsResponse: - Response message for ``TestIamPermissions`` method. - """ - - http_options = _BaseReservationServiceRestTransport._BaseTestIamPermissions._get_http_options() - - request, metadata = self._interceptor.pre_test_iam_permissions(request, metadata) - transcoded_request = _BaseReservationServiceRestTransport._BaseTestIamPermissions._get_transcoded_request(http_options, request) - - body = _BaseReservationServiceRestTransport._BaseTestIamPermissions._get_request_body_json(transcoded_request) - - # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseTestIamPermissions._get_query_params_json(transcoded_request) - - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) - method = transcoded_request['method'] - try: - request_payload = json_format.MessageToJson(request) - except: - request_payload = None - http_request = { - "payload": request_payload, - "requestMethod": method, - "requestUrl": request_url, - "headers": dict(metadata), - } - _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.TestIamPermissions", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "TestIamPermissions", - "httpRequest": http_request, - "metadata": http_request["headers"], - }, - ) - - # Send the request - response = ReservationServiceRestTransport._TestIamPermissions._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request, 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 = iam_policy_pb2.TestIamPermissionsResponse() - pb_resp = resp - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - - resp = self._interceptor.post_test_iam_permissions(resp) - response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_test_iam_permissions_with_metadata(resp, response_metadata) - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - try: - response_payload = json_format.MessageToJson(resp) - except: - response_payload = None - http_response = { - "payload": response_payload, - "headers": dict(response.headers), - "status": response.status_code, - } - _LOGGER.debug( - "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.test_iam_permissions", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "TestIamPermissions", - "metadata": http_response["headers"], - "httpResponse": http_response, - }, - ) - return resp - - class _UpdateAssignment(_BaseReservationServiceRestTransport._BaseUpdateAssignment, ReservationServiceRestStub): - def __hash__(self): - return hash("ReservationServiceRestTransport.UpdateAssignment") - - @staticmethod - def _get_response( - host, - metadata, - query_params, - session, - timeout, - transcoded_request, - body=None): - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(session, method)( - "{host}{uri}".format(host=host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - return response - - def __call__(self, - request: reservation.UpdateAssignmentRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), - ) -> reservation.Assignment: - r"""Call the update assignment method over HTTP. - - Args: - request (~.reservation.UpdateAssignmentRequest): - The request object. The request for - [ReservationService.UpdateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateAssignment]. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - ~.reservation.Assignment: - An assignment allows a project to - submit jobs of a certain type using - slots from the specified reservation. - - """ - - http_options = _BaseReservationServiceRestTransport._BaseUpdateAssignment._get_http_options() - - request, metadata = self._interceptor.pre_update_assignment(request, metadata) - transcoded_request = _BaseReservationServiceRestTransport._BaseUpdateAssignment._get_transcoded_request(http_options, request) - - body = _BaseReservationServiceRestTransport._BaseUpdateAssignment._get_request_body_json(transcoded_request) - - # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseUpdateAssignment._get_query_params_json(transcoded_request) - - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) - method = transcoded_request['method'] - try: - request_payload = type(request).to_json(request) - except: - request_payload = None - http_request = { - "payload": request_payload, - "requestMethod": method, - "requestUrl": request_url, - "headers": dict(metadata), - } - _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.UpdateAssignment", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "UpdateAssignment", - "httpRequest": http_request, - "metadata": http_request["headers"], - }, - ) - - # Send the request - response = ReservationServiceRestTransport._UpdateAssignment._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request, 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 = reservation.Assignment() - pb_resp = reservation.Assignment.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - - resp = self._interceptor.post_update_assignment(resp) - response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_update_assignment_with_metadata(resp, response_metadata) - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - try: - response_payload = reservation.Assignment.to_json(response) - except: - response_payload = None - http_response = { - "payload": response_payload, - "headers": dict(response.headers), - "status": response.status_code, - } - _LOGGER.debug( - "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.update_assignment", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "UpdateAssignment", - "metadata": http_response["headers"], - "httpResponse": http_response, - }, - ) - return resp - - class _UpdateBiReservation(_BaseReservationServiceRestTransport._BaseUpdateBiReservation, ReservationServiceRestStub): - def __hash__(self): - return hash("ReservationServiceRestTransport.UpdateBiReservation") - - @staticmethod - def _get_response( - host, - metadata, - query_params, - session, - timeout, - transcoded_request, - body=None): - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(session, method)( - "{host}{uri}".format(host=host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - return response - - def __call__(self, - request: reservation.UpdateBiReservationRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), - ) -> reservation.BiReservation: - r"""Call the update bi reservation method over HTTP. - - Args: - request (~.reservation.UpdateBiReservationRequest): - The request object. A request to update a BI reservation. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - ~.reservation.BiReservation: - Represents a BI Reservation. - """ - - http_options = _BaseReservationServiceRestTransport._BaseUpdateBiReservation._get_http_options() - - request, metadata = self._interceptor.pre_update_bi_reservation(request, metadata) - transcoded_request = _BaseReservationServiceRestTransport._BaseUpdateBiReservation._get_transcoded_request(http_options, request) - - body = _BaseReservationServiceRestTransport._BaseUpdateBiReservation._get_request_body_json(transcoded_request) - - # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseUpdateBiReservation._get_query_params_json(transcoded_request) - - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) - method = transcoded_request['method'] - try: - request_payload = type(request).to_json(request) - except: - request_payload = None - http_request = { - "payload": request_payload, - "requestMethod": method, - "requestUrl": request_url, - "headers": dict(metadata), - } - _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.UpdateBiReservation", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "UpdateBiReservation", - "httpRequest": http_request, - "metadata": http_request["headers"], - }, - ) - - # Send the request - response = ReservationServiceRestTransport._UpdateBiReservation._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request, 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 = reservation.BiReservation() - pb_resp = reservation.BiReservation.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - - resp = self._interceptor.post_update_bi_reservation(resp) - response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_update_bi_reservation_with_metadata(resp, response_metadata) - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - try: - response_payload = reservation.BiReservation.to_json(response) - except: - response_payload = None - http_response = { - "payload": response_payload, - "headers": dict(response.headers), - "status": response.status_code, - } - _LOGGER.debug( - "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.update_bi_reservation", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "UpdateBiReservation", - "metadata": http_response["headers"], - "httpResponse": http_response, - }, - ) - return resp - - class _UpdateCapacityCommitment(_BaseReservationServiceRestTransport._BaseUpdateCapacityCommitment, ReservationServiceRestStub): - def __hash__(self): - return hash("ReservationServiceRestTransport.UpdateCapacityCommitment") - - @staticmethod - def _get_response( - host, - metadata, - query_params, - session, - timeout, - transcoded_request, - body=None): - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(session, method)( - "{host}{uri}".format(host=host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - return response - - def __call__(self, - request: reservation.UpdateCapacityCommitmentRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), - ) -> reservation.CapacityCommitment: - r"""Call the update capacity - commitment method over HTTP. - - Args: - request (~.reservation.UpdateCapacityCommitmentRequest): - The request object. The request for - [ReservationService.UpdateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateCapacityCommitment]. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - ~.reservation.CapacityCommitment: - Capacity commitment is a way to - purchase compute capacity for BigQuery - jobs (in the form of slots) with some - committed period of usage. Annual - commitments renew by default. - Commitments can be removed after their - commitment end time passes. - - In order to remove annual commitment, - its plan needs to be changed to monthly - or flex first. - - A capacity commitment resource exists as - a child resource of the admin project. - - """ - - http_options = _BaseReservationServiceRestTransport._BaseUpdateCapacityCommitment._get_http_options() - - request, metadata = self._interceptor.pre_update_capacity_commitment(request, metadata) - transcoded_request = _BaseReservationServiceRestTransport._BaseUpdateCapacityCommitment._get_transcoded_request(http_options, request) - - body = _BaseReservationServiceRestTransport._BaseUpdateCapacityCommitment._get_request_body_json(transcoded_request) - - # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseUpdateCapacityCommitment._get_query_params_json(transcoded_request) - - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) - method = transcoded_request['method'] - try: - request_payload = type(request).to_json(request) - except: - request_payload = None - http_request = { - "payload": request_payload, - "requestMethod": method, - "requestUrl": request_url, - "headers": dict(metadata), - } - _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.UpdateCapacityCommitment", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "UpdateCapacityCommitment", - "httpRequest": http_request, - "metadata": http_request["headers"], - }, - ) - - # Send the request - response = ReservationServiceRestTransport._UpdateCapacityCommitment._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request, 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 = reservation.CapacityCommitment() - pb_resp = reservation.CapacityCommitment.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - - resp = self._interceptor.post_update_capacity_commitment(resp) - response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_update_capacity_commitment_with_metadata(resp, response_metadata) - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - try: - response_payload = reservation.CapacityCommitment.to_json(response) - except: - response_payload = None - http_response = { - "payload": response_payload, - "headers": dict(response.headers), - "status": response.status_code, - } - _LOGGER.debug( - "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.update_capacity_commitment", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "UpdateCapacityCommitment", - "metadata": http_response["headers"], - "httpResponse": http_response, - }, - ) - return resp - - class _UpdateReservation(_BaseReservationServiceRestTransport._BaseUpdateReservation, ReservationServiceRestStub): - def __hash__(self): - return hash("ReservationServiceRestTransport.UpdateReservation") - - @staticmethod - def _get_response( - host, - metadata, - query_params, - session, - timeout, - transcoded_request, - body=None): - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(session, method)( - "{host}{uri}".format(host=host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - return response - - def __call__(self, - request: gcbr_reservation.UpdateReservationRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), - ) -> gcbr_reservation.Reservation: - r"""Call the update reservation method over HTTP. - - Args: - request (~.gcbr_reservation.UpdateReservationRequest): - The request object. The request for - [ReservationService.UpdateReservation][google.cloud.bigquery.reservation.v1.ReservationService.UpdateReservation]. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - ~.gcbr_reservation.Reservation: - A reservation is a mechanism used to - guarantee slots to users. - - """ - - http_options = _BaseReservationServiceRestTransport._BaseUpdateReservation._get_http_options() - - request, metadata = self._interceptor.pre_update_reservation(request, metadata) - transcoded_request = _BaseReservationServiceRestTransport._BaseUpdateReservation._get_transcoded_request(http_options, request) - - body = _BaseReservationServiceRestTransport._BaseUpdateReservation._get_request_body_json(transcoded_request) - - # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseUpdateReservation._get_query_params_json(transcoded_request) - - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) - method = transcoded_request['method'] - try: - request_payload = type(request).to_json(request) - except: - request_payload = None - http_request = { - "payload": request_payload, - "requestMethod": method, - "requestUrl": request_url, - "headers": dict(metadata), - } - _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.UpdateReservation", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "UpdateReservation", - "httpRequest": http_request, - "metadata": http_request["headers"], - }, - ) - - # Send the request - response = ReservationServiceRestTransport._UpdateReservation._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request, 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 = gcbr_reservation.Reservation() - pb_resp = gcbr_reservation.Reservation.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - - resp = self._interceptor.post_update_reservation(resp) - response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_update_reservation_with_metadata(resp, response_metadata) - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - try: - response_payload = gcbr_reservation.Reservation.to_json(response) - except: - response_payload = None - http_response = { - "payload": response_payload, - "headers": dict(response.headers), - "status": response.status_code, - } - _LOGGER.debug( - "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.update_reservation", - extra = { - "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "UpdateReservation", - "metadata": http_response["headers"], - "httpResponse": http_response, - }, - ) - return resp - - @property - def create_assignment(self) -> Callable[ - [reservation.CreateAssignmentRequest], - reservation.Assignment]: - # 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._CreateAssignment(self._session, self._host, self._interceptor) # type: ignore - - @property - def create_capacity_commitment(self) -> Callable[ - [reservation.CreateCapacityCommitmentRequest], - reservation.CapacityCommitment]: - # 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._CreateCapacityCommitment(self._session, self._host, self._interceptor) # type: ignore - - @property - def create_reservation(self) -> Callable[ - [gcbr_reservation.CreateReservationRequest], - gcbr_reservation.Reservation]: - # 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._CreateReservation(self._session, self._host, self._interceptor) # type: ignore - - @property - def create_reservation_group(self) -> Callable[ - [reservation.CreateReservationGroupRequest], - reservation.ReservationGroup]: - # 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._CreateReservationGroup(self._session, self._host, self._interceptor) # type: ignore - - @property - def delete_assignment(self) -> Callable[ - [reservation.DeleteAssignmentRequest], - empty_pb2.Empty]: - # 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._DeleteAssignment(self._session, self._host, self._interceptor) # type: ignore - - @property - def delete_capacity_commitment(self) -> Callable[ - [reservation.DeleteCapacityCommitmentRequest], - empty_pb2.Empty]: - # 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._DeleteCapacityCommitment(self._session, self._host, self._interceptor) # type: ignore - - @property - def delete_reservation(self) -> Callable[ - [reservation.DeleteReservationRequest], - empty_pb2.Empty]: - # 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._DeleteReservation(self._session, self._host, self._interceptor) # type: ignore - - @property - def delete_reservation_group(self) -> Callable[ - [reservation.DeleteReservationGroupRequest], - empty_pb2.Empty]: - # 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._DeleteReservationGroup(self._session, self._host, self._interceptor) # type: ignore - - @property - def failover_reservation(self) -> Callable[ - [reservation.FailoverReservationRequest], - reservation.Reservation]: - # 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._FailoverReservation(self._session, self._host, self._interceptor) # type: ignore - - @property - def get_bi_reservation(self) -> Callable[ - [reservation.GetBiReservationRequest], - reservation.BiReservation]: - # 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._GetBiReservation(self._session, self._host, self._interceptor) # type: ignore - - @property - def get_capacity_commitment(self) -> Callable[ - [reservation.GetCapacityCommitmentRequest], - reservation.CapacityCommitment]: - # 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._GetCapacityCommitment(self._session, self._host, self._interceptor) # type: ignore - - @property - def get_iam_policy(self) -> Callable[ - [iam_policy_pb2.GetIamPolicyRequest], - policy_pb2.Policy]: - # 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._GetIamPolicy(self._session, self._host, self._interceptor) # type: ignore - - @property - def get_reservation(self) -> Callable[ - [reservation.GetReservationRequest], - reservation.Reservation]: - # 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._GetReservation(self._session, self._host, self._interceptor) # type: ignore - - @property - def get_reservation_group(self) -> Callable[ - [reservation.GetReservationGroupRequest], - reservation.ReservationGroup]: - # 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._GetReservationGroup(self._session, self._host, self._interceptor) # type: ignore - - @property - def list_assignments(self) -> Callable[ - [reservation.ListAssignmentsRequest], - reservation.ListAssignmentsResponse]: - # 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._ListAssignments(self._session, self._host, self._interceptor) # type: ignore - - @property - def list_capacity_commitments(self) -> Callable[ - [reservation.ListCapacityCommitmentsRequest], - reservation.ListCapacityCommitmentsResponse]: - # 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._ListCapacityCommitments(self._session, self._host, self._interceptor) # type: ignore - - @property - def list_reservation_groups(self) -> Callable[ - [reservation.ListReservationGroupsRequest], - reservation.ListReservationGroupsResponse]: - # 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._ListReservationGroups(self._session, self._host, self._interceptor) # type: ignore - - @property - def list_reservations(self) -> Callable[ - [reservation.ListReservationsRequest], - reservation.ListReservationsResponse]: - # 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._ListReservations(self._session, self._host, self._interceptor) # type: ignore - - @property - def merge_capacity_commitments(self) -> Callable[ - [reservation.MergeCapacityCommitmentsRequest], - reservation.CapacityCommitment]: - # 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._MergeCapacityCommitments(self._session, self._host, self._interceptor) # type: ignore - - @property - def move_assignment(self) -> Callable[ - [reservation.MoveAssignmentRequest], - reservation.Assignment]: - # 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._MoveAssignment(self._session, self._host, self._interceptor) # type: ignore - - @property - def search_all_assignments(self) -> Callable[ - [reservation.SearchAllAssignmentsRequest], - reservation.SearchAllAssignmentsResponse]: - # 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._SearchAllAssignments(self._session, self._host, self._interceptor) # type: ignore - - @property - def search_assignments(self) -> Callable[ - [reservation.SearchAssignmentsRequest], - reservation.SearchAssignmentsResponse]: - # 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._SearchAssignments(self._session, self._host, self._interceptor) # type: ignore - - @property - def set_iam_policy(self) -> Callable[ - [iam_policy_pb2.SetIamPolicyRequest], - policy_pb2.Policy]: - # 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._SetIamPolicy(self._session, self._host, self._interceptor) # type: ignore - - @property - def split_capacity_commitment(self) -> Callable[ - [reservation.SplitCapacityCommitmentRequest], - reservation.SplitCapacityCommitmentResponse]: - # 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._SplitCapacityCommitment(self._session, self._host, self._interceptor) # type: ignore - - @property - def test_iam_permissions(self) -> Callable[ - [iam_policy_pb2.TestIamPermissionsRequest], - iam_policy_pb2.TestIamPermissionsResponse]: - # 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._TestIamPermissions(self._session, self._host, self._interceptor) # type: ignore - - @property - def update_assignment(self) -> Callable[ - [reservation.UpdateAssignmentRequest], - reservation.Assignment]: - # 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._UpdateAssignment(self._session, self._host, self._interceptor) # type: ignore - - @property - def update_bi_reservation(self) -> Callable[ - [reservation.UpdateBiReservationRequest], - reservation.BiReservation]: - # 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._UpdateBiReservation(self._session, self._host, self._interceptor) # type: ignore - - @property - def update_capacity_commitment(self) -> Callable[ - [reservation.UpdateCapacityCommitmentRequest], - reservation.CapacityCommitment]: - # 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._UpdateCapacityCommitment(self._session, self._host, self._interceptor) # type: ignore - - @property - def update_reservation(self) -> Callable[ - [gcbr_reservation.UpdateReservationRequest], - gcbr_reservation.Reservation]: - # 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._UpdateReservation(self._session, self._host, self._interceptor) # type: ignore - - @property - def kind(self) -> str: - return "rest" - - def close(self): - self._session.close() - - -__all__=( - 'ReservationServiceRestTransport', -) diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/rest_base.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/rest_base.py deleted file mode 100644 index ba78ae5c5d1e..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/rest_base.py +++ /dev/null @@ -1,1282 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 json # type: ignore -from google.api_core import path_template -from google.api_core import gapic_v1 - -from google.protobuf import json_format -from .base import ReservationServiceTransport, DEFAULT_CLIENT_INFO - -import re -from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union - - -from google.cloud.bigquery_reservation_v1.types import reservation -from google.cloud.bigquery_reservation_v1.types import reservation as gcbr_reservation -from google.iam.v1 import iam_policy_pb2 # type: ignore -from google.iam.v1 import policy_pb2 # type: ignore -from google.protobuf import empty_pb2 # type: ignore - - -class _BaseReservationServiceRestTransport(ReservationServiceTransport): - """Base REST backend transport for ReservationService. - - Note: This class is not meant to be used directly. Use its sync and - async sub-classes instead. - - 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 = 'bigqueryreservation.googleapis.com', - credentials: Optional[Any] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - url_scheme: str = 'https', - api_audience: Optional[str] = None, - ) -> None: - """Instantiate the transport. - Args: - host (Optional[str]): - The hostname to connect to (default: 'bigqueryreservation.googleapis.com'). - credentials (Optional[Any]): 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. - 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 - 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 - ) - - class _BaseCreateAssignment: - def __hash__(self): # pragma: NO COVER - return NotImplementedError("__hash__ must be implemented.") - - __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} - - @staticmethod - def _get_http_options(): - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v1/{parent=projects/*/locations/*/reservations/*}/assignments', - 'body': 'assignment', - }, - ] - return http_options - - @staticmethod - def _get_transcoded_request(http_options, request): - pb_request = reservation.CreateAssignmentRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - return transcoded_request - - @staticmethod - def _get_request_body_json(transcoded_request): - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - use_integers_for_enums=True - ) - return body - @staticmethod - def _get_query_params_json(transcoded_request): - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - use_integers_for_enums=True, - )) - query_params.update(_BaseReservationServiceRestTransport._BaseCreateAssignment._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - return query_params - - class _BaseCreateCapacityCommitment: - def __hash__(self): # pragma: NO COVER - return NotImplementedError("__hash__ must be implemented.") - - __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} - - @staticmethod - def _get_http_options(): - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v1/{parent=projects/*/locations/*}/capacityCommitments', - 'body': 'capacity_commitment', - }, - ] - return http_options - - @staticmethod - def _get_transcoded_request(http_options, request): - pb_request = reservation.CreateCapacityCommitmentRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - return transcoded_request - - @staticmethod - def _get_request_body_json(transcoded_request): - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - use_integers_for_enums=True - ) - return body - @staticmethod - def _get_query_params_json(transcoded_request): - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - use_integers_for_enums=True, - )) - query_params.update(_BaseReservationServiceRestTransport._BaseCreateCapacityCommitment._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - return query_params - - class _BaseCreateReservation: - def __hash__(self): # pragma: NO COVER - return NotImplementedError("__hash__ must be implemented.") - - __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} - - @staticmethod - def _get_http_options(): - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v1/{parent=projects/*/locations/*}/reservations', - 'body': 'reservation', - }, - ] - return http_options - - @staticmethod - def _get_transcoded_request(http_options, request): - pb_request = gcbr_reservation.CreateReservationRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - return transcoded_request - - @staticmethod - def _get_request_body_json(transcoded_request): - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - use_integers_for_enums=True - ) - return body - @staticmethod - def _get_query_params_json(transcoded_request): - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - use_integers_for_enums=True, - )) - query_params.update(_BaseReservationServiceRestTransport._BaseCreateReservation._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - return query_params - - class _BaseCreateReservationGroup: - def __hash__(self): # pragma: NO COVER - return NotImplementedError("__hash__ must be implemented.") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - "reservationGroupId" : "", } - - @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} - - @staticmethod - def _get_http_options(): - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v1/{parent=projects/*/locations/*}/reservationGroups', - 'body': 'reservation_group', - }, - ] - return http_options - - @staticmethod - def _get_transcoded_request(http_options, request): - pb_request = reservation.CreateReservationGroupRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - return transcoded_request - - @staticmethod - def _get_request_body_json(transcoded_request): - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - use_integers_for_enums=True - ) - return body - @staticmethod - def _get_query_params_json(transcoded_request): - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - use_integers_for_enums=True, - )) - query_params.update(_BaseReservationServiceRestTransport._BaseCreateReservationGroup._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - return query_params - - class _BaseDeleteAssignment: - def __hash__(self): # pragma: NO COVER - return NotImplementedError("__hash__ must be implemented.") - - __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} - - @staticmethod - def _get_http_options(): - http_options: List[Dict[str, str]] = [{ - 'method': 'delete', - 'uri': '/v1/{name=projects/*/locations/*/reservations/*/assignments/*}', - }, - ] - return http_options - - @staticmethod - def _get_transcoded_request(http_options, request): - pb_request = reservation.DeleteAssignmentRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - return transcoded_request - - @staticmethod - def _get_query_params_json(transcoded_request): - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - use_integers_for_enums=True, - )) - query_params.update(_BaseReservationServiceRestTransport._BaseDeleteAssignment._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - return query_params - - class _BaseDeleteCapacityCommitment: - def __hash__(self): # pragma: NO COVER - return NotImplementedError("__hash__ must be implemented.") - - __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} - - @staticmethod - def _get_http_options(): - http_options: List[Dict[str, str]] = [{ - 'method': 'delete', - 'uri': '/v1/{name=projects/*/locations/*/capacityCommitments/*}', - }, - ] - return http_options - - @staticmethod - def _get_transcoded_request(http_options, request): - pb_request = reservation.DeleteCapacityCommitmentRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - return transcoded_request - - @staticmethod - def _get_query_params_json(transcoded_request): - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - use_integers_for_enums=True, - )) - query_params.update(_BaseReservationServiceRestTransport._BaseDeleteCapacityCommitment._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - return query_params - - class _BaseDeleteReservation: - def __hash__(self): # pragma: NO COVER - return NotImplementedError("__hash__ must be implemented.") - - __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} - - @staticmethod - def _get_http_options(): - http_options: List[Dict[str, str]] = [{ - 'method': 'delete', - 'uri': '/v1/{name=projects/*/locations/*/reservations/*}', - }, - ] - return http_options - - @staticmethod - def _get_transcoded_request(http_options, request): - pb_request = reservation.DeleteReservationRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - return transcoded_request - - @staticmethod - def _get_query_params_json(transcoded_request): - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - use_integers_for_enums=True, - )) - query_params.update(_BaseReservationServiceRestTransport._BaseDeleteReservation._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - return query_params - - class _BaseDeleteReservationGroup: - def __hash__(self): # pragma: NO COVER - return NotImplementedError("__hash__ must be implemented.") - - __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} - - @staticmethod - def _get_http_options(): - http_options: List[Dict[str, str]] = [{ - 'method': 'delete', - 'uri': '/v1/{name=projects/*/locations/*/reservationGroups/*}', - }, - ] - return http_options - - @staticmethod - def _get_transcoded_request(http_options, request): - pb_request = reservation.DeleteReservationGroupRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - return transcoded_request - - @staticmethod - def _get_query_params_json(transcoded_request): - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - use_integers_for_enums=True, - )) - query_params.update(_BaseReservationServiceRestTransport._BaseDeleteReservationGroup._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - return query_params - - class _BaseFailoverReservation: - def __hash__(self): # pragma: NO COVER - return NotImplementedError("__hash__ must be implemented.") - - __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} - - @staticmethod - def _get_http_options(): - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v1/{name=projects/*/locations/*/reservations/*}:failoverReservation', - 'body': '*', - }, - ] - return http_options - - @staticmethod - def _get_transcoded_request(http_options, request): - pb_request = reservation.FailoverReservationRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - return transcoded_request - - @staticmethod - def _get_request_body_json(transcoded_request): - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - use_integers_for_enums=True - ) - return body - @staticmethod - def _get_query_params_json(transcoded_request): - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - use_integers_for_enums=True, - )) - query_params.update(_BaseReservationServiceRestTransport._BaseFailoverReservation._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - return query_params - - class _BaseGetBiReservation: - def __hash__(self): # pragma: NO COVER - return NotImplementedError("__hash__ must be implemented.") - - __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} - - @staticmethod - def _get_http_options(): - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1/{name=projects/*/locations/*/biReservation}', - }, - ] - return http_options - - @staticmethod - def _get_transcoded_request(http_options, request): - pb_request = reservation.GetBiReservationRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - return transcoded_request - - @staticmethod - def _get_query_params_json(transcoded_request): - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - use_integers_for_enums=True, - )) - query_params.update(_BaseReservationServiceRestTransport._BaseGetBiReservation._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - return query_params - - class _BaseGetCapacityCommitment: - def __hash__(self): # pragma: NO COVER - return NotImplementedError("__hash__ must be implemented.") - - __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} - - @staticmethod - def _get_http_options(): - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1/{name=projects/*/locations/*/capacityCommitments/*}', - }, - ] - return http_options - - @staticmethod - def _get_transcoded_request(http_options, request): - pb_request = reservation.GetCapacityCommitmentRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - return transcoded_request - - @staticmethod - def _get_query_params_json(transcoded_request): - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - use_integers_for_enums=True, - )) - query_params.update(_BaseReservationServiceRestTransport._BaseGetCapacityCommitment._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - return query_params - - class _BaseGetIamPolicy: - def __hash__(self): # pragma: NO COVER - return NotImplementedError("__hash__ must be implemented.") - - __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} - - @staticmethod - def _get_http_options(): - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1/{resource=projects/*/locations/*/reservations/*}:getIamPolicy', - }, - { - 'method': 'get', - 'uri': '/v1/{resource=projects/*/locations/*/reservations/*/assignments/*}:getIamPolicy', - }, - ] - return http_options - - @staticmethod - def _get_transcoded_request(http_options, request): - pb_request = request - transcoded_request = path_template.transcode(http_options, pb_request) - return transcoded_request - - @staticmethod - def _get_query_params_json(transcoded_request): - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - use_integers_for_enums=True, - )) - query_params.update(_BaseReservationServiceRestTransport._BaseGetIamPolicy._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - return query_params - - class _BaseGetReservation: - def __hash__(self): # pragma: NO COVER - return NotImplementedError("__hash__ must be implemented.") - - __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} - - @staticmethod - def _get_http_options(): - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1/{name=projects/*/locations/*/reservations/*}', - }, - ] - return http_options - - @staticmethod - def _get_transcoded_request(http_options, request): - pb_request = reservation.GetReservationRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - return transcoded_request - - @staticmethod - def _get_query_params_json(transcoded_request): - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - use_integers_for_enums=True, - )) - query_params.update(_BaseReservationServiceRestTransport._BaseGetReservation._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - return query_params - - class _BaseGetReservationGroup: - def __hash__(self): # pragma: NO COVER - return NotImplementedError("__hash__ must be implemented.") - - __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} - - @staticmethod - def _get_http_options(): - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1/{name=projects/*/locations/*/reservationGroups/*}', - }, - ] - return http_options - - @staticmethod - def _get_transcoded_request(http_options, request): - pb_request = reservation.GetReservationGroupRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - return transcoded_request - - @staticmethod - def _get_query_params_json(transcoded_request): - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - use_integers_for_enums=True, - )) - query_params.update(_BaseReservationServiceRestTransport._BaseGetReservationGroup._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - return query_params - - class _BaseListAssignments: - def __hash__(self): # pragma: NO COVER - return NotImplementedError("__hash__ must be implemented.") - - __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} - - @staticmethod - def _get_http_options(): - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1/{parent=projects/*/locations/*/reservations/*}/assignments', - }, - ] - return http_options - - @staticmethod - def _get_transcoded_request(http_options, request): - pb_request = reservation.ListAssignmentsRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - return transcoded_request - - @staticmethod - def _get_query_params_json(transcoded_request): - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - use_integers_for_enums=True, - )) - query_params.update(_BaseReservationServiceRestTransport._BaseListAssignments._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - return query_params - - class _BaseListCapacityCommitments: - def __hash__(self): # pragma: NO COVER - return NotImplementedError("__hash__ must be implemented.") - - __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} - - @staticmethod - def _get_http_options(): - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1/{parent=projects/*/locations/*}/capacityCommitments', - }, - ] - return http_options - - @staticmethod - def _get_transcoded_request(http_options, request): - pb_request = reservation.ListCapacityCommitmentsRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - return transcoded_request - - @staticmethod - def _get_query_params_json(transcoded_request): - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - use_integers_for_enums=True, - )) - query_params.update(_BaseReservationServiceRestTransport._BaseListCapacityCommitments._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - return query_params - - class _BaseListReservationGroups: - def __hash__(self): # pragma: NO COVER - return NotImplementedError("__hash__ must be implemented.") - - __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} - - @staticmethod - def _get_http_options(): - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1/{parent=projects/*/locations/*}/reservationGroups', - }, - ] - return http_options - - @staticmethod - def _get_transcoded_request(http_options, request): - pb_request = reservation.ListReservationGroupsRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - return transcoded_request - - @staticmethod - def _get_query_params_json(transcoded_request): - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - use_integers_for_enums=True, - )) - query_params.update(_BaseReservationServiceRestTransport._BaseListReservationGroups._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - return query_params - - class _BaseListReservations: - def __hash__(self): # pragma: NO COVER - return NotImplementedError("__hash__ must be implemented.") - - __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} - - @staticmethod - def _get_http_options(): - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1/{parent=projects/*/locations/*}/reservations', - }, - ] - return http_options - - @staticmethod - def _get_transcoded_request(http_options, request): - pb_request = reservation.ListReservationsRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - return transcoded_request - - @staticmethod - def _get_query_params_json(transcoded_request): - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - use_integers_for_enums=True, - )) - query_params.update(_BaseReservationServiceRestTransport._BaseListReservations._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - return query_params - - class _BaseMergeCapacityCommitments: - def __hash__(self): # pragma: NO COVER - return NotImplementedError("__hash__ must be implemented.") - - @staticmethod - def _get_http_options(): - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v1/{parent=projects/*/locations/*}/capacityCommitments:merge', - 'body': '*', - }, - ] - return http_options - - @staticmethod - def _get_transcoded_request(http_options, request): - pb_request = reservation.MergeCapacityCommitmentsRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - return transcoded_request - - @staticmethod - def _get_request_body_json(transcoded_request): - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - use_integers_for_enums=True - ) - return body - @staticmethod - def _get_query_params_json(transcoded_request): - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - use_integers_for_enums=True, - )) - - query_params["$alt"] = "json;enum-encoding=int" - return query_params - - class _BaseMoveAssignment: - def __hash__(self): # pragma: NO COVER - return NotImplementedError("__hash__ must be implemented.") - - __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} - - @staticmethod - def _get_http_options(): - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v1/{name=projects/*/locations/*/reservations/*/assignments/*}:move', - 'body': '*', - }, - ] - return http_options - - @staticmethod - def _get_transcoded_request(http_options, request): - pb_request = reservation.MoveAssignmentRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - return transcoded_request - - @staticmethod - def _get_request_body_json(transcoded_request): - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - use_integers_for_enums=True - ) - return body - @staticmethod - def _get_query_params_json(transcoded_request): - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - use_integers_for_enums=True, - )) - query_params.update(_BaseReservationServiceRestTransport._BaseMoveAssignment._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - return query_params - - class _BaseSearchAllAssignments: - def __hash__(self): # pragma: NO COVER - return NotImplementedError("__hash__ must be implemented.") - - __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} - - @staticmethod - def _get_http_options(): - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1/{parent=projects/*/locations/*}:searchAllAssignments', - }, - ] - return http_options - - @staticmethod - def _get_transcoded_request(http_options, request): - pb_request = reservation.SearchAllAssignmentsRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - return transcoded_request - - @staticmethod - def _get_query_params_json(transcoded_request): - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - use_integers_for_enums=True, - )) - query_params.update(_BaseReservationServiceRestTransport._BaseSearchAllAssignments._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - return query_params - - class _BaseSearchAssignments: - def __hash__(self): # pragma: NO COVER - return NotImplementedError("__hash__ must be implemented.") - - __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} - - @staticmethod - def _get_http_options(): - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1/{parent=projects/*/locations/*}:searchAssignments', - }, - ] - return http_options - - @staticmethod - def _get_transcoded_request(http_options, request): - pb_request = reservation.SearchAssignmentsRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - return transcoded_request - - @staticmethod - def _get_query_params_json(transcoded_request): - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - use_integers_for_enums=True, - )) - query_params.update(_BaseReservationServiceRestTransport._BaseSearchAssignments._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - return query_params - - class _BaseSetIamPolicy: - def __hash__(self): # pragma: NO COVER - return NotImplementedError("__hash__ must be implemented.") - - __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} - - @staticmethod - def _get_http_options(): - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v1/{resource=projects/*/locations/*/reservations/*}:setIamPolicy', - 'body': '*', - }, - { - 'method': 'post', - 'uri': '/v1/{resource=projects/*/locations/*/reservations/*/assignments/*}:setIamPolicy', - 'body': '*', - }, - ] - return http_options - - @staticmethod - def _get_transcoded_request(http_options, request): - pb_request = request - transcoded_request = path_template.transcode(http_options, pb_request) - return transcoded_request - - @staticmethod - def _get_request_body_json(transcoded_request): - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - use_integers_for_enums=True - ) - return body - @staticmethod - def _get_query_params_json(transcoded_request): - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - use_integers_for_enums=True, - )) - query_params.update(_BaseReservationServiceRestTransport._BaseSetIamPolicy._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - return query_params - - class _BaseSplitCapacityCommitment: - def __hash__(self): # pragma: NO COVER - return NotImplementedError("__hash__ must be implemented.") - - __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} - - @staticmethod - def _get_http_options(): - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v1/{name=projects/*/locations/*/capacityCommitments/*}:split', - 'body': '*', - }, - ] - return http_options - - @staticmethod - def _get_transcoded_request(http_options, request): - pb_request = reservation.SplitCapacityCommitmentRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - return transcoded_request - - @staticmethod - def _get_request_body_json(transcoded_request): - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - use_integers_for_enums=True - ) - return body - @staticmethod - def _get_query_params_json(transcoded_request): - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - use_integers_for_enums=True, - )) - query_params.update(_BaseReservationServiceRestTransport._BaseSplitCapacityCommitment._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - return query_params - - class _BaseTestIamPermissions: - def __hash__(self): # pragma: NO COVER - return NotImplementedError("__hash__ must be implemented.") - - __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} - - @staticmethod - def _get_http_options(): - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v1/{resource=projects/*/locations/*/reservations/*}:testIamPermissions', - 'body': '*', - }, - { - 'method': 'post', - 'uri': '/v1/{resource=projects/*/locations/*/reservations/*/assignments/*}:testIamPermissions', - 'body': '*', - }, - ] - return http_options - - @staticmethod - def _get_transcoded_request(http_options, request): - pb_request = request - transcoded_request = path_template.transcode(http_options, pb_request) - return transcoded_request - - @staticmethod - def _get_request_body_json(transcoded_request): - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - use_integers_for_enums=True - ) - return body - @staticmethod - def _get_query_params_json(transcoded_request): - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - use_integers_for_enums=True, - )) - query_params.update(_BaseReservationServiceRestTransport._BaseTestIamPermissions._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - return query_params - - class _BaseUpdateAssignment: - def __hash__(self): # pragma: NO COVER - return NotImplementedError("__hash__ must be implemented.") - - @staticmethod - def _get_http_options(): - http_options: List[Dict[str, str]] = [{ - 'method': 'patch', - 'uri': '/v1/{assignment.name=projects/*/locations/*/reservations/*/assignments/*}', - 'body': 'assignment', - }, - ] - return http_options - - @staticmethod - def _get_transcoded_request(http_options, request): - pb_request = reservation.UpdateAssignmentRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - return transcoded_request - - @staticmethod - def _get_request_body_json(transcoded_request): - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - use_integers_for_enums=True - ) - return body - @staticmethod - def _get_query_params_json(transcoded_request): - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - use_integers_for_enums=True, - )) - - query_params["$alt"] = "json;enum-encoding=int" - return query_params - - class _BaseUpdateBiReservation: - def __hash__(self): # pragma: NO COVER - return NotImplementedError("__hash__ must be implemented.") - - @staticmethod - def _get_http_options(): - http_options: List[Dict[str, str]] = [{ - 'method': 'patch', - 'uri': '/v1/{bi_reservation.name=projects/*/locations/*/biReservation}', - 'body': 'bi_reservation', - }, - ] - return http_options - - @staticmethod - def _get_transcoded_request(http_options, request): - pb_request = reservation.UpdateBiReservationRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - return transcoded_request - - @staticmethod - def _get_request_body_json(transcoded_request): - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - use_integers_for_enums=True - ) - return body - @staticmethod - def _get_query_params_json(transcoded_request): - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - use_integers_for_enums=True, - )) - - query_params["$alt"] = "json;enum-encoding=int" - return query_params - - class _BaseUpdateCapacityCommitment: - def __hash__(self): # pragma: NO COVER - return NotImplementedError("__hash__ must be implemented.") - - @staticmethod - def _get_http_options(): - http_options: List[Dict[str, str]] = [{ - 'method': 'patch', - 'uri': '/v1/{capacity_commitment.name=projects/*/locations/*/capacityCommitments/*}', - 'body': 'capacity_commitment', - }, - ] - return http_options - - @staticmethod - def _get_transcoded_request(http_options, request): - pb_request = reservation.UpdateCapacityCommitmentRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - return transcoded_request - - @staticmethod - def _get_request_body_json(transcoded_request): - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - use_integers_for_enums=True - ) - return body - @staticmethod - def _get_query_params_json(transcoded_request): - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - use_integers_for_enums=True, - )) - - query_params["$alt"] = "json;enum-encoding=int" - return query_params - - class _BaseUpdateReservation: - def __hash__(self): # pragma: NO COVER - return NotImplementedError("__hash__ must be implemented.") - - @staticmethod - def _get_http_options(): - http_options: List[Dict[str, str]] = [{ - 'method': 'patch', - 'uri': '/v1/{reservation.name=projects/*/locations/*/reservations/*}', - 'body': 'reservation', - }, - ] - return http_options - - @staticmethod - def _get_transcoded_request(http_options, request): - pb_request = gcbr_reservation.UpdateReservationRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - return transcoded_request - - @staticmethod - def _get_request_body_json(transcoded_request): - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - use_integers_for_enums=True - ) - return body - @staticmethod - def _get_query_params_json(transcoded_request): - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - use_integers_for_enums=True, - )) - - query_params["$alt"] = "json;enum-encoding=int" - return query_params - - -__all__=( - '_BaseReservationServiceRestTransport', -) diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/types/__init__.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/types/__init__.py deleted file mode 100644 index aab35926c19b..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/types/__init__.py +++ /dev/null @@ -1,104 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 .reservation import ( - Assignment, - BiReservation, - CapacityCommitment, - CreateAssignmentRequest, - CreateCapacityCommitmentRequest, - CreateReservationGroupRequest, - CreateReservationRequest, - DeleteAssignmentRequest, - DeleteCapacityCommitmentRequest, - DeleteReservationGroupRequest, - DeleteReservationRequest, - FailoverReservationRequest, - GetBiReservationRequest, - GetCapacityCommitmentRequest, - GetReservationGroupRequest, - GetReservationRequest, - ListAssignmentsRequest, - ListAssignmentsResponse, - ListCapacityCommitmentsRequest, - ListCapacityCommitmentsResponse, - ListReservationGroupsRequest, - ListReservationGroupsResponse, - ListReservationsRequest, - ListReservationsResponse, - MergeCapacityCommitmentsRequest, - MoveAssignmentRequest, - Reservation, - ReservationGroup, - SchedulingPolicy, - SearchAllAssignmentsRequest, - SearchAllAssignmentsResponse, - SearchAssignmentsRequest, - SearchAssignmentsResponse, - SplitCapacityCommitmentRequest, - SplitCapacityCommitmentResponse, - TableReference, - UpdateAssignmentRequest, - UpdateBiReservationRequest, - UpdateCapacityCommitmentRequest, - UpdateReservationRequest, - Edition, - FailoverMode, -) - -__all__ = ( - 'Assignment', - 'BiReservation', - 'CapacityCommitment', - 'CreateAssignmentRequest', - 'CreateCapacityCommitmentRequest', - 'CreateReservationGroupRequest', - 'CreateReservationRequest', - 'DeleteAssignmentRequest', - 'DeleteCapacityCommitmentRequest', - 'DeleteReservationGroupRequest', - 'DeleteReservationRequest', - 'FailoverReservationRequest', - 'GetBiReservationRequest', - 'GetCapacityCommitmentRequest', - 'GetReservationGroupRequest', - 'GetReservationRequest', - 'ListAssignmentsRequest', - 'ListAssignmentsResponse', - 'ListCapacityCommitmentsRequest', - 'ListCapacityCommitmentsResponse', - 'ListReservationGroupsRequest', - 'ListReservationGroupsResponse', - 'ListReservationsRequest', - 'ListReservationsResponse', - 'MergeCapacityCommitmentsRequest', - 'MoveAssignmentRequest', - 'Reservation', - 'ReservationGroup', - 'SchedulingPolicy', - 'SearchAllAssignmentsRequest', - 'SearchAllAssignmentsResponse', - 'SearchAssignmentsRequest', - 'SearchAssignmentsResponse', - 'SplitCapacityCommitmentRequest', - 'SplitCapacityCommitmentResponse', - 'TableReference', - 'UpdateAssignmentRequest', - 'UpdateBiReservationRequest', - 'UpdateCapacityCommitmentRequest', - 'UpdateReservationRequest', - 'Edition', - 'FailoverMode', -) diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/types/reservation.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/types/reservation.py deleted file mode 100644 index e00c4bf299f3..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/google/cloud/bigquery_reservation_v1/types/reservation.py +++ /dev/null @@ -1,1937 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 -from google.rpc import status_pb2 # type: ignore - - -__protobuf__ = proto.module( - package='google.cloud.bigquery.reservation.v1', - manifest={ - 'Edition', - 'FailoverMode', - 'Reservation', - 'SchedulingPolicy', - 'ReservationGroup', - 'CapacityCommitment', - 'CreateReservationRequest', - 'ListReservationsRequest', - 'ListReservationsResponse', - 'GetReservationRequest', - 'DeleteReservationRequest', - 'UpdateReservationRequest', - 'FailoverReservationRequest', - 'CreateReservationGroupRequest', - 'GetReservationGroupRequest', - 'ListReservationGroupsRequest', - 'ListReservationGroupsResponse', - 'DeleteReservationGroupRequest', - 'CreateCapacityCommitmentRequest', - 'ListCapacityCommitmentsRequest', - 'ListCapacityCommitmentsResponse', - 'GetCapacityCommitmentRequest', - 'DeleteCapacityCommitmentRequest', - 'UpdateCapacityCommitmentRequest', - 'SplitCapacityCommitmentRequest', - 'SplitCapacityCommitmentResponse', - 'MergeCapacityCommitmentsRequest', - 'Assignment', - 'CreateAssignmentRequest', - 'ListAssignmentsRequest', - 'ListAssignmentsResponse', - 'DeleteAssignmentRequest', - 'SearchAssignmentsRequest', - 'SearchAllAssignmentsRequest', - 'SearchAssignmentsResponse', - 'SearchAllAssignmentsResponse', - 'MoveAssignmentRequest', - 'UpdateAssignmentRequest', - 'TableReference', - 'BiReservation', - 'GetBiReservationRequest', - 'UpdateBiReservationRequest', - }, -) - - -class Edition(proto.Enum): - r"""The type of editions. - Different features and behaviors are provided to different - editions Capacity commitments and reservations are linked to - editions. - - Values: - EDITION_UNSPECIFIED (0): - Default value, which will be treated as - ENTERPRISE. - STANDARD (1): - Standard edition. - ENTERPRISE (2): - Enterprise edition. - ENTERPRISE_PLUS (3): - Enterprise Plus edition. - """ - EDITION_UNSPECIFIED = 0 - STANDARD = 1 - ENTERPRISE = 2 - ENTERPRISE_PLUS = 3 - - -class FailoverMode(proto.Enum): - r"""The failover mode when a user initiates a failover on a - reservation determines how writes that are pending replication - are handled after the failover is initiated. - - Values: - FAILOVER_MODE_UNSPECIFIED (0): - Invalid value. - SOFT (1): - When customers initiate a soft failover, - BigQuery will wait until all committed writes - are replicated to the secondary. This mode - requires both regions to be available for the - failover to succeed and prevents data loss. - HARD (2): - When customers initiate a hard failover, - BigQuery will not wait until all committed - writes are replicated to the secondary. There - can be data loss for hard failover. - """ - FAILOVER_MODE_UNSPECIFIED = 0 - SOFT = 1 - HARD = 2 - - -class Reservation(proto.Message): - r"""A reservation is a mechanism used to guarantee slots to - users. - - - .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields - - Attributes: - name (str): - Identifier. The resource name of the reservation, e.g., - ``projects/*/locations/*/reservations/team1-prod``. The - reservation_id must only contain lower case alphanumeric - characters or dashes. It must start with a letter and must - not end with a dash. Its maximum length is 64 characters. - slot_capacity (int): - Optional. Baseline slots available to this reservation. A - slot is a unit of computational power in BigQuery, and - serves as the unit of parallelism. - - Queries using this reservation might use more slots during - runtime if ignore_idle_slots is set to false, or autoscaling - is enabled. - - The total slot_capacity of the reservation and its siblings - may exceed the total slot_count of capacity commitments. In - that case, the exceeding slots will be charged with the - autoscale SKU. You can increase the number of baseline slots - in a reservation every few minutes. If you want to decrease - your baseline slots, you are limited to once an hour if you - have recently changed your baseline slot capacity and your - baseline slots exceed your committed slots. Otherwise, you - can decrease your baseline slots every few minutes. - ignore_idle_slots (bool): - Optional. If false, any query or pipeline job using this - reservation will use idle slots from other reservations - within the same admin project. If true, a query or pipeline - job using this reservation will execute with the slot - capacity specified in the slot_capacity field at most. - autoscale (google.cloud.bigquery_reservation_v1.types.Reservation.Autoscale): - Optional. The configuration parameters for - the auto scaling feature. - concurrency (int): - Optional. Job concurrency target which sets a - soft upper bound on the number of jobs that can - run concurrently in this reservation. This is a - soft target due to asynchronous nature of the - system and various optimizations for small - queries. Default value is 0 which means that - concurrency target will be automatically - computed by the system. NOTE: this field is - exposed as target job concurrency in the - Information Schema, DDL and BigQuery CLI. - creation_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. Creation time of the - reservation. - update_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. Last update time of the - reservation. - multi_region_auxiliary (bool): - Applicable only for reservations located - within one of the BigQuery multi-regions (US or - EU). - - If set to true, this reservation is placed in - the organization's secondary region which is - designated for disaster recovery purposes. If - false, this reservation is placed in the - organization's default region. - - NOTE: this is a preview feature. Project must be - allow-listed in order to set this field. - edition (google.cloud.bigquery_reservation_v1.types.Edition): - Optional. Edition of the reservation. - primary_location (str): - Output only. The current location of the - reservation's primary replica. This field is - only set for reservations using the managed - disaster recovery feature. - secondary_location (str): - Optional. The current location of the - reservation's secondary replica. This field is - only set for reservations using the managed - disaster recovery feature. Users can set this in - create reservation calls to create a failover - reservation or in update reservation calls to - convert a non-failover reservation to a failover - reservation(or vice versa). - original_primary_location (str): - Output only. The location where the - reservation was originally created. This is set - only during the failover reservation's creation. - All billing charges for the failover reservation - will be applied to this location. - max_slots (int): - Optional. The overall max slots for the reservation, - covering slot_capacity (baseline), idle slots (if - ignore_idle_slots is false) and scaled slots. If present, - the reservation won't use more than the specified number of - slots, even if there is demand and supply (from idle slots). - NOTE: capping a reservation's idle slot usage is best effort - and its usage may exceed the max_slots value. However, in - terms of autoscale.current_slots (which accounts for the - additional added slots), it will never exceed the max_slots - - baseline. - - This field must be set together with the scaling_mode enum - value, otherwise the request will be rejected with error - code ``google.rpc.Code.INVALID_ARGUMENT``. - - If the max_slots and scaling_mode are set, the autoscale or - autoscale.max_slots field must be unset. Otherwise the - request will be rejected with error code - ``google.rpc.Code.INVALID_ARGUMENT``. However, the autoscale - field may still be in the output. The autopscale.max_slots - will always show as 0 and the autoscaler.current_slots will - represent the current slots from autoscaler excluding idle - slots. For example, if the max_slots is 1000 and - scaling_mode is AUTOSCALE_ONLY, then in the output, the - autoscaler.max_slots will be 0 and the - autoscaler.current_slots may be any value between 0 and - 1000. - - If the max_slots is 1000, scaling_mode is ALL_SLOTS, the - baseline is 100 and idle slots usage is 200, then in the - output, the autoscaler.max_slots will be 0 and the - autoscaler.current_slots will not be higher than 700. - - If the max_slots is 1000, scaling_mode is IDLE_SLOTS_ONLY, - then in the output, the autoscaler field will be null. - - If the max_slots and scaling_mode are set, then the - ignore_idle_slots field must be aligned with the - scaling_mode enum value.(See details in ScalingMode - comments). Otherwise the request will be rejected with error - code ``google.rpc.Code.INVALID_ARGUMENT``. - - Please note, the max_slots is for user to manage the part of - slots greater than the baseline. Therefore, we don't allow - users to set max_slots smaller or equal to the baseline as - it will not be meaningful. If the field is present and - slot_capacity>=max_slots, requests will be rejected with - error code ``google.rpc.Code.INVALID_ARGUMENT``. - - Please note that if max_slots is set to 0, we will treat it - as unset. Customers can set max_slots to 0 and set - scaling_mode to SCALING_MODE_UNSPECIFIED to disable the - max_slots feature. - - This field is a member of `oneof`_ ``_max_slots``. - scaling_mode (google.cloud.bigquery_reservation_v1.types.Reservation.ScalingMode): - Optional. The scaling mode for the reservation. If the field - is present but max_slots is not present, requests will be - rejected with error code - ``google.rpc.Code.INVALID_ARGUMENT``. - labels (MutableMapping[str, str]): - Optional. The labels associated with this - reservation. You can use these to organize and - group your reservations. You can set this - property when you create or update a - reservation. - reservation_group (str): - Optional. The reservation group that this reservation - belongs to. You can set this property when you create or - update a reservation. Reservations do not need to belong to - a reservation group. Format: - projects/{project}/locations/{location}/reservationGroups/{reservation_group} - or just {reservation_group} - replication_status (google.cloud.bigquery_reservation_v1.types.Reservation.ReplicationStatus): - Output only. The Disaster Recovery(DR) - replication status of the reservation. This is - only available for the primary replicas of - DR/failover reservations and provides - information about the both the staleness of the - secondary and the last error encountered while - trying to replicate changes from the primary to - the secondary. If this field is blank, it means - that the reservation is either not a DR - reservation or the reservation is a DR secondary - or that any replication operations on the - reservation have succeeded. - scheduling_policy (google.cloud.bigquery_reservation_v1.types.SchedulingPolicy): - Optional. The scheduling policy to use for - jobs and queries running under this reservation. - The scheduling policy controls how the - reservation's resources are distributed. - - This feature is not yet generally available. - """ - class ScalingMode(proto.Enum): - r"""The scaling mode for the reservation. This enum determines - how the reservation scales up and down. - - Values: - SCALING_MODE_UNSPECIFIED (0): - Default value of ScalingMode. - AUTOSCALE_ONLY (1): - The reservation will scale up only using slots from - autoscaling. It will not use any idle slots even if there - may be some available. The upper limit that autoscaling can - scale up to will be max_slots - baseline. For example, if - max_slots is 1000, baseline is 200 and customer sets - ScalingMode to AUTOSCALE_ONLY, then autoscalerg will scale - up to 800 slots and no idle slots will be used. - - Please note, in this mode, the ignore_idle_slots field must - be set to true. Otherwise the request will be rejected with - error code ``google.rpc.Code.INVALID_ARGUMENT``. - IDLE_SLOTS_ONLY (2): - The reservation will scale up using only idle slots - contributed by other reservations or from unassigned - commitments. If no idle slots are available it will not - scale up further. If the idle slots which it is using are - reclaimed by the contributing reservation(s) it may be - forced to scale down. The max idle slots the reservation can - be max_slots - baseline capacity. For example, if max_slots - is 1000, baseline is 200 and customer sets ScalingMode to - IDLE_SLOTS_ONLY, - - 1. if there are 1000 idle slots available in other - reservations, the reservation will scale up to 1000 slots - with 200 baseline and 800 idle slots. - 2. if there are 500 idle slots available in other - reservations, the reservation will scale up to 700 slots - with 200 baseline and 300 idle slots. Please note, in - this mode, the reservation might not be able to scale up - to max_slots. - - Please note, in this mode, the ignore_idle_slots field must - be set to false. Otherwise the request will be rejected with - error code ``google.rpc.Code.INVALID_ARGUMENT``. - ALL_SLOTS (3): - The reservation will scale up using all slots available to - it. It will use idle slots contributed by other reservations - or from unassigned commitments first. If no idle slots are - available it will scale up using autoscaling. For example, - if max_slots is 1000, baseline is 200 and customer sets - ScalingMode to ALL_SLOTS, - - 1. if there are 800 idle slots available in other - reservations, the reservation will scale up to 1000 slots - with 200 baseline and 800 idle slots. - 2. if there are 500 idle slots available in other - reservations, the reservation will scale up to 1000 slots - with 200 baseline, 500 idle slots and 300 autoscaling - slots. - 3. if there are no idle slots available in other - reservations, it will scale up to 1000 slots with 200 - baseline and 800 autoscaling slots. - - Please note, in this mode, the ignore_idle_slots field must - be set to false. Otherwise the request will be rejected with - error code ``google.rpc.Code.INVALID_ARGUMENT``. - """ - SCALING_MODE_UNSPECIFIED = 0 - AUTOSCALE_ONLY = 1 - IDLE_SLOTS_ONLY = 2 - ALL_SLOTS = 3 - - class Autoscale(proto.Message): - r"""Auto scaling settings. - - Attributes: - current_slots (int): - Output only. The slot capacity added to this reservation - when autoscale happens. Will be between [0, max_slots]. - Note: after users reduce max_slots, it may take a while - before it can be propagated, so current_slots may stay in - the original value and could be larger than max_slots for - that brief period (less than one minute) - max_slots (int): - Optional. Number of slots to be scaled when - needed. - """ - - current_slots: int = proto.Field( - proto.INT64, - number=1, - ) - max_slots: int = proto.Field( - proto.INT64, - number=2, - ) - - class ReplicationStatus(proto.Message): - r"""Disaster Recovery(DR) replication status of the reservation. - - Attributes: - error (google.rpc.status_pb2.Status): - Output only. The last error encountered while - trying to replicate changes from the primary to - the secondary. This field is only available if - the replication has not succeeded since. - last_error_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. The time at which the last error - was encountered while trying to replicate - changes from the primary to the secondary. This - field is only available if the replication has - not succeeded since. - last_replication_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. A timestamp corresponding to the - last change on the primary that was successfully - replicated to the secondary. - soft_failover_start_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. The time at which a soft - failover for the reservation and its associated - datasets was initiated. After this field is set, - all subsequent changes to the reservation will - be rejected unless a hard failover overrides - this operation. This field will be cleared once - the failover is complete. - """ - - error: status_pb2.Status = proto.Field( - proto.MESSAGE, - number=1, - message=status_pb2.Status, - ) - last_error_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=2, - message=timestamp_pb2.Timestamp, - ) - last_replication_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=3, - message=timestamp_pb2.Timestamp, - ) - soft_failover_start_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=4, - message=timestamp_pb2.Timestamp, - ) - - name: str = proto.Field( - proto.STRING, - number=1, - ) - slot_capacity: int = proto.Field( - proto.INT64, - number=2, - ) - ignore_idle_slots: bool = proto.Field( - proto.BOOL, - number=4, - ) - autoscale: Autoscale = proto.Field( - proto.MESSAGE, - number=7, - message=Autoscale, - ) - concurrency: int = proto.Field( - proto.INT64, - number=16, - ) - creation_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=8, - message=timestamp_pb2.Timestamp, - ) - update_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=9, - message=timestamp_pb2.Timestamp, - ) - multi_region_auxiliary: bool = proto.Field( - proto.BOOL, - number=14, - ) - edition: 'Edition' = proto.Field( - proto.ENUM, - number=17, - enum='Edition', - ) - primary_location: str = proto.Field( - proto.STRING, - number=18, - ) - secondary_location: str = proto.Field( - proto.STRING, - number=19, - ) - original_primary_location: str = proto.Field( - proto.STRING, - number=20, - ) - max_slots: int = proto.Field( - proto.INT64, - number=21, - optional=True, - ) - scaling_mode: ScalingMode = proto.Field( - proto.ENUM, - number=22, - enum=ScalingMode, - ) - labels: MutableMapping[str, str] = proto.MapField( - proto.STRING, - proto.STRING, - number=23, - ) - reservation_group: str = proto.Field( - proto.STRING, - number=25, - ) - replication_status: ReplicationStatus = proto.Field( - proto.MESSAGE, - number=24, - message=ReplicationStatus, - ) - scheduling_policy: 'SchedulingPolicy' = proto.Field( - proto.MESSAGE, - number=27, - message='SchedulingPolicy', - ) - - -class SchedulingPolicy(proto.Message): - r"""The scheduling policy controls how a reservation's resources - are distributed. - - - .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields - - Attributes: - concurrency (int): - Optional. If present and > 0, the reservation - will attempt to limit the concurrency of jobs - running for any particular project within it to - the given value. - - This feature is not yet generally available. - - This field is a member of `oneof`_ ``_concurrency``. - max_slots (int): - Optional. If present and > 0, the reservation - will attempt to limit the slot consumption of - queries running for any particular project - within it to the given value. - - This feature is not yet generally available. - - This field is a member of `oneof`_ ``_max_slots``. - """ - - concurrency: int = proto.Field( - proto.INT64, - number=1, - optional=True, - ) - max_slots: int = proto.Field( - proto.INT64, - number=2, - optional=True, - ) - - -class ReservationGroup(proto.Message): - r"""A reservation group is a container for reservations. - - Attributes: - name (str): - Identifier. The resource name of the reservation group, - e.g., - ``projects/*/locations/*/reservationGroups/team1-prod``. The - reservation_group_id must only contain lower case - alphanumeric characters or dashes. It must start with a - letter and must not end with a dash. Its maximum length is - 64 characters. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - - -class CapacityCommitment(proto.Message): - r"""Capacity commitment is a way to purchase compute capacity for - BigQuery jobs (in the form of slots) with some committed period - of usage. Annual commitments renew by default. Commitments can - be removed after their commitment end time passes. - - In order to remove annual commitment, its plan needs to be - changed to monthly or flex first. - - A capacity commitment resource exists as a child resource of the - admin project. - - Attributes: - name (str): - Output only. The resource name of the capacity commitment, - e.g., - ``projects/myproject/locations/US/capacityCommitments/123`` - The commitment_id must only contain lower case alphanumeric - characters or dashes. It must start with a letter and must - not end with a dash. Its maximum length is 64 characters. - slot_count (int): - Optional. Number of slots in this commitment. - plan (google.cloud.bigquery_reservation_v1.types.CapacityCommitment.CommitmentPlan): - Optional. Capacity commitment commitment - plan. - state (google.cloud.bigquery_reservation_v1.types.CapacityCommitment.State): - Output only. State of the commitment. - commitment_start_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. The start of the current commitment period. It - is applicable only for ACTIVE capacity commitments. Note - after the commitment is renewed, commitment_start_time won't - be changed. It refers to the start time of the original - commitment. - commitment_end_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. The end of the current commitment period. It is - applicable only for ACTIVE capacity commitments. Note after - renewal, commitment_end_time is the time the renewed - commitment expires. So itwould be at a time after - commitment_start_time + committed period, because we don't - change commitment_start_time , - failure_status (google.rpc.status_pb2.Status): - Output only. For FAILED commitment plan, - provides the reason of failure. - renewal_plan (google.cloud.bigquery_reservation_v1.types.CapacityCommitment.CommitmentPlan): - Optional. The plan this capacity commitment is converted to - after commitment_end_time passes. Once the plan is changed, - committed period is extended according to commitment plan. - Only applicable for ANNUAL and TRIAL commitments. - multi_region_auxiliary (bool): - Applicable only for commitments located - within one of the BigQuery multi-regions (US or - EU). - - If set to true, this commitment is placed in the - organization's secondary region which is - designated for disaster recovery purposes. If - false, this commitment is placed in the - organization's default region. - - NOTE: this is a preview feature. Project must be - allow-listed in order to set this field. - edition (google.cloud.bigquery_reservation_v1.types.Edition): - Optional. Edition of the capacity commitment. - is_flat_rate (bool): - Output only. If true, the commitment is a - flat-rate commitment, otherwise, it's an edition - commitment. - """ - class CommitmentPlan(proto.Enum): - r"""Commitment plan defines the current committed period. - Capacity commitment cannot be deleted during it's committed - period. - - Values: - COMMITMENT_PLAN_UNSPECIFIED (0): - Invalid plan value. Requests with this value will be - rejected with error code - ``google.rpc.Code.INVALID_ARGUMENT``. - FLEX (3): - Flex commitments have committed period of 1 - minute after becoming ACTIVE. After that, they - are not in a committed period anymore and can be - removed any time. - FLEX_FLAT_RATE (7): - Same as FLEX, should only be used if - flat-rate commitments are still available. - TRIAL (5): - Trial commitments have a committed period of 182 days after - becoming ACTIVE. After that, they are converted to a new - commitment based on the ``renewal_plan``. Default - ``renewal_plan`` for Trial commitment is Flex so that it can - be deleted right after committed period ends. - MONTHLY (2): - Monthly commitments have a committed period - of 30 days after becoming ACTIVE. After that, - they are not in a committed period anymore and - can be removed any time. - MONTHLY_FLAT_RATE (8): - Same as MONTHLY, should only be used if - flat-rate commitments are still available. - ANNUAL (4): - Annual commitments have a committed period of 365 days after - becoming ACTIVE. After that they are converted to a new - commitment based on the renewal_plan. - ANNUAL_FLAT_RATE (9): - Same as ANNUAL, should only be used if - flat-rate commitments are still available. - THREE_YEAR (10): - 3-year commitments have a committed period of 1095(3 \* 365) - days after becoming ACTIVE. After that they are converted to - a new commitment based on the renewal_plan. - NONE (6): - Should only be used for ``renewal_plan`` and is only - meaningful if edition is specified to values other than - EDITION_UNSPECIFIED. Otherwise - CreateCapacityCommitmentRequest or - UpdateCapacityCommitmentRequest will be rejected with error - code ``google.rpc.Code.INVALID_ARGUMENT``. If the - renewal_plan is NONE, capacity commitment will be removed at - the end of its commitment period. - """ - COMMITMENT_PLAN_UNSPECIFIED = 0 - FLEX = 3 - FLEX_FLAT_RATE = 7 - TRIAL = 5 - MONTHLY = 2 - MONTHLY_FLAT_RATE = 8 - ANNUAL = 4 - ANNUAL_FLAT_RATE = 9 - THREE_YEAR = 10 - NONE = 6 - - class State(proto.Enum): - r"""Capacity commitment can either become ACTIVE right away or - transition from PENDING to ACTIVE or FAILED. - - Values: - STATE_UNSPECIFIED (0): - Invalid state value. - PENDING (1): - Capacity commitment is pending provisioning. Pending - capacity commitment does not contribute to the project's - slot_capacity. - ACTIVE (2): - Once slots are provisioned, capacity commitment becomes - active. slot_count is added to the project's slot_capacity. - FAILED (3): - Capacity commitment is failed to be activated - by the backend. - """ - STATE_UNSPECIFIED = 0 - PENDING = 1 - ACTIVE = 2 - FAILED = 3 - - name: str = proto.Field( - proto.STRING, - number=1, - ) - slot_count: int = proto.Field( - proto.INT64, - number=2, - ) - plan: CommitmentPlan = proto.Field( - proto.ENUM, - number=3, - enum=CommitmentPlan, - ) - state: State = proto.Field( - proto.ENUM, - number=4, - enum=State, - ) - commitment_start_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=9, - message=timestamp_pb2.Timestamp, - ) - commitment_end_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=5, - message=timestamp_pb2.Timestamp, - ) - failure_status: status_pb2.Status = proto.Field( - proto.MESSAGE, - number=7, - message=status_pb2.Status, - ) - renewal_plan: CommitmentPlan = proto.Field( - proto.ENUM, - number=8, - enum=CommitmentPlan, - ) - multi_region_auxiliary: bool = proto.Field( - proto.BOOL, - number=10, - ) - edition: 'Edition' = proto.Field( - proto.ENUM, - number=12, - enum='Edition', - ) - is_flat_rate: bool = proto.Field( - proto.BOOL, - number=14, - ) - - -class CreateReservationRequest(proto.Message): - r"""The request for - [ReservationService.CreateReservation][google.cloud.bigquery.reservation.v1.ReservationService.CreateReservation]. - - Attributes: - parent (str): - Required. Project, location. E.g., - ``projects/myproject/locations/US`` - reservation_id (str): - The reservation ID. It must only contain - lower case alphanumeric characters or dashes. It - must start with a letter and must not end with a - dash. Its maximum length is 64 characters. - reservation (google.cloud.bigquery_reservation_v1.types.Reservation): - Definition of the new reservation to create. - """ - - parent: str = proto.Field( - proto.STRING, - number=1, - ) - reservation_id: str = proto.Field( - proto.STRING, - number=2, - ) - reservation: 'Reservation' = proto.Field( - proto.MESSAGE, - number=3, - message='Reservation', - ) - - -class ListReservationsRequest(proto.Message): - r"""The request for - [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations]. - - Attributes: - parent (str): - Required. The parent resource name containing project and - location, e.g.: ``projects/myproject/locations/US`` - page_size (int): - The maximum number of items to return per - page. - 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 ListReservationsResponse(proto.Message): - r"""The response for - [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations]. - - Attributes: - reservations (MutableSequence[google.cloud.bigquery_reservation_v1.types.Reservation]): - List of reservations visible to the user. - next_page_token (str): - Token to retrieve the next page of results, - or empty if there are no more results in the - list. - """ - - @property - def raw_page(self): - return self - - reservations: MutableSequence['Reservation'] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='Reservation', - ) - next_page_token: str = proto.Field( - proto.STRING, - number=2, - ) - - -class GetReservationRequest(proto.Message): - r"""The request for - [ReservationService.GetReservation][google.cloud.bigquery.reservation.v1.ReservationService.GetReservation]. - - Attributes: - name (str): - Required. Resource name of the reservation to retrieve. - E.g., - ``projects/myproject/locations/US/reservations/team1-prod`` - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - - -class DeleteReservationRequest(proto.Message): - r"""The request for - [ReservationService.DeleteReservation][google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservation]. - - Attributes: - name (str): - Required. Resource name of the reservation to retrieve. - E.g., - ``projects/myproject/locations/US/reservations/team1-prod`` - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - - -class UpdateReservationRequest(proto.Message): - r"""The request for - [ReservationService.UpdateReservation][google.cloud.bigquery.reservation.v1.ReservationService.UpdateReservation]. - - Attributes: - reservation (google.cloud.bigquery_reservation_v1.types.Reservation): - Content of the reservation to update. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Standard field mask for the set of fields to - be updated. - """ - - reservation: 'Reservation' = proto.Field( - proto.MESSAGE, - number=1, - message='Reservation', - ) - update_mask: field_mask_pb2.FieldMask = proto.Field( - proto.MESSAGE, - number=2, - message=field_mask_pb2.FieldMask, - ) - - -class FailoverReservationRequest(proto.Message): - r"""The request for ReservationService.FailoverReservation. - - Attributes: - name (str): - Required. Resource name of the reservation to failover. - E.g., - ``projects/myproject/locations/US/reservations/team1-prod`` - failover_mode (google.cloud.bigquery_reservation_v1.types.FailoverMode): - Optional. A parameter that determines how - writes that are pending replication are handled - after a failover is initiated. If not specified, - HARD failover mode is used by default. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - failover_mode: 'FailoverMode' = proto.Field( - proto.ENUM, - number=2, - enum='FailoverMode', - ) - - -class CreateReservationGroupRequest(proto.Message): - r"""The request for - [ReservationService.CreateReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.CreateReservationGroup]. - - Attributes: - parent (str): - Required. Project, location. E.g., - ``projects/myproject/locations/US`` - reservation_group_id (str): - Required. The reservation group ID. It must - only contain lower case alphanumeric characters - or dashes. It must start with a letter and must - not end with a dash. Its maximum length is 64 - characters. - reservation_group (google.cloud.bigquery_reservation_v1.types.ReservationGroup): - Required. New Reservation Group to create. - """ - - parent: str = proto.Field( - proto.STRING, - number=1, - ) - reservation_group_id: str = proto.Field( - proto.STRING, - number=2, - ) - reservation_group: 'ReservationGroup' = proto.Field( - proto.MESSAGE, - number=3, - message='ReservationGroup', - ) - - -class GetReservationGroupRequest(proto.Message): - r"""The request for - [ReservationService.GetReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.GetReservationGroup]. - - Attributes: - name (str): - Required. Resource name of the reservation group to - retrieve. E.g., - ``projects/myproject/locations/US/reservationGroups/team1-prod`` - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - - -class ListReservationGroupsRequest(proto.Message): - r"""The request for - [ReservationService.ListReservationGroups][google.cloud.bigquery.reservation.v1.ReservationService.ListReservationGroups]. - - Attributes: - parent (str): - Required. The parent resource name containing project and - location, e.g.: ``projects/myproject/locations/US`` - page_size (int): - The maximum number of items to return per - page. - 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 ListReservationGroupsResponse(proto.Message): - r"""The response for - [ReservationService.ListReservationGroups][google.cloud.bigquery.reservation.v1.ReservationService.ListReservationGroups]. - - Attributes: - reservation_groups (MutableSequence[google.cloud.bigquery_reservation_v1.types.ReservationGroup]): - List of reservations visible to the user. - next_page_token (str): - Token to retrieve the next page of results, - or empty if there are no more results in the - list. - """ - - @property - def raw_page(self): - return self - - reservation_groups: MutableSequence['ReservationGroup'] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='ReservationGroup', - ) - next_page_token: str = proto.Field( - proto.STRING, - number=2, - ) - - -class DeleteReservationGroupRequest(proto.Message): - r"""The request for - [ReservationService.DeleteReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservationGroup]. - - Attributes: - name (str): - Required. Resource name of the reservation group to - retrieve. E.g., - ``projects/myproject/locations/US/reservationGroups/team1-prod`` - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - - -class CreateCapacityCommitmentRequest(proto.Message): - r"""The request for - [ReservationService.CreateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.CreateCapacityCommitment]. - - Attributes: - parent (str): - Required. Resource name of the parent reservation. E.g., - ``projects/myproject/locations/US`` - capacity_commitment (google.cloud.bigquery_reservation_v1.types.CapacityCommitment): - Content of the capacity commitment to create. - enforce_single_admin_project_per_org (bool): - If true, fail the request if another project - in the organization has a capacity commitment. - capacity_commitment_id (str): - The optional capacity commitment ID. Capacity - commitment name will be generated automatically - if this field is empty. This field must only - contain lower case alphanumeric characters or - dashes. The first and last character cannot be a - dash. Max length is 64 characters. NOTE: this ID - won't be kept if the capacity commitment is - split or merged. - """ - - parent: str = proto.Field( - proto.STRING, - number=1, - ) - capacity_commitment: 'CapacityCommitment' = proto.Field( - proto.MESSAGE, - number=2, - message='CapacityCommitment', - ) - enforce_single_admin_project_per_org: bool = proto.Field( - proto.BOOL, - number=4, - ) - capacity_commitment_id: str = proto.Field( - proto.STRING, - number=5, - ) - - -class ListCapacityCommitmentsRequest(proto.Message): - r"""The request for - [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments]. - - Attributes: - parent (str): - Required. Resource name of the parent reservation. E.g., - ``projects/myproject/locations/US`` - 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 ListCapacityCommitmentsResponse(proto.Message): - r"""The response for - [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments]. - - Attributes: - capacity_commitments (MutableSequence[google.cloud.bigquery_reservation_v1.types.CapacityCommitment]): - List of capacity commitments visible to the - user. - next_page_token (str): - Token to retrieve the next page of results, - or empty if there are no more results in the - list. - """ - - @property - def raw_page(self): - return self - - capacity_commitments: MutableSequence['CapacityCommitment'] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='CapacityCommitment', - ) - next_page_token: str = proto.Field( - proto.STRING, - number=2, - ) - - -class GetCapacityCommitmentRequest(proto.Message): - r"""The request for - [ReservationService.GetCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitment]. - - Attributes: - name (str): - Required. Resource name of the capacity commitment to - retrieve. E.g., - ``projects/myproject/locations/US/capacityCommitments/123`` - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - - -class DeleteCapacityCommitmentRequest(proto.Message): - r"""The request for - [ReservationService.DeleteCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteCapacityCommitment]. - - Attributes: - name (str): - Required. Resource name of the capacity commitment to - delete. E.g., - ``projects/myproject/locations/US/capacityCommitments/123`` - force (bool): - Can be used to force delete commitments even - if assignments exist. Deleting commitments with - assignments may cause queries to fail if they no - longer have access to slots. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - force: bool = proto.Field( - proto.BOOL, - number=3, - ) - - -class UpdateCapacityCommitmentRequest(proto.Message): - r"""The request for - [ReservationService.UpdateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateCapacityCommitment]. - - Attributes: - capacity_commitment (google.cloud.bigquery_reservation_v1.types.CapacityCommitment): - Content of the capacity commitment to update. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Standard field mask for the set of fields to - be updated. - """ - - capacity_commitment: 'CapacityCommitment' = proto.Field( - proto.MESSAGE, - number=1, - message='CapacityCommitment', - ) - update_mask: field_mask_pb2.FieldMask = proto.Field( - proto.MESSAGE, - number=2, - message=field_mask_pb2.FieldMask, - ) - - -class SplitCapacityCommitmentRequest(proto.Message): - r"""The request for - [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment]. - - Attributes: - name (str): - Required. The resource name e.g.,: - ``projects/myproject/locations/US/capacityCommitments/123`` - slot_count (int): - Number of slots in the capacity commitment - after the split. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - slot_count: int = proto.Field( - proto.INT64, - number=2, - ) - - -class SplitCapacityCommitmentResponse(proto.Message): - r"""The response for - [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment]. - - Attributes: - first (google.cloud.bigquery_reservation_v1.types.CapacityCommitment): - First capacity commitment, result of a split. - second (google.cloud.bigquery_reservation_v1.types.CapacityCommitment): - Second capacity commitment, result of a - split. - """ - - first: 'CapacityCommitment' = proto.Field( - proto.MESSAGE, - number=1, - message='CapacityCommitment', - ) - second: 'CapacityCommitment' = proto.Field( - proto.MESSAGE, - number=2, - message='CapacityCommitment', - ) - - -class MergeCapacityCommitmentsRequest(proto.Message): - r"""The request for - [ReservationService.MergeCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.MergeCapacityCommitments]. - - Attributes: - parent (str): - Parent resource that identifies admin project and location - e.g., ``projects/myproject/locations/us`` - capacity_commitment_ids (MutableSequence[str]): - Ids of capacity commitments to merge. - These capacity commitments must exist under - admin project and location specified in the - parent. - ID is the last portion of capacity commitment - name e.g., 'abc' for - projects/myproject/locations/US/capacityCommitments/abc - capacity_commitment_id (str): - Optional. The optional resulting capacity - commitment ID. Capacity commitment name will be - generated automatically if this field is empty. - This field must only contain lower case - alphanumeric characters or dashes. The first and - last character cannot be a dash. Max length is - 64 characters. - """ - - parent: str = proto.Field( - proto.STRING, - number=1, - ) - capacity_commitment_ids: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=2, - ) - capacity_commitment_id: str = proto.Field( - proto.STRING, - number=3, - ) - - -class Assignment(proto.Message): - r"""An assignment allows a project to submit jobs - of a certain type using slots from the specified reservation. - - Attributes: - name (str): - Output only. Name of the resource. E.g.: - ``projects/myproject/locations/US/reservations/team1-prod/assignments/123``. - The assignment_id must only contain lower case alphanumeric - characters or dashes and the max length is 64 characters. - assignee (str): - Optional. The resource which will use the reservation. E.g. - ``projects/myproject``, ``folders/123``, or - ``organizations/456``. - job_type (google.cloud.bigquery_reservation_v1.types.Assignment.JobType): - Optional. Which type of jobs will use the - reservation. - state (google.cloud.bigquery_reservation_v1.types.Assignment.State): - Output only. State of the assignment. - enable_gemini_in_bigquery (bool): - Optional. This field controls if "Gemini in BigQuery" - (https://cloud.google.com/gemini/docs/bigquery/overview) - features should be enabled for this reservation assignment, - which is not on by default. "Gemini in BigQuery" has a - distinct compliance posture from BigQuery. If this field is - set to true, the assignment job type is QUERY, and the - parent reservation edition is ENTERPRISE_PLUS, then the - assignment will give the grantee project/organization access - to "Gemini in BigQuery" features. - scheduling_policy (google.cloud.bigquery_reservation_v1.types.SchedulingPolicy): - Optional. The scheduling policy to use for - jobs and queries of this assignee when running - under the associated reservation. The scheduling - policy controls how the reservation's resources - are distributed. This overrides the default - scheduling policy specified on the reservation. - - This feature is not yet generally available. - """ - class JobType(proto.Enum): - r"""Types of job, which could be specified when using the - reservation. - - Values: - JOB_TYPE_UNSPECIFIED (0): - Invalid type. Requests with this value will be rejected with - error code ``google.rpc.Code.INVALID_ARGUMENT``. - PIPELINE (1): - Pipeline (load/export) jobs from the project - will use the reservation. - QUERY (2): - Query jobs from the project will use the - reservation. - ML_EXTERNAL (3): - BigQuery ML jobs that use services external - to BigQuery for model training. These jobs will - not utilize idle slots from other reservations. - BACKGROUND (4): - Background jobs that BigQuery runs for the - customers in the background. - CONTINUOUS (6): - Continuous SQL jobs will use this - reservation. Reservations with continuous - assignments cannot be mixed with non-continuous - assignments. - BACKGROUND_CHANGE_DATA_CAPTURE (7): - Finer granularity background jobs for - capturing changes in a source database and - streaming them into BigQuery. Reservations with - this job type take priority over a default - BACKGROUND reservation assignment (if it - exists). - BACKGROUND_COLUMN_METADATA_INDEX (8): - Finer granularity background jobs for - refreshing cached metadata for BigQuery tables. - Reservations with this job type take priority - over a default BACKGROUND reservation assignment - (if it exists). - BACKGROUND_SEARCH_INDEX_REFRESH (9): - Finer granularity background jobs for - refreshing search indexes upon BigQuery table - columns. Reservations with this job type take - priority over a default BACKGROUND reservation - assignment (if it exists). - """ - JOB_TYPE_UNSPECIFIED = 0 - PIPELINE = 1 - QUERY = 2 - ML_EXTERNAL = 3 - BACKGROUND = 4 - CONTINUOUS = 6 - BACKGROUND_CHANGE_DATA_CAPTURE = 7 - BACKGROUND_COLUMN_METADATA_INDEX = 8 - BACKGROUND_SEARCH_INDEX_REFRESH = 9 - - class State(proto.Enum): - r"""Assignment will remain in PENDING state if no active capacity - commitment is present. It will become ACTIVE when some capacity - commitment becomes active. - - Values: - STATE_UNSPECIFIED (0): - Invalid state value. - PENDING (1): - Queries from assignee will be executed as - on-demand, if related assignment is pending. - ACTIVE (2): - Assignment is ready. - """ - STATE_UNSPECIFIED = 0 - PENDING = 1 - ACTIVE = 2 - - name: str = proto.Field( - proto.STRING, - number=1, - ) - assignee: str = proto.Field( - proto.STRING, - number=4, - ) - job_type: JobType = proto.Field( - proto.ENUM, - number=3, - enum=JobType, - ) - state: State = proto.Field( - proto.ENUM, - number=6, - enum=State, - ) - enable_gemini_in_bigquery: bool = proto.Field( - proto.BOOL, - number=10, - ) - scheduling_policy: 'SchedulingPolicy' = proto.Field( - proto.MESSAGE, - number=11, - message='SchedulingPolicy', - ) - - -class CreateAssignmentRequest(proto.Message): - r"""The request for - [ReservationService.CreateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.CreateAssignment]. - Note: "bigquery.reservationAssignments.create" permission is - required on the related assignee. - - Attributes: - parent (str): - Required. The parent resource name of the assignment E.g. - ``projects/myproject/locations/US/reservations/team1-prod`` - assignment (google.cloud.bigquery_reservation_v1.types.Assignment): - Assignment resource to create. - assignment_id (str): - The optional assignment ID. Assignment name - will be generated automatically if this field is - empty. This field must only contain lower case - alphanumeric characters or dashes. Max length is - 64 characters. - """ - - parent: str = proto.Field( - proto.STRING, - number=1, - ) - assignment: 'Assignment' = proto.Field( - proto.MESSAGE, - number=2, - message='Assignment', - ) - assignment_id: str = proto.Field( - proto.STRING, - number=4, - ) - - -class ListAssignmentsRequest(proto.Message): - r"""The request for - [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments]. - - Attributes: - parent (str): - Required. The parent resource name e.g.: - - ``projects/myproject/locations/US/reservations/team1-prod`` - - Or: - - ``projects/myproject/locations/US/reservations/-`` - page_size (int): - The maximum number of items to return per - page. - 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 ListAssignmentsResponse(proto.Message): - r"""The response for - [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments]. - - Attributes: - assignments (MutableSequence[google.cloud.bigquery_reservation_v1.types.Assignment]): - List of assignments visible to the user. - next_page_token (str): - Token to retrieve the next page of results, - or empty if there are no more results in the - list. - """ - - @property - def raw_page(self): - return self - - assignments: MutableSequence['Assignment'] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='Assignment', - ) - next_page_token: str = proto.Field( - proto.STRING, - number=2, - ) - - -class DeleteAssignmentRequest(proto.Message): - r"""The request for - [ReservationService.DeleteAssignment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteAssignment]. - Note: "bigquery.reservationAssignments.delete" permission is - required on the related assignee. - - Attributes: - name (str): - Required. Name of the resource, e.g. - ``projects/myproject/locations/US/reservations/team1-prod/assignments/123`` - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - - -class SearchAssignmentsRequest(proto.Message): - r"""The request for - [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. - Note: "bigquery.reservationAssignments.search" permission is - required on the related assignee. - - Attributes: - parent (str): - Required. The resource name of the admin project(containing - project and location), e.g.: - ``projects/myproject/locations/US``. - query (str): - Please specify resource name as assignee in the query. - - Examples: - - - ``assignee=projects/myproject`` - - ``assignee=folders/123`` - - ``assignee=organizations/456`` - page_size (int): - The maximum number of items to return per - page. - page_token (str): - The next_page_token value returned from a previous List - request, if any. - """ - - parent: str = proto.Field( - proto.STRING, - number=1, - ) - query: str = proto.Field( - proto.STRING, - number=2, - ) - page_size: int = proto.Field( - proto.INT32, - number=3, - ) - page_token: str = proto.Field( - proto.STRING, - number=4, - ) - - -class SearchAllAssignmentsRequest(proto.Message): - r"""The request for - [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. - Note: "bigquery.reservationAssignments.search" permission is - required on the related assignee. - - Attributes: - parent (str): - Required. The resource name with location (project name - could be the wildcard '-'), e.g.: - ``projects/-/locations/US``. - query (str): - Please specify resource name as assignee in the query. - - Examples: - - - ``assignee=projects/myproject`` - - ``assignee=folders/123`` - - ``assignee=organizations/456`` - page_size (int): - The maximum number of items to return per - page. - page_token (str): - The next_page_token value returned from a previous List - request, if any. - """ - - parent: str = proto.Field( - proto.STRING, - number=1, - ) - query: str = proto.Field( - proto.STRING, - number=2, - ) - page_size: int = proto.Field( - proto.INT32, - number=3, - ) - page_token: str = proto.Field( - proto.STRING, - number=4, - ) - - -class SearchAssignmentsResponse(proto.Message): - r"""The response for - [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. - - Attributes: - assignments (MutableSequence[google.cloud.bigquery_reservation_v1.types.Assignment]): - List of assignments visible to the user. - next_page_token (str): - Token to retrieve the next page of results, - or empty if there are no more results in the - list. - """ - - @property - def raw_page(self): - return self - - assignments: MutableSequence['Assignment'] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='Assignment', - ) - next_page_token: str = proto.Field( - proto.STRING, - number=2, - ) - - -class SearchAllAssignmentsResponse(proto.Message): - r"""The response for - [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. - - Attributes: - assignments (MutableSequence[google.cloud.bigquery_reservation_v1.types.Assignment]): - List of assignments visible to the user. - next_page_token (str): - Token to retrieve the next page of results, - or empty if there are no more results in the - list. - """ - - @property - def raw_page(self): - return self - - assignments: MutableSequence['Assignment'] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='Assignment', - ) - next_page_token: str = proto.Field( - proto.STRING, - number=2, - ) - - -class MoveAssignmentRequest(proto.Message): - r"""The request for - [ReservationService.MoveAssignment][google.cloud.bigquery.reservation.v1.ReservationService.MoveAssignment]. - - **Note**: "bigquery.reservationAssignments.create" permission is - required on the destination_id. - - **Note**: "bigquery.reservationAssignments.create" and - "bigquery.reservationAssignments.delete" permission are required on - the related assignee. - - Attributes: - name (str): - Required. The resource name of the assignment, e.g. - ``projects/myproject/locations/US/reservations/team1-prod/assignments/123`` - destination_id (str): - The new reservation ID, e.g.: - ``projects/myotherproject/locations/US/reservations/team2-prod`` - assignment_id (str): - The optional assignment ID. A new assignment - name is generated if this field is empty. - - This field can contain only lowercase - alphanumeric characters or dashes. Max length is - 64 characters. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - destination_id: str = proto.Field( - proto.STRING, - number=3, - ) - assignment_id: str = proto.Field( - proto.STRING, - number=5, - ) - - -class UpdateAssignmentRequest(proto.Message): - r"""The request for - [ReservationService.UpdateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateAssignment]. - - Attributes: - assignment (google.cloud.bigquery_reservation_v1.types.Assignment): - Content of the assignment to update. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Standard field mask for the set of fields to - be updated. - """ - - assignment: 'Assignment' = proto.Field( - proto.MESSAGE, - number=1, - message='Assignment', - ) - update_mask: field_mask_pb2.FieldMask = proto.Field( - proto.MESSAGE, - number=2, - message=field_mask_pb2.FieldMask, - ) - - -class TableReference(proto.Message): - r"""Fully qualified reference to BigQuery table. - Internally stored as google.cloud.bi.v1.BqTableReference. - - Attributes: - project_id (str): - Optional. The assigned project ID of the - project. - dataset_id (str): - Optional. The ID of the dataset in the above - project. - table_id (str): - Optional. The ID of the table in the above - dataset. - """ - - project_id: str = proto.Field( - proto.STRING, - number=1, - ) - dataset_id: str = proto.Field( - proto.STRING, - number=2, - ) - table_id: str = proto.Field( - proto.STRING, - number=3, - ) - - -class BiReservation(proto.Message): - r"""Represents a BI Reservation. - - Attributes: - name (str): - Identifier. The resource name of the singleton BI - reservation. Reservation names have the form - ``projects/{project_id}/locations/{location_id}/biReservation``. - update_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. The last update timestamp of a - reservation. - size (int): - Optional. Size of a reservation, in bytes. - preferred_tables (MutableSequence[google.cloud.bigquery_reservation_v1.types.TableReference]): - Optional. Preferred tables to use BI capacity - for. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - update_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=3, - message=timestamp_pb2.Timestamp, - ) - size: int = proto.Field( - proto.INT64, - number=4, - ) - preferred_tables: MutableSequence['TableReference'] = proto.RepeatedField( - proto.MESSAGE, - number=5, - message='TableReference', - ) - - -class GetBiReservationRequest(proto.Message): - r"""A request to get a singleton BI reservation. - - Attributes: - name (str): - Required. Name of the requested reservation, for example: - ``projects/{project_id}/locations/{location_id}/biReservation`` - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - - -class UpdateBiReservationRequest(proto.Message): - r"""A request to update a BI reservation. - - Attributes: - bi_reservation (google.cloud.bigquery_reservation_v1.types.BiReservation): - A reservation to update. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - A list of fields to be updated in this - request. - """ - - bi_reservation: 'BiReservation' = proto.Field( - proto.MESSAGE, - number=1, - message='BiReservation', - ) - update_mask: field_mask_pb2.FieldMask = proto.Field( - proto.MESSAGE, - number=2, - message=field_mask_pb2.FieldMask, - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/mypy.ini b/owl-bot-staging/google-cloud-bigquery-reservation/v1/mypy.ini deleted file mode 100644 index 574c5aed394b..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/mypy.ini +++ /dev/null @@ -1,3 +0,0 @@ -[mypy] -python_version = 3.7 -namespace_packages = True diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/noxfile.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/noxfile.py deleted file mode 100644 index b3e9bbfd0e5c..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/noxfile.py +++ /dev/null @@ -1,591 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 re -import shutil - -from typing import Dict, List -import warnings - -import nox - -BLACK_VERSION = "black[jupyter]==23.7.0" -ISORT_VERSION = "isort==5.11.0" - -LINT_PATHS = ["docs", "google", "tests", "noxfile.py", "setup.py"] - -ALL_PYTHON = [ - "3.7", - "3.8", - "3.9", - "3.10", - "3.11", - "3.12", - "3.13", -] - -DEFAULT_PYTHON_VERSION = ALL_PYTHON[-1] - -CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() - -LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" -PACKAGE_NAME = "google-cloud-bigquery-reservation" - -UNIT_TEST_STANDARD_DEPENDENCIES = [ - "mock", - "asyncmock", - "pytest", - "pytest-cov", - "pytest-asyncio", -] -UNIT_TEST_EXTERNAL_DEPENDENCIES: List[str] = [] -UNIT_TEST_LOCAL_DEPENDENCIES: List[str] = [] -UNIT_TEST_DEPENDENCIES: List[str] = [] -UNIT_TEST_EXTRAS: List[str] = [] -UNIT_TEST_EXTRAS_BY_PYTHON: Dict[str, List[str]] = {} - -SYSTEM_TEST_PYTHON_VERSIONS: List[str] = ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"] -SYSTEM_TEST_STANDARD_DEPENDENCIES = [ - "mock", - "pytest", - "google-cloud-testutils", -] -SYSTEM_TEST_EXTERNAL_DEPENDENCIES: List[str] = [] -SYSTEM_TEST_LOCAL_DEPENDENCIES: List[str] = [] -SYSTEM_TEST_DEPENDENCIES: List[str] = [] -SYSTEM_TEST_EXTRAS: List[str] = [] -SYSTEM_TEST_EXTRAS_BY_PYTHON: Dict[str, List[str]] = {} - -nox.options.sessions = [ - "unit", - "system", - "cover", - "lint", - "lint_setup_py", - "blacken", - "docs", -] - -# Error if a python version is missing -nox.options.error_on_missing_interpreters = True - - -@nox.session(python=ALL_PYTHON) -def mypy(session): - """Run the type checker.""" - session.install( - # TODO(https://github.com/googleapis/gapic-generator-python/issues/2410): Use the latest version of mypy - "mypy<1.16.0", - "types-requests", - "types-protobuf", - ) - session.install(".") - session.run( - "mypy", - "-p", - "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 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", - *LINT_PATHS, - ) - - session.run("flake8", "google", "tests") - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def blacken(session): - """Run black. Format code to uniform standard.""" - session.install(BLACK_VERSION) - session.run( - "black", - *LINT_PATHS, - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def format(session): - """ - Run isort to sort imports. Then run black - to format code to uniform standard. - """ - session.install(BLACK_VERSION, ISORT_VERSION) - # Use the --fss option to sort imports using strict alphabetical order. - # See https://pycqa.github.io/isort/docs/configuration/options.html#force-sort-within-sections - session.run( - "isort", - "--fss", - *LINT_PATHS, - ) - session.run( - "black", - *LINT_PATHS, - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def lint_setup_py(session): - """Verify that setup.py is valid (including RST check).""" - session.install("setuptools", "docutils", "pygments") - session.run("python", "setup.py", "check", "--restructuredtext", "--strict") - - -def install_unittest_dependencies(session, *constraints): - standard_deps = UNIT_TEST_STANDARD_DEPENDENCIES + UNIT_TEST_DEPENDENCIES - session.install(*standard_deps, *constraints) - - if UNIT_TEST_EXTERNAL_DEPENDENCIES: - warnings.warn( - "'unit_test_external_dependencies' is deprecated. Instead, please " - "use 'unit_test_dependencies' or 'unit_test_local_dependencies'.", - DeprecationWarning, - ) - session.install(*UNIT_TEST_EXTERNAL_DEPENDENCIES, *constraints) - - if UNIT_TEST_LOCAL_DEPENDENCIES: - session.install(*UNIT_TEST_LOCAL_DEPENDENCIES, *constraints) - - if UNIT_TEST_EXTRAS_BY_PYTHON: - extras = UNIT_TEST_EXTRAS_BY_PYTHON.get(session.python, []) - elif UNIT_TEST_EXTRAS: - extras = UNIT_TEST_EXTRAS - else: - extras = [] - - if extras: - session.install("-e", f".[{','.join(extras)}]", *constraints) - else: - session.install("-e", ".", *constraints) - - -@nox.session(python=ALL_PYTHON) -@nox.parametrize( - "protobuf_implementation", - ["python", "upb", "cpp"], -) -def unit(session, protobuf_implementation): - # Install all test dependencies, then install this package in-place. - - if protobuf_implementation == "cpp" and session.python in ("3.11", "3.12", "3.13"): - session.skip("cpp implementation is not supported in python 3.11+") - - constraints_path = str( - CURRENT_DIRECTORY / "testing" / f"constraints-{session.python}.txt" - ) - install_unittest_dependencies(session, "-c", constraints_path) - - # TODO(https://github.com/googleapis/synthtool/issues/1976): - # Remove the 'cpp' implementation once support for Protobuf 3.x is dropped. - # The 'cpp' implementation requires Protobuf<4. - if protobuf_implementation == "cpp": - session.install("protobuf<4") - - # Run py.test against the unit tests. - session.run( - "py.test", - "--quiet", - f"--junitxml=unit_{session.python}_sponge_log.xml", - "--cov=google", - "--cov=tests/unit", - "--cov-append", - "--cov-config=.coveragerc", - "--cov-report=", - "--cov-fail-under=0", - os.path.join("tests", "unit"), - *session.posargs, - env={ - "PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION": protobuf_implementation, - }, - ) - - -def install_systemtest_dependencies(session, *constraints): - session.install("--pre", "grpcio") - - session.install(*SYSTEM_TEST_STANDARD_DEPENDENCIES, *constraints) - - if SYSTEM_TEST_EXTERNAL_DEPENDENCIES: - session.install(*SYSTEM_TEST_EXTERNAL_DEPENDENCIES, *constraints) - - if SYSTEM_TEST_LOCAL_DEPENDENCIES: - session.install("-e", *SYSTEM_TEST_LOCAL_DEPENDENCIES, *constraints) - - if SYSTEM_TEST_DEPENDENCIES: - session.install("-e", *SYSTEM_TEST_DEPENDENCIES, *constraints) - - if SYSTEM_TEST_EXTRAS_BY_PYTHON: - extras = SYSTEM_TEST_EXTRAS_BY_PYTHON.get(session.python, []) - elif SYSTEM_TEST_EXTRAS: - extras = SYSTEM_TEST_EXTRAS - else: - extras = [] - - if extras: - session.install("-e", f".[{','.join(extras)}]", *constraints) - else: - session.install("-e", ".", *constraints) - - -@nox.session(python=SYSTEM_TEST_PYTHON_VERSIONS) -def system(session): - """Run the system test suite.""" - constraints_path = str( - CURRENT_DIRECTORY / "testing" / f"constraints-{session.python}.txt" - ) - system_test_path = os.path.join("tests", "system.py") - system_test_folder_path = os.path.join("tests", "system") - - # Check the value of `RUN_SYSTEM_TESTS` env var. It defaults to true. - if os.environ.get("RUN_SYSTEM_TESTS", "true") == "false": - session.skip("RUN_SYSTEM_TESTS is set to false, skipping") - # Install pyopenssl for mTLS testing. - if os.environ.get("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") == "true": - session.install("pyopenssl") - - system_test_exists = os.path.exists(system_test_path) - system_test_folder_exists = os.path.exists(system_test_folder_path) - # Sanity check: only run tests if found. - if not system_test_exists and not system_test_folder_exists: - session.skip("System tests were not found") - - install_systemtest_dependencies(session, "-c", constraints_path) - - # Run py.test against the system tests. - if system_test_exists: - session.run( - "py.test", - "--quiet", - f"--junitxml=system_{session.python}_sponge_log.xml", - system_test_path, - *session.posargs, - ) - if system_test_folder_exists: - session.run( - "py.test", - "--quiet", - f"--junitxml=system_{session.python}_sponge_log.xml", - system_test_folder_path, - *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="3.10") -def docs(session): - """Build the docs for this library.""" - - session.install("-e", ".") - session.install( - # We need to pin to specific versions of the `sphinxcontrib-*` packages - # which still support sphinx 4.x. - # See https://github.com/googleapis/sphinx-docfx-yaml/issues/344 - # and https://github.com/googleapis/sphinx-docfx-yaml/issues/345. - "sphinxcontrib-applehelp==1.0.4", - "sphinxcontrib-devhelp==1.0.2", - "sphinxcontrib-htmlhelp==2.0.1", - "sphinxcontrib-qthelp==1.0.3", - "sphinxcontrib-serializinghtml==1.1.5", - "sphinx==4.5.0", - "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", # builder - "-d", os.path.join("docs", "_build", "doctrees", ""), # cache directory - # paths to build: - os.path.join("docs", ""), - os.path.join("docs", "_build", "html", ""), - ) - - -@nox.session(python="3.10") -def docfx(session): - """Build the docfx yaml files for this library.""" - - session.install("-e", ".") - session.install( - # We need to pin to specific versions of the `sphinxcontrib-*` packages - # which still support sphinx 4.x. - # See https://github.com/googleapis/sphinx-docfx-yaml/issues/344 - # and https://github.com/googleapis/sphinx-docfx-yaml/issues/345. - "sphinxcontrib-applehelp==1.0.4", - "sphinxcontrib-devhelp==1.0.2", - "sphinxcontrib-htmlhelp==2.0.1", - "sphinxcontrib-qthelp==1.0.3", - "sphinxcontrib-serializinghtml==1.1.5", - "gcp-sphinx-docfx-yaml", - "alabaster", - "recommonmark", - ) - - shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) - session.run( - "sphinx-build", - "-T", # show full traceback on exception - "-N", # no colors - "-D", - ( - "extensions=sphinx.ext.autodoc," - "sphinx.ext.autosummary," - "docfx_yaml.extension," - "sphinx.ext.intersphinx," - "sphinx.ext.coverage," - "sphinx.ext.napoleon," - "sphinx.ext.todo," - "sphinx.ext.viewcode," - "recommonmark" - ), - "-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) -@nox.parametrize( - "protobuf_implementation", - ["python", "upb", "cpp"], -) -def prerelease_deps(session, protobuf_implementation): - """ - Run all tests with pre-release versions of dependencies installed - rather than the standard non pre-release versions. - Pre-release versions can be installed using - `pip install --pre `. - """ - - if protobuf_implementation == "cpp" and session.python in ("3.11", "3.12", "3.13"): - session.skip("cpp implementation is not supported in python 3.11+") - - # Install all dependencies - session.install("-e", ".") - - # Install dependencies for the unit test environment - unit_deps_all = UNIT_TEST_STANDARD_DEPENDENCIES + UNIT_TEST_EXTERNAL_DEPENDENCIES - session.install(*unit_deps_all) - - # Install dependencies for the system test environment - system_deps_all = ( - SYSTEM_TEST_STANDARD_DEPENDENCIES - + SYSTEM_TEST_EXTERNAL_DEPENDENCIES - + SYSTEM_TEST_EXTRAS - ) - session.install(*system_deps_all) - - # Because we test minimum dependency versions on the minimum Python - # version, the first version we test with in the unit tests sessions has a - # constraints file containing all dependencies and extras. - with open( - CURRENT_DIRECTORY / "testing" / f"constraints-{ALL_PYTHON[0]}.txt", - encoding="utf-8", - ) as constraints_file: - constraints_text = constraints_file.read() - - # Ignore leading whitespace and comment lines. - constraints_deps = [ - match.group(1) - for match in re.finditer( - r"^\s*(\S+)(?===\S+)", constraints_text, flags=re.MULTILINE - ) - ] - - # Install dependencies specified in `testing/constraints-X.txt`. - session.install(*constraints_deps) - - # Note: If a dependency is added to the `prerel_deps` list, - # the `core_dependencies_from_source` list in the `core_deps_from_source` - # nox session should also be updated. - prerel_deps = [ - "googleapis-common-protos", - "google-api-core", - "google-auth", - "grpc-google-iam-v1", - "grpcio", - "grpcio-status", - "protobuf", - "proto-plus", - ] - - for dep in prerel_deps: - session.install("--pre", "--no-deps", "--ignore-installed", dep) - # TODO(https://github.com/grpc/grpc/issues/38965): Add `grpcio-status`` - # to the dictionary below once this bug is fixed. - # TODO(https://github.com/googleapis/google-cloud-python/issues/13643): Add - # `googleapis-common-protos` and `grpc-google-iam-v1` to the dictionary below - # once this bug is fixed. - package_namespaces = { - "google-api-core": "google.api_core", - "google-auth": "google.auth", - "grpcio": "grpc", - "protobuf": "google.protobuf", - "proto-plus": "proto", - } - - version_namespace = package_namespaces.get(dep) - - print(f"Installed {dep}") - if version_namespace: - session.run( - "python", - "-c", - f"import {version_namespace}; print({version_namespace}.__version__)", - ) - - session.run( - "py.test", - "tests/unit", - env={ - "PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION": protobuf_implementation, - }, - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -@nox.parametrize( - "protobuf_implementation", - ["python", "upb"], -) -def core_deps_from_source(session, protobuf_implementation): - """Run all tests with core dependencies installed from source - rather than pulling the dependencies from PyPI. - """ - - # Install all dependencies - session.install("-e", ".") - - # Install dependencies for the unit test environment - unit_deps_all = UNIT_TEST_STANDARD_DEPENDENCIES + UNIT_TEST_EXTERNAL_DEPENDENCIES - session.install(*unit_deps_all) - - # Install dependencies for the system test environment - system_deps_all = ( - SYSTEM_TEST_STANDARD_DEPENDENCIES - + SYSTEM_TEST_EXTERNAL_DEPENDENCIES - + SYSTEM_TEST_EXTRAS - ) - session.install(*system_deps_all) - - # Because we test minimum dependency versions on the minimum Python - # version, the first version we test with in the unit tests sessions has a - # constraints file containing all dependencies and extras. - with open( - CURRENT_DIRECTORY / "testing" / f"constraints-{ALL_PYTHON[0]}.txt", - encoding="utf-8", - ) as constraints_file: - constraints_text = constraints_file.read() - - # Ignore leading whitespace and comment lines. - constraints_deps = [ - match.group(1) - for match in re.finditer( - r"^\s*(\S+)(?===\S+)", constraints_text, flags=re.MULTILINE - ) - ] - - # Install dependencies specified in `testing/constraints-X.txt`. - session.install(*constraints_deps) - - # TODO(https://github.com/googleapis/gapic-generator-python/issues/2358): `grpcio` and - # `grpcio-status` should be added to the list below so that they are installed from source, - # rather than PyPI. - # TODO(https://github.com/googleapis/gapic-generator-python/issues/2357): `protobuf` should be - # added to the list below so that it is installed from source, rather than PyPI - # Note: If a dependency is added to the `core_dependencies_from_source` list, - # the `prerel_deps` list in the `prerelease_deps` nox session should also be updated. - core_dependencies_from_source = [ - "googleapis-common-protos @ git+https://github.com/googleapis/google-cloud-python#egg=googleapis-common-protos&subdirectory=packages/googleapis-common-protos", - "google-api-core @ git+https://github.com/googleapis/python-api-core.git", - "google-auth @ git+https://github.com/googleapis/google-auth-library-python.git", - "grpc-google-iam-v1 @ git+https://github.com/googleapis/google-cloud-python#egg=grpc-google-iam-v1&subdirectory=packages/grpc-google-iam-v1", - "proto-plus @ git+https://github.com/googleapis/proto-plus-python.git", - ] - - for dep in core_dependencies_from_source: - session.install(dep, "--no-deps", "--ignore-installed") - print(f"Installed {dep}") - - session.run( - "py.test", - "tests/unit", - env={ - "PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION": protobuf_implementation, - }, - ) diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_assignment_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_assignment_async.py deleted file mode 100644 index a96d6eae668c..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_assignment_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 CreateAssignment -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_CreateAssignment_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 bigquery_reservation_v1 - - -async def sample_create_assignment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.CreateAssignmentRequest( - parent="parent_value", - ) - - # Make the request - response = await client.create_assignment(request=request) - - # Handle the response - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_CreateAssignment_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_assignment_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_assignment_sync.py deleted file mode 100644 index 3d3376cf7dda..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_assignment_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 CreateAssignment -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_CreateAssignment_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 bigquery_reservation_v1 - - -def sample_create_assignment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.CreateAssignmentRequest( - parent="parent_value", - ) - - # Make the request - response = client.create_assignment(request=request) - - # Handle the response - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_CreateAssignment_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_capacity_commitment_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_capacity_commitment_async.py deleted file mode 100644 index 0c4033711d5e..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_capacity_commitment_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 CreateCapacityCommitment -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_CreateCapacityCommitment_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 bigquery_reservation_v1 - - -async def sample_create_capacity_commitment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.CreateCapacityCommitmentRequest( - parent="parent_value", - ) - - # Make the request - response = await client.create_capacity_commitment(request=request) - - # Handle the response - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_CreateCapacityCommitment_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_capacity_commitment_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_capacity_commitment_sync.py deleted file mode 100644 index ca54f48c0e85..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_capacity_commitment_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 CreateCapacityCommitment -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_CreateCapacityCommitment_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 bigquery_reservation_v1 - - -def sample_create_capacity_commitment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.CreateCapacityCommitmentRequest( - parent="parent_value", - ) - - # Make the request - response = client.create_capacity_commitment(request=request) - - # Handle the response - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_CreateCapacityCommitment_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_reservation_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_reservation_async.py deleted file mode 100644 index 1f823147ff48..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_reservation_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 CreateReservation -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_CreateReservation_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 bigquery_reservation_v1 - - -async def sample_create_reservation(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.CreateReservationRequest( - parent="parent_value", - ) - - # Make the request - response = await client.create_reservation(request=request) - - # Handle the response - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_CreateReservation_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_reservation_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_reservation_sync.py deleted file mode 100644 index 37f1cd45adc5..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_reservation_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 CreateReservation -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_CreateReservation_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 bigquery_reservation_v1 - - -def sample_create_reservation(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.CreateReservationRequest( - parent="parent_value", - ) - - # Make the request - response = client.create_reservation(request=request) - - # Handle the response - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_CreateReservation_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_assignment_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_assignment_async.py deleted file mode 100644 index 7b37bedb0804..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_assignment_async.py +++ /dev/null @@ -1,50 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 DeleteAssignment -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_DeleteAssignment_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 bigquery_reservation_v1 - - -async def sample_delete_assignment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.DeleteAssignmentRequest( - name="name_value", - ) - - # Make the request - await client.delete_assignment(request=request) - - -# [END bigqueryreservation_v1_generated_ReservationService_DeleteAssignment_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_assignment_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_assignment_sync.py deleted file mode 100644 index 63ef959f4faf..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_assignment_sync.py +++ /dev/null @@ -1,50 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 DeleteAssignment -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_DeleteAssignment_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 bigquery_reservation_v1 - - -def sample_delete_assignment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.DeleteAssignmentRequest( - name="name_value", - ) - - # Make the request - client.delete_assignment(request=request) - - -# [END bigqueryreservation_v1_generated_ReservationService_DeleteAssignment_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_capacity_commitment_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_capacity_commitment_async.py deleted file mode 100644 index 28b509262b83..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_capacity_commitment_async.py +++ /dev/null @@ -1,50 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 DeleteCapacityCommitment -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_DeleteCapacityCommitment_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 bigquery_reservation_v1 - - -async def sample_delete_capacity_commitment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.DeleteCapacityCommitmentRequest( - name="name_value", - ) - - # Make the request - await client.delete_capacity_commitment(request=request) - - -# [END bigqueryreservation_v1_generated_ReservationService_DeleteCapacityCommitment_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_capacity_commitment_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_capacity_commitment_sync.py deleted file mode 100644 index 38175299d1c2..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_capacity_commitment_sync.py +++ /dev/null @@ -1,50 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 DeleteCapacityCommitment -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_DeleteCapacityCommitment_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 bigquery_reservation_v1 - - -def sample_delete_capacity_commitment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.DeleteCapacityCommitmentRequest( - name="name_value", - ) - - # Make the request - client.delete_capacity_commitment(request=request) - - -# [END bigqueryreservation_v1_generated_ReservationService_DeleteCapacityCommitment_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_reservation_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_reservation_async.py deleted file mode 100644 index bea1b30ac9bc..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_reservation_async.py +++ /dev/null @@ -1,50 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 DeleteReservation -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_DeleteReservation_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 bigquery_reservation_v1 - - -async def sample_delete_reservation(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.DeleteReservationRequest( - name="name_value", - ) - - # Make the request - await client.delete_reservation(request=request) - - -# [END bigqueryreservation_v1_generated_ReservationService_DeleteReservation_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_reservation_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_reservation_sync.py deleted file mode 100644 index 05ce54e29176..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_reservation_sync.py +++ /dev/null @@ -1,50 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 DeleteReservation -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_DeleteReservation_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 bigquery_reservation_v1 - - -def sample_delete_reservation(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.DeleteReservationRequest( - name="name_value", - ) - - # Make the request - client.delete_reservation(request=request) - - -# [END bigqueryreservation_v1_generated_ReservationService_DeleteReservation_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_failover_reservation_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_failover_reservation_async.py deleted file mode 100644 index 065aee655552..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_failover_reservation_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 FailoverReservation -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_FailoverReservation_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 bigquery_reservation_v1 - - -async def sample_failover_reservation(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.FailoverReservationRequest( - name="name_value", - ) - - # Make the request - response = await client.failover_reservation(request=request) - - # Handle the response - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_FailoverReservation_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_failover_reservation_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_failover_reservation_sync.py deleted file mode 100644 index 757ecd889fd4..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_failover_reservation_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 FailoverReservation -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_FailoverReservation_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 bigquery_reservation_v1 - - -def sample_failover_reservation(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.FailoverReservationRequest( - name="name_value", - ) - - # Make the request - response = client.failover_reservation(request=request) - - # Handle the response - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_FailoverReservation_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_bi_reservation_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_bi_reservation_async.py deleted file mode 100644 index 9cd913867abe..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_bi_reservation_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 GetBiReservation -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_GetBiReservation_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 bigquery_reservation_v1 - - -async def sample_get_bi_reservation(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.GetBiReservationRequest( - name="name_value", - ) - - # Make the request - response = await client.get_bi_reservation(request=request) - - # Handle the response - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_GetBiReservation_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_bi_reservation_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_bi_reservation_sync.py deleted file mode 100644 index 55ce9a47dea1..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_bi_reservation_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 GetBiReservation -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_GetBiReservation_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 bigquery_reservation_v1 - - -def sample_get_bi_reservation(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.GetBiReservationRequest( - name="name_value", - ) - - # Make the request - response = client.get_bi_reservation(request=request) - - # Handle the response - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_GetBiReservation_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_capacity_commitment_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_capacity_commitment_async.py deleted file mode 100644 index 1ad990bd52a9..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_capacity_commitment_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 GetCapacityCommitment -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_GetCapacityCommitment_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 bigquery_reservation_v1 - - -async def sample_get_capacity_commitment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.GetCapacityCommitmentRequest( - name="name_value", - ) - - # Make the request - response = await client.get_capacity_commitment(request=request) - - # Handle the response - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_GetCapacityCommitment_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_capacity_commitment_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_capacity_commitment_sync.py deleted file mode 100644 index ef0b5579c266..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_capacity_commitment_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 GetCapacityCommitment -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_GetCapacityCommitment_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 bigquery_reservation_v1 - - -def sample_get_capacity_commitment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.GetCapacityCommitmentRequest( - name="name_value", - ) - - # Make the request - response = client.get_capacity_commitment(request=request) - - # Handle the response - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_GetCapacityCommitment_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_reservation_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_reservation_async.py deleted file mode 100644 index c758ac5b4b7a..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_reservation_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 GetReservation -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_GetReservation_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 bigquery_reservation_v1 - - -async def sample_get_reservation(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.GetReservationRequest( - name="name_value", - ) - - # Make the request - response = await client.get_reservation(request=request) - - # Handle the response - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_GetReservation_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_reservation_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_reservation_sync.py deleted file mode 100644 index 3a49c1b5bd17..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_reservation_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 GetReservation -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_GetReservation_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 bigquery_reservation_v1 - - -def sample_get_reservation(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.GetReservationRequest( - name="name_value", - ) - - # Make the request - response = client.get_reservation(request=request) - - # Handle the response - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_GetReservation_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_assignments_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_assignments_async.py deleted file mode 100644 index f5302c655e91..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_assignments_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 ListAssignments -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_ListAssignments_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 bigquery_reservation_v1 - - -async def sample_list_assignments(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.ListAssignmentsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_assignments(request=request) - - # Handle the response - async for response in page_result: - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_ListAssignments_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_assignments_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_assignments_sync.py deleted file mode 100644 index 2a86f61680cd..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_assignments_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 ListAssignments -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_ListAssignments_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 bigquery_reservation_v1 - - -def sample_list_assignments(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.ListAssignmentsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_assignments(request=request) - - # Handle the response - for response in page_result: - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_ListAssignments_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_capacity_commitments_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_capacity_commitments_async.py deleted file mode 100644 index cc98d875e5c4..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_capacity_commitments_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 ListCapacityCommitments -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_ListCapacityCommitments_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 bigquery_reservation_v1 - - -async def sample_list_capacity_commitments(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.ListCapacityCommitmentsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_capacity_commitments(request=request) - - # Handle the response - async for response in page_result: - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_ListCapacityCommitments_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_capacity_commitments_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_capacity_commitments_sync.py deleted file mode 100644 index 8ead72c8369b..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_capacity_commitments_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 ListCapacityCommitments -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_ListCapacityCommitments_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 bigquery_reservation_v1 - - -def sample_list_capacity_commitments(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.ListCapacityCommitmentsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_capacity_commitments(request=request) - - # Handle the response - for response in page_result: - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_ListCapacityCommitments_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_reservations_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_reservations_async.py deleted file mode 100644 index edae6d23dbc2..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_reservations_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 ListReservations -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_ListReservations_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 bigquery_reservation_v1 - - -async def sample_list_reservations(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.ListReservationsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_reservations(request=request) - - # Handle the response - async for response in page_result: - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_ListReservations_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_reservations_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_reservations_sync.py deleted file mode 100644 index 8b2c9835e653..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_reservations_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 ListReservations -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_ListReservations_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 bigquery_reservation_v1 - - -def sample_list_reservations(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.ListReservationsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_reservations(request=request) - - # Handle the response - for response in page_result: - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_ListReservations_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_merge_capacity_commitments_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_merge_capacity_commitments_async.py deleted file mode 100644 index 186e97f665f7..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_merge_capacity_commitments_async.py +++ /dev/null @@ -1,51 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 MergeCapacityCommitments -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_MergeCapacityCommitments_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 bigquery_reservation_v1 - - -async def sample_merge_capacity_commitments(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.MergeCapacityCommitmentsRequest( - ) - - # Make the request - response = await client.merge_capacity_commitments(request=request) - - # Handle the response - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_MergeCapacityCommitments_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_merge_capacity_commitments_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_merge_capacity_commitments_sync.py deleted file mode 100644 index f2cfd806e8ec..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_merge_capacity_commitments_sync.py +++ /dev/null @@ -1,51 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 MergeCapacityCommitments -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_MergeCapacityCommitments_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 bigquery_reservation_v1 - - -def sample_merge_capacity_commitments(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.MergeCapacityCommitmentsRequest( - ) - - # Make the request - response = client.merge_capacity_commitments(request=request) - - # Handle the response - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_MergeCapacityCommitments_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_move_assignment_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_move_assignment_async.py deleted file mode 100644 index 7d4930740c04..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_move_assignment_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 MoveAssignment -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_MoveAssignment_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 bigquery_reservation_v1 - - -async def sample_move_assignment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.MoveAssignmentRequest( - name="name_value", - ) - - # Make the request - response = await client.move_assignment(request=request) - - # Handle the response - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_MoveAssignment_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_move_assignment_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_move_assignment_sync.py deleted file mode 100644 index 2ad8b39c7719..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_move_assignment_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 MoveAssignment -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_MoveAssignment_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 bigquery_reservation_v1 - - -def sample_move_assignment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.MoveAssignmentRequest( - name="name_value", - ) - - # Make the request - response = client.move_assignment(request=request) - - # Handle the response - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_MoveAssignment_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_search_all_assignments_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_search_all_assignments_async.py deleted file mode 100644 index 1babd13e1c03..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_search_all_assignments_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 SearchAllAssignments -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_SearchAllAssignments_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 bigquery_reservation_v1 - - -async def sample_search_all_assignments(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.SearchAllAssignmentsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.search_all_assignments(request=request) - - # Handle the response - async for response in page_result: - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_SearchAllAssignments_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_search_all_assignments_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_search_all_assignments_sync.py deleted file mode 100644 index 2fe743d7f68c..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_search_all_assignments_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 SearchAllAssignments -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_SearchAllAssignments_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 bigquery_reservation_v1 - - -def sample_search_all_assignments(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.SearchAllAssignmentsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.search_all_assignments(request=request) - - # Handle the response - for response in page_result: - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_SearchAllAssignments_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_search_assignments_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_search_assignments_async.py deleted file mode 100644 index 231a89f89c85..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_search_assignments_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 SearchAssignments -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_SearchAssignments_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 bigquery_reservation_v1 - - -async def sample_search_assignments(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.SearchAssignmentsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.search_assignments(request=request) - - # Handle the response - async for response in page_result: - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_SearchAssignments_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_search_assignments_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_search_assignments_sync.py deleted file mode 100644 index 19b460ad8e2d..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_search_assignments_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 SearchAssignments -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_SearchAssignments_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 bigquery_reservation_v1 - - -def sample_search_assignments(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.SearchAssignmentsRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.search_assignments(request=request) - - # Handle the response - for response in page_result: - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_SearchAssignments_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_split_capacity_commitment_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_split_capacity_commitment_async.py deleted file mode 100644 index c85da2e44809..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_split_capacity_commitment_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 SplitCapacityCommitment -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_SplitCapacityCommitment_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 bigquery_reservation_v1 - - -async def sample_split_capacity_commitment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.SplitCapacityCommitmentRequest( - name="name_value", - ) - - # Make the request - response = await client.split_capacity_commitment(request=request) - - # Handle the response - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_SplitCapacityCommitment_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_split_capacity_commitment_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_split_capacity_commitment_sync.py deleted file mode 100644 index 8495cfdb1afa..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_split_capacity_commitment_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 SplitCapacityCommitment -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_SplitCapacityCommitment_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 bigquery_reservation_v1 - - -def sample_split_capacity_commitment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.SplitCapacityCommitmentRequest( - name="name_value", - ) - - # Make the request - response = client.split_capacity_commitment(request=request) - - # Handle the response - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_SplitCapacityCommitment_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_assignment_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_assignment_async.py deleted file mode 100644 index 494e36bbe9fb..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_assignment_async.py +++ /dev/null @@ -1,51 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 UpdateAssignment -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_UpdateAssignment_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 bigquery_reservation_v1 - - -async def sample_update_assignment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.UpdateAssignmentRequest( - ) - - # Make the request - response = await client.update_assignment(request=request) - - # Handle the response - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_UpdateAssignment_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_assignment_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_assignment_sync.py deleted file mode 100644 index 108f22c71655..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_assignment_sync.py +++ /dev/null @@ -1,51 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 UpdateAssignment -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_UpdateAssignment_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 bigquery_reservation_v1 - - -def sample_update_assignment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.UpdateAssignmentRequest( - ) - - # Make the request - response = client.update_assignment(request=request) - - # Handle the response - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_UpdateAssignment_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_bi_reservation_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_bi_reservation_async.py deleted file mode 100644 index 15f16aaa91f1..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_bi_reservation_async.py +++ /dev/null @@ -1,51 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 UpdateBiReservation -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_UpdateBiReservation_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 bigquery_reservation_v1 - - -async def sample_update_bi_reservation(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.UpdateBiReservationRequest( - ) - - # Make the request - response = await client.update_bi_reservation(request=request) - - # Handle the response - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_UpdateBiReservation_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_bi_reservation_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_bi_reservation_sync.py deleted file mode 100644 index b0c93e53e11c..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_bi_reservation_sync.py +++ /dev/null @@ -1,51 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 UpdateBiReservation -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_UpdateBiReservation_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 bigquery_reservation_v1 - - -def sample_update_bi_reservation(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.UpdateBiReservationRequest( - ) - - # Make the request - response = client.update_bi_reservation(request=request) - - # Handle the response - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_UpdateBiReservation_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_capacity_commitment_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_capacity_commitment_async.py deleted file mode 100644 index 6a0732562557..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_capacity_commitment_async.py +++ /dev/null @@ -1,51 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 UpdateCapacityCommitment -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_UpdateCapacityCommitment_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 bigquery_reservation_v1 - - -async def sample_update_capacity_commitment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.UpdateCapacityCommitmentRequest( - ) - - # Make the request - response = await client.update_capacity_commitment(request=request) - - # Handle the response - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_UpdateCapacityCommitment_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_capacity_commitment_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_capacity_commitment_sync.py deleted file mode 100644 index 0c11eb103d6e..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_capacity_commitment_sync.py +++ /dev/null @@ -1,51 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 UpdateCapacityCommitment -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_UpdateCapacityCommitment_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 bigquery_reservation_v1 - - -def sample_update_capacity_commitment(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.UpdateCapacityCommitmentRequest( - ) - - # Make the request - response = client.update_capacity_commitment(request=request) - - # Handle the response - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_UpdateCapacityCommitment_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_reservation_async.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_reservation_async.py deleted file mode 100644 index 2b3802e480bf..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_reservation_async.py +++ /dev/null @@ -1,51 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 UpdateReservation -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_UpdateReservation_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 bigquery_reservation_v1 - - -async def sample_update_reservation(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceAsyncClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.UpdateReservationRequest( - ) - - # Make the request - response = await client.update_reservation(request=request) - - # Handle the response - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_UpdateReservation_async] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_reservation_sync.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_reservation_sync.py deleted file mode 100644 index 1afe72c1ca94..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_update_reservation_sync.py +++ /dev/null @@ -1,51 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 UpdateReservation -# 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-bigquery-reservation - - -# [START bigqueryreservation_v1_generated_ReservationService_UpdateReservation_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 bigquery_reservation_v1 - - -def sample_update_reservation(): - # Create a client - client = bigquery_reservation_v1.ReservationServiceClient() - - # Initialize request argument(s) - request = bigquery_reservation_v1.UpdateReservationRequest( - ) - - # Make the request - response = client.update_reservation(request=request) - - # Handle the response - print(response) - -# [END bigqueryreservation_v1_generated_ReservationService_UpdateReservation_sync] diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/snippet_metadata_google.cloud.bigquery.reservation.v1.json b/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/snippet_metadata_google.cloud.bigquery.reservation.v1.json deleted file mode 100644 index 6c2537553261..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/snippet_metadata_google.cloud.bigquery.reservation.v1.json +++ /dev/null @@ -1,4740 +0,0 @@ -{ - "clientLibrary": { - "apis": [ - { - "id": "google.cloud.bigquery.reservation.v1", - "version": "v1" - } - ], - "language": "PYTHON", - "name": "google-cloud-bigquery-reservation", - "version": "0.1.0" - }, - "snippets": [ - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", - "shortName": "ReservationServiceAsyncClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.create_assignment", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.CreateAssignment", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "CreateAssignment" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.CreateAssignmentRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "assignment", - "type": "google.cloud.bigquery_reservation_v1.types.Assignment" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.types.Assignment", - "shortName": "create_assignment" - }, - "description": "Sample for CreateAssignment", - "file": "bigqueryreservation_v1_generated_reservation_service_create_assignment_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_CreateAssignment_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": "bigqueryreservation_v1_generated_reservation_service_create_assignment_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", - "shortName": "ReservationServiceClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.create_assignment", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.CreateAssignment", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "CreateAssignment" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.CreateAssignmentRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "assignment", - "type": "google.cloud.bigquery_reservation_v1.types.Assignment" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.types.Assignment", - "shortName": "create_assignment" - }, - "description": "Sample for CreateAssignment", - "file": "bigqueryreservation_v1_generated_reservation_service_create_assignment_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_CreateAssignment_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": "bigqueryreservation_v1_generated_reservation_service_create_assignment_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", - "shortName": "ReservationServiceAsyncClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.create_capacity_commitment", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.CreateCapacityCommitment", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "CreateCapacityCommitment" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.CreateCapacityCommitmentRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "capacity_commitment", - "type": "google.cloud.bigquery_reservation_v1.types.CapacityCommitment" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.types.CapacityCommitment", - "shortName": "create_capacity_commitment" - }, - "description": "Sample for CreateCapacityCommitment", - "file": "bigqueryreservation_v1_generated_reservation_service_create_capacity_commitment_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_CreateCapacityCommitment_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": "bigqueryreservation_v1_generated_reservation_service_create_capacity_commitment_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", - "shortName": "ReservationServiceClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.create_capacity_commitment", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.CreateCapacityCommitment", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "CreateCapacityCommitment" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.CreateCapacityCommitmentRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "capacity_commitment", - "type": "google.cloud.bigquery_reservation_v1.types.CapacityCommitment" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.types.CapacityCommitment", - "shortName": "create_capacity_commitment" - }, - "description": "Sample for CreateCapacityCommitment", - "file": "bigqueryreservation_v1_generated_reservation_service_create_capacity_commitment_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_CreateCapacityCommitment_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": "bigqueryreservation_v1_generated_reservation_service_create_capacity_commitment_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", - "shortName": "ReservationServiceAsyncClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.create_reservation_group", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.CreateReservationGroup", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "CreateReservationGroup" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.CreateReservationGroupRequest" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.types.ReservationGroup", - "shortName": "create_reservation_group" - }, - "description": "Sample for CreateReservationGroup", - "file": "bigqueryreservation_v1_generated_reservation_service_create_reservation_group_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_CreateReservationGroup_async", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "bigqueryreservation_v1_generated_reservation_service_create_reservation_group_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", - "shortName": "ReservationServiceClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.create_reservation_group", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.CreateReservationGroup", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "CreateReservationGroup" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.CreateReservationGroupRequest" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.types.ReservationGroup", - "shortName": "create_reservation_group" - }, - "description": "Sample for CreateReservationGroup", - "file": "bigqueryreservation_v1_generated_reservation_service_create_reservation_group_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_CreateReservationGroup_sync", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "bigqueryreservation_v1_generated_reservation_service_create_reservation_group_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", - "shortName": "ReservationServiceAsyncClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.create_reservation", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.CreateReservation", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "CreateReservation" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.CreateReservationRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "reservation", - "type": "google.cloud.bigquery_reservation_v1.types.Reservation" - }, - { - "name": "reservation_id", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.types.Reservation", - "shortName": "create_reservation" - }, - "description": "Sample for CreateReservation", - "file": "bigqueryreservation_v1_generated_reservation_service_create_reservation_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_CreateReservation_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": "bigqueryreservation_v1_generated_reservation_service_create_reservation_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", - "shortName": "ReservationServiceClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.create_reservation", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.CreateReservation", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "CreateReservation" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.CreateReservationRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "reservation", - "type": "google.cloud.bigquery_reservation_v1.types.Reservation" - }, - { - "name": "reservation_id", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.types.Reservation", - "shortName": "create_reservation" - }, - "description": "Sample for CreateReservation", - "file": "bigqueryreservation_v1_generated_reservation_service_create_reservation_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_CreateReservation_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": "bigqueryreservation_v1_generated_reservation_service_create_reservation_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", - "shortName": "ReservationServiceAsyncClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.delete_assignment", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.DeleteAssignment", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "DeleteAssignment" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.DeleteAssignmentRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "shortName": "delete_assignment" - }, - "description": "Sample for DeleteAssignment", - "file": "bigqueryreservation_v1_generated_reservation_service_delete_assignment_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_DeleteAssignment_async", - "segments": [ - { - "end": 49, - "start": 27, - "type": "FULL" - }, - { - "end": 49, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "bigqueryreservation_v1_generated_reservation_service_delete_assignment_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", - "shortName": "ReservationServiceClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.delete_assignment", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.DeleteAssignment", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "DeleteAssignment" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.DeleteAssignmentRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "shortName": "delete_assignment" - }, - "description": "Sample for DeleteAssignment", - "file": "bigqueryreservation_v1_generated_reservation_service_delete_assignment_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_DeleteAssignment_sync", - "segments": [ - { - "end": 49, - "start": 27, - "type": "FULL" - }, - { - "end": 49, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "bigqueryreservation_v1_generated_reservation_service_delete_assignment_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", - "shortName": "ReservationServiceAsyncClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.delete_capacity_commitment", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.DeleteCapacityCommitment", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "DeleteCapacityCommitment" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.DeleteCapacityCommitmentRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "shortName": "delete_capacity_commitment" - }, - "description": "Sample for DeleteCapacityCommitment", - "file": "bigqueryreservation_v1_generated_reservation_service_delete_capacity_commitment_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_DeleteCapacityCommitment_async", - "segments": [ - { - "end": 49, - "start": 27, - "type": "FULL" - }, - { - "end": 49, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "bigqueryreservation_v1_generated_reservation_service_delete_capacity_commitment_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", - "shortName": "ReservationServiceClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.delete_capacity_commitment", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.DeleteCapacityCommitment", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "DeleteCapacityCommitment" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.DeleteCapacityCommitmentRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "shortName": "delete_capacity_commitment" - }, - "description": "Sample for DeleteCapacityCommitment", - "file": "bigqueryreservation_v1_generated_reservation_service_delete_capacity_commitment_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_DeleteCapacityCommitment_sync", - "segments": [ - { - "end": 49, - "start": 27, - "type": "FULL" - }, - { - "end": 49, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "bigqueryreservation_v1_generated_reservation_service_delete_capacity_commitment_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", - "shortName": "ReservationServiceAsyncClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.delete_reservation_group", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservationGroup", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "DeleteReservationGroup" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.DeleteReservationGroupRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "shortName": "delete_reservation_group" - }, - "description": "Sample for DeleteReservationGroup", - "file": "bigqueryreservation_v1_generated_reservation_service_delete_reservation_group_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_DeleteReservationGroup_async", - "segments": [ - { - "end": 49, - "start": 27, - "type": "FULL" - }, - { - "end": 49, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "bigqueryreservation_v1_generated_reservation_service_delete_reservation_group_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", - "shortName": "ReservationServiceClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.delete_reservation_group", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservationGroup", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "DeleteReservationGroup" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.DeleteReservationGroupRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "shortName": "delete_reservation_group" - }, - "description": "Sample for DeleteReservationGroup", - "file": "bigqueryreservation_v1_generated_reservation_service_delete_reservation_group_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_DeleteReservationGroup_sync", - "segments": [ - { - "end": 49, - "start": 27, - "type": "FULL" - }, - { - "end": 49, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "bigqueryreservation_v1_generated_reservation_service_delete_reservation_group_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", - "shortName": "ReservationServiceAsyncClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.delete_reservation", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservation", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "DeleteReservation" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.DeleteReservationRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "shortName": "delete_reservation" - }, - "description": "Sample for DeleteReservation", - "file": "bigqueryreservation_v1_generated_reservation_service_delete_reservation_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_DeleteReservation_async", - "segments": [ - { - "end": 49, - "start": 27, - "type": "FULL" - }, - { - "end": 49, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "bigqueryreservation_v1_generated_reservation_service_delete_reservation_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", - "shortName": "ReservationServiceClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.delete_reservation", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservation", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "DeleteReservation" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.DeleteReservationRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "shortName": "delete_reservation" - }, - "description": "Sample for DeleteReservation", - "file": "bigqueryreservation_v1_generated_reservation_service_delete_reservation_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_DeleteReservation_sync", - "segments": [ - { - "end": 49, - "start": 27, - "type": "FULL" - }, - { - "end": 49, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "bigqueryreservation_v1_generated_reservation_service_delete_reservation_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", - "shortName": "ReservationServiceAsyncClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.failover_reservation", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.FailoverReservation", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "FailoverReservation" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.FailoverReservationRequest" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.types.Reservation", - "shortName": "failover_reservation" - }, - "description": "Sample for FailoverReservation", - "file": "bigqueryreservation_v1_generated_reservation_service_failover_reservation_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_FailoverReservation_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": "bigqueryreservation_v1_generated_reservation_service_failover_reservation_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", - "shortName": "ReservationServiceClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.failover_reservation", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.FailoverReservation", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "FailoverReservation" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.FailoverReservationRequest" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.types.Reservation", - "shortName": "failover_reservation" - }, - "description": "Sample for FailoverReservation", - "file": "bigqueryreservation_v1_generated_reservation_service_failover_reservation_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_FailoverReservation_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": "bigqueryreservation_v1_generated_reservation_service_failover_reservation_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", - "shortName": "ReservationServiceAsyncClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.get_bi_reservation", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetBiReservation", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "GetBiReservation" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.GetBiReservationRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.types.BiReservation", - "shortName": "get_bi_reservation" - }, - "description": "Sample for GetBiReservation", - "file": "bigqueryreservation_v1_generated_reservation_service_get_bi_reservation_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetBiReservation_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": "bigqueryreservation_v1_generated_reservation_service_get_bi_reservation_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", - "shortName": "ReservationServiceClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.get_bi_reservation", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetBiReservation", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "GetBiReservation" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.GetBiReservationRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.types.BiReservation", - "shortName": "get_bi_reservation" - }, - "description": "Sample for GetBiReservation", - "file": "bigqueryreservation_v1_generated_reservation_service_get_bi_reservation_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetBiReservation_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": "bigqueryreservation_v1_generated_reservation_service_get_bi_reservation_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", - "shortName": "ReservationServiceAsyncClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.get_capacity_commitment", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitment", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "GetCapacityCommitment" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.GetCapacityCommitmentRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.types.CapacityCommitment", - "shortName": "get_capacity_commitment" - }, - "description": "Sample for GetCapacityCommitment", - "file": "bigqueryreservation_v1_generated_reservation_service_get_capacity_commitment_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetCapacityCommitment_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": "bigqueryreservation_v1_generated_reservation_service_get_capacity_commitment_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", - "shortName": "ReservationServiceClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.get_capacity_commitment", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitment", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "GetCapacityCommitment" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.GetCapacityCommitmentRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.types.CapacityCommitment", - "shortName": "get_capacity_commitment" - }, - "description": "Sample for GetCapacityCommitment", - "file": "bigqueryreservation_v1_generated_reservation_service_get_capacity_commitment_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetCapacityCommitment_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": "bigqueryreservation_v1_generated_reservation_service_get_capacity_commitment_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", - "shortName": "ReservationServiceAsyncClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.get_iam_policy", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetIamPolicy", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "GetIamPolicy" - }, - "parameters": [ - { - "name": "request", - "type": "google.iam.v1.iam_policy_pb2.GetIamPolicyRequest" - }, - { - "name": "resource", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.iam.v1.policy_pb2.Policy", - "shortName": "get_iam_policy" - }, - "description": "Sample for GetIamPolicy", - "file": "bigqueryreservation_v1_generated_reservation_service_get_iam_policy_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetIamPolicy_async", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 41, - "start": 39, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 42, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "bigqueryreservation_v1_generated_reservation_service_get_iam_policy_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", - "shortName": "ReservationServiceClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.get_iam_policy", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetIamPolicy", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "GetIamPolicy" - }, - "parameters": [ - { - "name": "request", - "type": "google.iam.v1.iam_policy_pb2.GetIamPolicyRequest" - }, - { - "name": "resource", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.iam.v1.policy_pb2.Policy", - "shortName": "get_iam_policy" - }, - "description": "Sample for GetIamPolicy", - "file": "bigqueryreservation_v1_generated_reservation_service_get_iam_policy_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetIamPolicy_sync", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 41, - "start": 39, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 42, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "bigqueryreservation_v1_generated_reservation_service_get_iam_policy_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", - "shortName": "ReservationServiceAsyncClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.get_reservation_group", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetReservationGroup", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "GetReservationGroup" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.GetReservationGroupRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.types.ReservationGroup", - "shortName": "get_reservation_group" - }, - "description": "Sample for GetReservationGroup", - "file": "bigqueryreservation_v1_generated_reservation_service_get_reservation_group_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetReservationGroup_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": "bigqueryreservation_v1_generated_reservation_service_get_reservation_group_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", - "shortName": "ReservationServiceClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.get_reservation_group", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetReservationGroup", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "GetReservationGroup" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.GetReservationGroupRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.types.ReservationGroup", - "shortName": "get_reservation_group" - }, - "description": "Sample for GetReservationGroup", - "file": "bigqueryreservation_v1_generated_reservation_service_get_reservation_group_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetReservationGroup_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": "bigqueryreservation_v1_generated_reservation_service_get_reservation_group_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", - "shortName": "ReservationServiceAsyncClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.get_reservation", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetReservation", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "GetReservation" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.GetReservationRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.types.Reservation", - "shortName": "get_reservation" - }, - "description": "Sample for GetReservation", - "file": "bigqueryreservation_v1_generated_reservation_service_get_reservation_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetReservation_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": "bigqueryreservation_v1_generated_reservation_service_get_reservation_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", - "shortName": "ReservationServiceClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.get_reservation", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetReservation", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "GetReservation" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.GetReservationRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.types.Reservation", - "shortName": "get_reservation" - }, - "description": "Sample for GetReservation", - "file": "bigqueryreservation_v1_generated_reservation_service_get_reservation_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetReservation_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": "bigqueryreservation_v1_generated_reservation_service_get_reservation_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", - "shortName": "ReservationServiceAsyncClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.list_assignments", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "ListAssignments" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.ListAssignmentsRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListAssignmentsAsyncPager", - "shortName": "list_assignments" - }, - "description": "Sample for ListAssignments", - "file": "bigqueryreservation_v1_generated_reservation_service_list_assignments_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_ListAssignments_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": "bigqueryreservation_v1_generated_reservation_service_list_assignments_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", - "shortName": "ReservationServiceClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.list_assignments", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "ListAssignments" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.ListAssignmentsRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListAssignmentsPager", - "shortName": "list_assignments" - }, - "description": "Sample for ListAssignments", - "file": "bigqueryreservation_v1_generated_reservation_service_list_assignments_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_ListAssignments_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": "bigqueryreservation_v1_generated_reservation_service_list_assignments_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", - "shortName": "ReservationServiceAsyncClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.list_capacity_commitments", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "ListCapacityCommitments" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListCapacityCommitmentsAsyncPager", - "shortName": "list_capacity_commitments" - }, - "description": "Sample for ListCapacityCommitments", - "file": "bigqueryreservation_v1_generated_reservation_service_list_capacity_commitments_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_ListCapacityCommitments_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": "bigqueryreservation_v1_generated_reservation_service_list_capacity_commitments_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", - "shortName": "ReservationServiceClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.list_capacity_commitments", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "ListCapacityCommitments" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListCapacityCommitmentsPager", - "shortName": "list_capacity_commitments" - }, - "description": "Sample for ListCapacityCommitments", - "file": "bigqueryreservation_v1_generated_reservation_service_list_capacity_commitments_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_ListCapacityCommitments_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": "bigqueryreservation_v1_generated_reservation_service_list_capacity_commitments_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", - "shortName": "ReservationServiceAsyncClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.list_reservation_groups", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.ListReservationGroups", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "ListReservationGroups" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.ListReservationGroupsRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListReservationGroupsAsyncPager", - "shortName": "list_reservation_groups" - }, - "description": "Sample for ListReservationGroups", - "file": "bigqueryreservation_v1_generated_reservation_service_list_reservation_groups_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_ListReservationGroups_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": "bigqueryreservation_v1_generated_reservation_service_list_reservation_groups_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", - "shortName": "ReservationServiceClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.list_reservation_groups", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.ListReservationGroups", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "ListReservationGroups" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.ListReservationGroupsRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListReservationGroupsPager", - "shortName": "list_reservation_groups" - }, - "description": "Sample for ListReservationGroups", - "file": "bigqueryreservation_v1_generated_reservation_service_list_reservation_groups_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_ListReservationGroups_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": "bigqueryreservation_v1_generated_reservation_service_list_reservation_groups_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", - "shortName": "ReservationServiceAsyncClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.list_reservations", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.ListReservations", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "ListReservations" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.ListReservationsRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListReservationsAsyncPager", - "shortName": "list_reservations" - }, - "description": "Sample for ListReservations", - "file": "bigqueryreservation_v1_generated_reservation_service_list_reservations_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_ListReservations_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": "bigqueryreservation_v1_generated_reservation_service_list_reservations_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", - "shortName": "ReservationServiceClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.list_reservations", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.ListReservations", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "ListReservations" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.ListReservationsRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListReservationsPager", - "shortName": "list_reservations" - }, - "description": "Sample for ListReservations", - "file": "bigqueryreservation_v1_generated_reservation_service_list_reservations_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_ListReservations_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": "bigqueryreservation_v1_generated_reservation_service_list_reservations_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", - "shortName": "ReservationServiceAsyncClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.merge_capacity_commitments", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.MergeCapacityCommitments", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "MergeCapacityCommitments" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.MergeCapacityCommitmentsRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "capacity_commitment_ids", - "type": "MutableSequence[str]" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.types.CapacityCommitment", - "shortName": "merge_capacity_commitments" - }, - "description": "Sample for MergeCapacityCommitments", - "file": "bigqueryreservation_v1_generated_reservation_service_merge_capacity_commitments_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_MergeCapacityCommitments_async", - "segments": [ - { - "end": 50, - "start": 27, - "type": "FULL" - }, - { - "end": 50, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 44, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 47, - "start": 45, - "type": "REQUEST_EXECUTION" - }, - { - "end": 51, - "start": 48, - "type": "RESPONSE_HANDLING" - } - ], - "title": "bigqueryreservation_v1_generated_reservation_service_merge_capacity_commitments_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", - "shortName": "ReservationServiceClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.merge_capacity_commitments", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.MergeCapacityCommitments", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "MergeCapacityCommitments" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.MergeCapacityCommitmentsRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "capacity_commitment_ids", - "type": "MutableSequence[str]" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.types.CapacityCommitment", - "shortName": "merge_capacity_commitments" - }, - "description": "Sample for MergeCapacityCommitments", - "file": "bigqueryreservation_v1_generated_reservation_service_merge_capacity_commitments_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_MergeCapacityCommitments_sync", - "segments": [ - { - "end": 50, - "start": 27, - "type": "FULL" - }, - { - "end": 50, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 44, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 47, - "start": 45, - "type": "REQUEST_EXECUTION" - }, - { - "end": 51, - "start": 48, - "type": "RESPONSE_HANDLING" - } - ], - "title": "bigqueryreservation_v1_generated_reservation_service_merge_capacity_commitments_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", - "shortName": "ReservationServiceAsyncClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.move_assignment", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.MoveAssignment", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "MoveAssignment" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.MoveAssignmentRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "destination_id", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.types.Assignment", - "shortName": "move_assignment" - }, - "description": "Sample for MoveAssignment", - "file": "bigqueryreservation_v1_generated_reservation_service_move_assignment_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_MoveAssignment_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": "bigqueryreservation_v1_generated_reservation_service_move_assignment_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", - "shortName": "ReservationServiceClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.move_assignment", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.MoveAssignment", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "MoveAssignment" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.MoveAssignmentRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "destination_id", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.types.Assignment", - "shortName": "move_assignment" - }, - "description": "Sample for MoveAssignment", - "file": "bigqueryreservation_v1_generated_reservation_service_move_assignment_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_MoveAssignment_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": "bigqueryreservation_v1_generated_reservation_service_move_assignment_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", - "shortName": "ReservationServiceAsyncClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.search_all_assignments", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "SearchAllAssignments" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "query", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.SearchAllAssignmentsAsyncPager", - "shortName": "search_all_assignments" - }, - "description": "Sample for SearchAllAssignments", - "file": "bigqueryreservation_v1_generated_reservation_service_search_all_assignments_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_SearchAllAssignments_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": "bigqueryreservation_v1_generated_reservation_service_search_all_assignments_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", - "shortName": "ReservationServiceClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.search_all_assignments", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "SearchAllAssignments" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "query", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.SearchAllAssignmentsPager", - "shortName": "search_all_assignments" - }, - "description": "Sample for SearchAllAssignments", - "file": "bigqueryreservation_v1_generated_reservation_service_search_all_assignments_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_SearchAllAssignments_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": "bigqueryreservation_v1_generated_reservation_service_search_all_assignments_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", - "shortName": "ReservationServiceAsyncClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.search_assignments", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "SearchAssignments" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.SearchAssignmentsRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "query", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.SearchAssignmentsAsyncPager", - "shortName": "search_assignments" - }, - "description": "Sample for SearchAssignments", - "file": "bigqueryreservation_v1_generated_reservation_service_search_assignments_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_SearchAssignments_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": "bigqueryreservation_v1_generated_reservation_service_search_assignments_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", - "shortName": "ReservationServiceClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.search_assignments", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "SearchAssignments" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.SearchAssignmentsRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "query", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.SearchAssignmentsPager", - "shortName": "search_assignments" - }, - "description": "Sample for SearchAssignments", - "file": "bigqueryreservation_v1_generated_reservation_service_search_assignments_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_SearchAssignments_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": "bigqueryreservation_v1_generated_reservation_service_search_assignments_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", - "shortName": "ReservationServiceAsyncClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.set_iam_policy", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.SetIamPolicy", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "SetIamPolicy" - }, - "parameters": [ - { - "name": "request", - "type": "google.iam.v1.iam_policy_pb2.SetIamPolicyRequest" - }, - { - "name": "resource", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.iam.v1.policy_pb2.Policy", - "shortName": "set_iam_policy" - }, - "description": "Sample for SetIamPolicy", - "file": "bigqueryreservation_v1_generated_reservation_service_set_iam_policy_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_SetIamPolicy_async", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 41, - "start": 39, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 42, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "bigqueryreservation_v1_generated_reservation_service_set_iam_policy_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", - "shortName": "ReservationServiceClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.set_iam_policy", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.SetIamPolicy", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "SetIamPolicy" - }, - "parameters": [ - { - "name": "request", - "type": "google.iam.v1.iam_policy_pb2.SetIamPolicyRequest" - }, - { - "name": "resource", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.iam.v1.policy_pb2.Policy", - "shortName": "set_iam_policy" - }, - "description": "Sample for SetIamPolicy", - "file": "bigqueryreservation_v1_generated_reservation_service_set_iam_policy_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_SetIamPolicy_sync", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 41, - "start": 39, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 42, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "bigqueryreservation_v1_generated_reservation_service_set_iam_policy_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", - "shortName": "ReservationServiceAsyncClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.split_capacity_commitment", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "SplitCapacityCommitment" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.SplitCapacityCommitmentRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "slot_count", - "type": "int" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.types.SplitCapacityCommitmentResponse", - "shortName": "split_capacity_commitment" - }, - "description": "Sample for SplitCapacityCommitment", - "file": "bigqueryreservation_v1_generated_reservation_service_split_capacity_commitment_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_SplitCapacityCommitment_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": "bigqueryreservation_v1_generated_reservation_service_split_capacity_commitment_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", - "shortName": "ReservationServiceClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.split_capacity_commitment", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "SplitCapacityCommitment" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.SplitCapacityCommitmentRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "slot_count", - "type": "int" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.types.SplitCapacityCommitmentResponse", - "shortName": "split_capacity_commitment" - }, - "description": "Sample for SplitCapacityCommitment", - "file": "bigqueryreservation_v1_generated_reservation_service_split_capacity_commitment_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_SplitCapacityCommitment_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": "bigqueryreservation_v1_generated_reservation_service_split_capacity_commitment_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", - "shortName": "ReservationServiceAsyncClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.test_iam_permissions", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.TestIamPermissions", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "TestIamPermissions" - }, - "parameters": [ - { - "name": "request", - "type": "google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse", - "shortName": "test_iam_permissions" - }, - "description": "Sample for TestIamPermissions", - "file": "bigqueryreservation_v1_generated_reservation_service_test_iam_permissions_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_TestIamPermissions_async", - "segments": [ - { - "end": 53, - "start": 27, - "type": "FULL" - }, - { - "end": 53, - "start": 27, - "type": "SHORT" - }, - { - "end": 41, - "start": 39, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 47, - "start": 42, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 50, - "start": 48, - "type": "REQUEST_EXECUTION" - }, - { - "end": 54, - "start": 51, - "type": "RESPONSE_HANDLING" - } - ], - "title": "bigqueryreservation_v1_generated_reservation_service_test_iam_permissions_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", - "shortName": "ReservationServiceClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.test_iam_permissions", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.TestIamPermissions", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "TestIamPermissions" - }, - "parameters": [ - { - "name": "request", - "type": "google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse", - "shortName": "test_iam_permissions" - }, - "description": "Sample for TestIamPermissions", - "file": "bigqueryreservation_v1_generated_reservation_service_test_iam_permissions_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_TestIamPermissions_sync", - "segments": [ - { - "end": 53, - "start": 27, - "type": "FULL" - }, - { - "end": 53, - "start": 27, - "type": "SHORT" - }, - { - "end": 41, - "start": 39, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 47, - "start": 42, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 50, - "start": 48, - "type": "REQUEST_EXECUTION" - }, - { - "end": 54, - "start": 51, - "type": "RESPONSE_HANDLING" - } - ], - "title": "bigqueryreservation_v1_generated_reservation_service_test_iam_permissions_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", - "shortName": "ReservationServiceAsyncClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.update_assignment", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.UpdateAssignment", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "UpdateAssignment" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.UpdateAssignmentRequest" - }, - { - "name": "assignment", - "type": "google.cloud.bigquery_reservation_v1.types.Assignment" - }, - { - "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, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.types.Assignment", - "shortName": "update_assignment" - }, - "description": "Sample for UpdateAssignment", - "file": "bigqueryreservation_v1_generated_reservation_service_update_assignment_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_UpdateAssignment_async", - "segments": [ - { - "end": 50, - "start": 27, - "type": "FULL" - }, - { - "end": 50, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 44, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 47, - "start": 45, - "type": "REQUEST_EXECUTION" - }, - { - "end": 51, - "start": 48, - "type": "RESPONSE_HANDLING" - } - ], - "title": "bigqueryreservation_v1_generated_reservation_service_update_assignment_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", - "shortName": "ReservationServiceClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.update_assignment", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.UpdateAssignment", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "UpdateAssignment" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.UpdateAssignmentRequest" - }, - { - "name": "assignment", - "type": "google.cloud.bigquery_reservation_v1.types.Assignment" - }, - { - "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, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.types.Assignment", - "shortName": "update_assignment" - }, - "description": "Sample for UpdateAssignment", - "file": "bigqueryreservation_v1_generated_reservation_service_update_assignment_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_UpdateAssignment_sync", - "segments": [ - { - "end": 50, - "start": 27, - "type": "FULL" - }, - { - "end": 50, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 44, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 47, - "start": 45, - "type": "REQUEST_EXECUTION" - }, - { - "end": 51, - "start": 48, - "type": "RESPONSE_HANDLING" - } - ], - "title": "bigqueryreservation_v1_generated_reservation_service_update_assignment_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", - "shortName": "ReservationServiceAsyncClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.update_bi_reservation", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.UpdateBiReservation", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "UpdateBiReservation" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.UpdateBiReservationRequest" - }, - { - "name": "bi_reservation", - "type": "google.cloud.bigquery_reservation_v1.types.BiReservation" - }, - { - "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, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.types.BiReservation", - "shortName": "update_bi_reservation" - }, - "description": "Sample for UpdateBiReservation", - "file": "bigqueryreservation_v1_generated_reservation_service_update_bi_reservation_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_UpdateBiReservation_async", - "segments": [ - { - "end": 50, - "start": 27, - "type": "FULL" - }, - { - "end": 50, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 44, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 47, - "start": 45, - "type": "REQUEST_EXECUTION" - }, - { - "end": 51, - "start": 48, - "type": "RESPONSE_HANDLING" - } - ], - "title": "bigqueryreservation_v1_generated_reservation_service_update_bi_reservation_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", - "shortName": "ReservationServiceClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.update_bi_reservation", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.UpdateBiReservation", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "UpdateBiReservation" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.UpdateBiReservationRequest" - }, - { - "name": "bi_reservation", - "type": "google.cloud.bigquery_reservation_v1.types.BiReservation" - }, - { - "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, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.types.BiReservation", - "shortName": "update_bi_reservation" - }, - "description": "Sample for UpdateBiReservation", - "file": "bigqueryreservation_v1_generated_reservation_service_update_bi_reservation_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_UpdateBiReservation_sync", - "segments": [ - { - "end": 50, - "start": 27, - "type": "FULL" - }, - { - "end": 50, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 44, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 47, - "start": 45, - "type": "REQUEST_EXECUTION" - }, - { - "end": 51, - "start": 48, - "type": "RESPONSE_HANDLING" - } - ], - "title": "bigqueryreservation_v1_generated_reservation_service_update_bi_reservation_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", - "shortName": "ReservationServiceAsyncClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.update_capacity_commitment", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.UpdateCapacityCommitment", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "UpdateCapacityCommitment" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.UpdateCapacityCommitmentRequest" - }, - { - "name": "capacity_commitment", - "type": "google.cloud.bigquery_reservation_v1.types.CapacityCommitment" - }, - { - "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, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.types.CapacityCommitment", - "shortName": "update_capacity_commitment" - }, - "description": "Sample for UpdateCapacityCommitment", - "file": "bigqueryreservation_v1_generated_reservation_service_update_capacity_commitment_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_UpdateCapacityCommitment_async", - "segments": [ - { - "end": 50, - "start": 27, - "type": "FULL" - }, - { - "end": 50, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 44, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 47, - "start": 45, - "type": "REQUEST_EXECUTION" - }, - { - "end": 51, - "start": 48, - "type": "RESPONSE_HANDLING" - } - ], - "title": "bigqueryreservation_v1_generated_reservation_service_update_capacity_commitment_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", - "shortName": "ReservationServiceClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.update_capacity_commitment", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.UpdateCapacityCommitment", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "UpdateCapacityCommitment" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.UpdateCapacityCommitmentRequest" - }, - { - "name": "capacity_commitment", - "type": "google.cloud.bigquery_reservation_v1.types.CapacityCommitment" - }, - { - "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, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.types.CapacityCommitment", - "shortName": "update_capacity_commitment" - }, - "description": "Sample for UpdateCapacityCommitment", - "file": "bigqueryreservation_v1_generated_reservation_service_update_capacity_commitment_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_UpdateCapacityCommitment_sync", - "segments": [ - { - "end": 50, - "start": 27, - "type": "FULL" - }, - { - "end": 50, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 44, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 47, - "start": 45, - "type": "REQUEST_EXECUTION" - }, - { - "end": 51, - "start": 48, - "type": "RESPONSE_HANDLING" - } - ], - "title": "bigqueryreservation_v1_generated_reservation_service_update_capacity_commitment_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", - "shortName": "ReservationServiceAsyncClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.update_reservation", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.UpdateReservation", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "UpdateReservation" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.UpdateReservationRequest" - }, - { - "name": "reservation", - "type": "google.cloud.bigquery_reservation_v1.types.Reservation" - }, - { - "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, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.types.Reservation", - "shortName": "update_reservation" - }, - "description": "Sample for UpdateReservation", - "file": "bigqueryreservation_v1_generated_reservation_service_update_reservation_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_UpdateReservation_async", - "segments": [ - { - "end": 50, - "start": 27, - "type": "FULL" - }, - { - "end": 50, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 44, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 47, - "start": 45, - "type": "REQUEST_EXECUTION" - }, - { - "end": 51, - "start": 48, - "type": "RESPONSE_HANDLING" - } - ], - "title": "bigqueryreservation_v1_generated_reservation_service_update_reservation_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", - "shortName": "ReservationServiceClient" - }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.update_reservation", - "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.UpdateReservation", - "service": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", - "shortName": "ReservationService" - }, - "shortName": "UpdateReservation" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.UpdateReservationRequest" - }, - { - "name": "reservation", - "type": "google.cloud.bigquery_reservation_v1.types.Reservation" - }, - { - "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, Union[str, bytes]]]" - } - ], - "resultType": "google.cloud.bigquery_reservation_v1.types.Reservation", - "shortName": "update_reservation" - }, - "description": "Sample for UpdateReservation", - "file": "bigqueryreservation_v1_generated_reservation_service_update_reservation_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_UpdateReservation_sync", - "segments": [ - { - "end": 50, - "start": 27, - "type": "FULL" - }, - { - "end": 50, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 44, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 47, - "start": 45, - "type": "REQUEST_EXECUTION" - }, - { - "end": 51, - "start": 48, - "type": "RESPONSE_HANDLING" - } - ], - "title": "bigqueryreservation_v1_generated_reservation_service_update_reservation_sync.py" - } - ] -} diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/scripts/fixup_bigquery_reservation_v1_keywords.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/scripts/fixup_bigquery_reservation_v1_keywords.py deleted file mode 100644 index 1bcaf6d5ab34..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/scripts/fixup_bigquery_reservation_v1_keywords.py +++ /dev/null @@ -1,204 +0,0 @@ -#! /usr/bin/env python3 -# -*- coding: utf-8 -*- -# Copyright 2025 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 bigquery_reservationCallTransformer(cst.CSTTransformer): - CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') - METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { - 'create_assignment': ('parent', 'assignment', 'assignment_id', ), - 'create_capacity_commitment': ('parent', 'capacity_commitment', 'enforce_single_admin_project_per_org', 'capacity_commitment_id', ), - 'create_reservation': ('parent', 'reservation_id', 'reservation', ), - 'create_reservation_group': ('parent', 'reservation_group_id', 'reservation_group', ), - 'delete_assignment': ('name', ), - 'delete_capacity_commitment': ('name', 'force', ), - 'delete_reservation': ('name', ), - 'delete_reservation_group': ('name', ), - 'failover_reservation': ('name', 'failover_mode', ), - 'get_bi_reservation': ('name', ), - 'get_capacity_commitment': ('name', ), - 'get_iam_policy': ('resource', 'options', ), - 'get_reservation': ('name', ), - 'get_reservation_group': ('name', ), - 'list_assignments': ('parent', 'page_size', 'page_token', ), - 'list_capacity_commitments': ('parent', 'page_size', 'page_token', ), - 'list_reservation_groups': ('parent', 'page_size', 'page_token', ), - 'list_reservations': ('parent', 'page_size', 'page_token', ), - 'merge_capacity_commitments': ('parent', 'capacity_commitment_ids', 'capacity_commitment_id', ), - 'move_assignment': ('name', 'destination_id', 'assignment_id', ), - 'search_all_assignments': ('parent', 'query', 'page_size', 'page_token', ), - 'search_assignments': ('parent', 'query', 'page_size', 'page_token', ), - 'set_iam_policy': ('resource', 'policy', 'update_mask', ), - 'split_capacity_commitment': ('name', 'slot_count', ), - 'test_iam_permissions': ('resource', 'permissions', ), - 'update_assignment': ('assignment', 'update_mask', ), - 'update_bi_reservation': ('bi_reservation', 'update_mask', ), - 'update_capacity_commitment': ('capacity_commitment', 'update_mask', ), - 'update_reservation': ('reservation', 'update_mask', ), - } - - 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=bigquery_reservationCallTransformer(), -): - """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 bigquery_reservation 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/google-cloud-bigquery-reservation/v1/setup.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/setup.py deleted file mode 100644 index 302001c7a5df..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/setup.py +++ /dev/null @@ -1,99 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 re - -import setuptools # type: ignore - -package_root = os.path.abspath(os.path.dirname(__file__)) - -name = 'google-cloud-bigquery-reservation' - - -description = "Google Cloud Bigquery Reservation API client library" - -version = None - -with open(os.path.join(package_root, 'google/cloud/bigquery_reservation/gapic_version.py')) as fp: - version_candidates = re.findall(r"(?<=\")\d+.\d+.\d+(?=\")", fp.read()) - assert (len(version_candidates) == 1) - version = version_candidates[0] - -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.1, <3.0.0,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*", - # Exclude incompatible versions of `google-auth` - # See https://github.com/googleapis/google-cloud-python/issues/12364 - "google-auth >= 2.14.1, <3.0.0,!=2.24.0,!=2.25.0", - "proto-plus >= 1.22.3, <2.0.0", - "proto-plus >= 1.25.0, <2.0.0; python_version >= '3.13'", - "protobuf>=3.20.2,<7.0.0,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", - "grpc-google-iam-v1 >= 0.14.0, <1.0.0", -] -extras = { -} -url = "https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-bigquery-reservation" - -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.find_namespace_packages() - if package.startswith("google") -] - -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", - "Programming Language :: Python :: 3.12", - "Programming Language :: Python :: 3.13", - "Operating System :: OS Independent", - "Topic :: Internet", - ], - platforms="Posix; MacOS X; Windows", - packages=packages, - python_requires=">=3.7", - install_requires=dependencies, - extras_require=extras, - include_package_data=True, - zip_safe=False, -) diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.10.txt b/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.10.txt deleted file mode 100644 index ad3f0fa58e2d..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.10.txt +++ /dev/null @@ -1,7 +0,0 @@ -# -*- 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 -grpc-google-iam-v1 diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.11.txt b/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.11.txt deleted file mode 100644 index ad3f0fa58e2d..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.11.txt +++ /dev/null @@ -1,7 +0,0 @@ -# -*- 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 -grpc-google-iam-v1 diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.12.txt b/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.12.txt deleted file mode 100644 index ad3f0fa58e2d..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.12.txt +++ /dev/null @@ -1,7 +0,0 @@ -# -*- 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 -grpc-google-iam-v1 diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.13.txt b/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.13.txt deleted file mode 100644 index 2010e549cceb..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.13.txt +++ /dev/null @@ -1,12 +0,0 @@ -# We use the constraints file for the latest Python version -# (currently this file) to check that the latest -# major versions of dependencies are supported in setup.py. -# List all library dependencies and extras in this file. -# Require the latest major version be installed for each dependency. -# e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0", -# Then this file should have google-cloud-foo>=1 -google-api-core>=2 -google-auth>=2 -proto-plus>=1 -protobuf>=6 -grpc-google-iam-v1>=0 diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.7.txt b/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.7.txt deleted file mode 100644 index 56affbd9bd75..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.7.txt +++ /dev/null @@ -1,11 +0,0 @@ -# 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.0", -# Then this file should have google-cloud-foo==1.14.0 -google-api-core==1.34.1 -google-auth==2.14.1 -proto-plus==1.22.3 -protobuf==3.20.2 -grpc-google-iam-v1==0.14.0 diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.8.txt b/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.8.txt deleted file mode 100644 index ad3f0fa58e2d..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.8.txt +++ /dev/null @@ -1,7 +0,0 @@ -# -*- 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 -grpc-google-iam-v1 diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.9.txt b/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.9.txt deleted file mode 100644 index ad3f0fa58e2d..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/testing/constraints-3.9.txt +++ /dev/null @@ -1,7 +0,0 @@ -# -*- 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 -grpc-google-iam-v1 diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/tests/__init__.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/tests/__init__.py deleted file mode 100644 index 191773d5572d..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/tests/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2025 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/google-cloud-bigquery-reservation/v1/tests/unit/__init__.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/tests/unit/__init__.py deleted file mode 100644 index 191773d5572d..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/tests/unit/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2025 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/google-cloud-bigquery-reservation/v1/tests/unit/gapic/__init__.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/tests/unit/gapic/__init__.py deleted file mode 100644 index 191773d5572d..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/tests/unit/gapic/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2025 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/google-cloud-bigquery-reservation/v1/tests/unit/gapic/bigquery_reservation_v1/__init__.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/tests/unit/gapic/bigquery_reservation_v1/__init__.py deleted file mode 100644 index 191773d5572d..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/tests/unit/gapic/bigquery_reservation_v1/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2025 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/google-cloud-bigquery-reservation/v1/tests/unit/gapic/bigquery_reservation_v1/test_reservation_service.py b/owl-bot-staging/google-cloud-bigquery-reservation/v1/tests/unit/gapic/bigquery_reservation_v1/test_reservation_service.py deleted file mode 100644 index f3cfa5f09eb3..000000000000 --- a/owl-bot-staging/google-cloud-bigquery-reservation/v1/tests/unit/gapic/bigquery_reservation_v1/test_reservation_service.py +++ /dev/null @@ -1,22667 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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, AsyncIterable -from google.protobuf import json_format -import json -import math -import pytest -from google.api_core import api_core_version -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 - -try: - from google.auth.aio import credentials as ga_credentials_async - HAS_GOOGLE_AUTH_AIO = True -except ImportError: # pragma: NO COVER - HAS_GOOGLE_AUTH_AIO = False - -from google.api_core import client_options -from google.api_core import exceptions as core_exceptions -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 path_template -from google.api_core import retry as retries -from google.auth import credentials as ga_credentials -from google.auth.exceptions import MutualTLSChannelError -from google.cloud.bigquery_reservation_v1.services.reservation_service import ReservationServiceAsyncClient -from google.cloud.bigquery_reservation_v1.services.reservation_service import ReservationServiceClient -from google.cloud.bigquery_reservation_v1.services.reservation_service import pagers -from google.cloud.bigquery_reservation_v1.services.reservation_service import transports -from google.cloud.bigquery_reservation_v1.types import reservation -from google.cloud.bigquery_reservation_v1.types import reservation as gcbr_reservation -from google.iam.v1 import iam_policy_pb2 # type: ignore -from google.iam.v1 import options_pb2 # type: ignore -from google.iam.v1 import policy_pb2 # type: ignore -from google.oauth2 import service_account -from google.protobuf import any_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 expr_pb2 # type: ignore -import google.auth - - - -CRED_INFO_JSON = { - "credential_source": "/path/to/file", - "credential_type": "service account credentials", - "principal": "service-account@example.com", -} -CRED_INFO_STRING = json.dumps(CRED_INFO_JSON) - - -async def mock_async_gen(data, chunk_size=1): - for i in range(0, len(data)): # pragma: NO COVER - chunk = data[i : i + chunk_size] - yield chunk.encode("utf-8") - -def client_cert_source_callback(): - return b"cert bytes", b"key bytes" - -# TODO: use async auth anon credentials by default once the minimum version of google-auth is upgraded. -# See related issue: https://github.com/googleapis/gapic-generator-python/issues/2107. -def async_anonymous_credentials(): - if HAS_GOOGLE_AUTH_AIO: - return ga_credentials_async.AnonymousCredentials() - return ga_credentials.AnonymousCredentials() - -# 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 - -# If default endpoint template is localhost, then default mtls endpoint will be the same. -# This method modifies the default endpoint template so the client can produce a different -# mtls endpoint for endpoint testing purposes. -def modify_default_endpoint_template(client): - return "test.{UNIVERSE_DOMAIN}" if ("localhost" in client._DEFAULT_ENDPOINT_TEMPLATE) else client._DEFAULT_ENDPOINT_TEMPLATE - - -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 ReservationServiceClient._get_default_mtls_endpoint(None) is None - assert ReservationServiceClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint - assert ReservationServiceClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint - assert ReservationServiceClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint - assert ReservationServiceClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint - assert ReservationServiceClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi - -def test__read_environment_variables(): - assert ReservationServiceClient._read_environment_variables() == (False, "auto", None) - - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): - assert ReservationServiceClient._read_environment_variables() == (True, "auto", None) - - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): - assert ReservationServiceClient._read_environment_variables() == (False, "auto", None) - - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): - with pytest.raises(ValueError) as excinfo: - ReservationServiceClient._read_environment_variables() - assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" - - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): - assert ReservationServiceClient._read_environment_variables() == (False, "never", None) - - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): - assert ReservationServiceClient._read_environment_variables() == (False, "always", None) - - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}): - assert ReservationServiceClient._read_environment_variables() == (False, "auto", None) - - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): - with pytest.raises(MutualTLSChannelError) as excinfo: - ReservationServiceClient._read_environment_variables() - assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" - - with mock.patch.dict(os.environ, {"GOOGLE_CLOUD_UNIVERSE_DOMAIN": "foo.com"}): - assert ReservationServiceClient._read_environment_variables() == (False, "auto", "foo.com") - -def test__get_client_cert_source(): - mock_provided_cert_source = mock.Mock() - mock_default_cert_source = mock.Mock() - - assert ReservationServiceClient._get_client_cert_source(None, False) is None - assert ReservationServiceClient._get_client_cert_source(mock_provided_cert_source, False) is None - assert ReservationServiceClient._get_client_cert_source(mock_provided_cert_source, True) == mock_provided_cert_source - - 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_default_cert_source): - assert ReservationServiceClient._get_client_cert_source(None, True) is mock_default_cert_source - assert ReservationServiceClient._get_client_cert_source(mock_provided_cert_source, "true") is mock_provided_cert_source - -@mock.patch.object(ReservationServiceClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(ReservationServiceClient)) -@mock.patch.object(ReservationServiceAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(ReservationServiceAsyncClient)) -def test__get_api_endpoint(): - api_override = "foo.com" - mock_client_cert_source = mock.Mock() - default_universe = ReservationServiceClient._DEFAULT_UNIVERSE - default_endpoint = ReservationServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=default_universe) - mock_universe = "bar.com" - mock_endpoint = ReservationServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=mock_universe) - - assert ReservationServiceClient._get_api_endpoint(api_override, mock_client_cert_source, default_universe, "always") == api_override - assert ReservationServiceClient._get_api_endpoint(None, mock_client_cert_source, default_universe, "auto") == ReservationServiceClient.DEFAULT_MTLS_ENDPOINT - assert ReservationServiceClient._get_api_endpoint(None, None, default_universe, "auto") == default_endpoint - assert ReservationServiceClient._get_api_endpoint(None, None, default_universe, "always") == ReservationServiceClient.DEFAULT_MTLS_ENDPOINT - assert ReservationServiceClient._get_api_endpoint(None, mock_client_cert_source, default_universe, "always") == ReservationServiceClient.DEFAULT_MTLS_ENDPOINT - assert ReservationServiceClient._get_api_endpoint(None, None, mock_universe, "never") == mock_endpoint - assert ReservationServiceClient._get_api_endpoint(None, None, default_universe, "never") == default_endpoint - - with pytest.raises(MutualTLSChannelError) as excinfo: - ReservationServiceClient._get_api_endpoint(None, mock_client_cert_source, mock_universe, "auto") - assert str(excinfo.value) == "mTLS is not supported in any universe other than googleapis.com." - - -def test__get_universe_domain(): - client_universe_domain = "foo.com" - universe_domain_env = "bar.com" - - assert ReservationServiceClient._get_universe_domain(client_universe_domain, universe_domain_env) == client_universe_domain - assert ReservationServiceClient._get_universe_domain(None, universe_domain_env) == universe_domain_env - assert ReservationServiceClient._get_universe_domain(None, None) == ReservationServiceClient._DEFAULT_UNIVERSE - - with pytest.raises(ValueError) as excinfo: - ReservationServiceClient._get_universe_domain("", None) - assert str(excinfo.value) == "Universe Domain cannot be an empty string." - -@pytest.mark.parametrize("error_code,cred_info_json,show_cred_info", [ - (401, CRED_INFO_JSON, True), - (403, CRED_INFO_JSON, True), - (404, CRED_INFO_JSON, True), - (500, CRED_INFO_JSON, False), - (401, None, False), - (403, None, False), - (404, None, False), - (500, None, False) -]) -def test__add_cred_info_for_auth_errors(error_code, cred_info_json, show_cred_info): - cred = mock.Mock(["get_cred_info"]) - cred.get_cred_info = mock.Mock(return_value=cred_info_json) - client = ReservationServiceClient(credentials=cred) - client._transport._credentials = cred - - error = core_exceptions.GoogleAPICallError("message", details=["foo"]) - error.code = error_code - - client._add_cred_info_for_auth_errors(error) - if show_cred_info: - assert error.details == ["foo", CRED_INFO_STRING] - else: - assert error.details == ["foo"] - -@pytest.mark.parametrize("error_code", [401,403,404,500]) -def test__add_cred_info_for_auth_errors_no_get_cred_info(error_code): - cred = mock.Mock([]) - assert not hasattr(cred, "get_cred_info") - client = ReservationServiceClient(credentials=cred) - client._transport._credentials = cred - - error = core_exceptions.GoogleAPICallError("message", details=[]) - error.code = error_code - - client._add_cred_info_for_auth_errors(error) - assert error.details == [] - -@pytest.mark.parametrize("client_class,transport_name", [ - (ReservationServiceClient, "grpc"), - (ReservationServiceAsyncClient, "grpc_asyncio"), - (ReservationServiceClient, "rest"), -]) -def test_reservation_service_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 == ( - 'bigqueryreservation.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://bigqueryreservation.googleapis.com' - ) - - -@pytest.mark.parametrize("transport_class,transport_name", [ - (transports.ReservationServiceGrpcTransport, "grpc"), - (transports.ReservationServiceGrpcAsyncIOTransport, "grpc_asyncio"), - (transports.ReservationServiceRestTransport, "rest"), -]) -def test_reservation_service_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", [ - (ReservationServiceClient, "grpc"), - (ReservationServiceAsyncClient, "grpc_asyncio"), - (ReservationServiceClient, "rest"), -]) -def test_reservation_service_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 == ( - 'bigqueryreservation.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://bigqueryreservation.googleapis.com' - ) - - -def test_reservation_service_client_get_transport_class(): - transport = ReservationServiceClient.get_transport_class() - available_transports = [ - transports.ReservationServiceGrpcTransport, - transports.ReservationServiceRestTransport, - ] - assert transport in available_transports - - transport = ReservationServiceClient.get_transport_class("grpc") - assert transport == transports.ReservationServiceGrpcTransport - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (ReservationServiceClient, transports.ReservationServiceGrpcTransport, "grpc"), - (ReservationServiceAsyncClient, transports.ReservationServiceGrpcAsyncIOTransport, "grpc_asyncio"), - (ReservationServiceClient, transports.ReservationServiceRestTransport, "rest"), -]) -@mock.patch.object(ReservationServiceClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(ReservationServiceClient)) -@mock.patch.object(ReservationServiceAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(ReservationServiceAsyncClient)) -def test_reservation_service_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(ReservationServiceClient, '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(ReservationServiceClient, '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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), - 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) as excinfo: - client = client_class(transport=transport_name) - assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" - - # 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) as excinfo: - client = client_class(transport=transport_name) - assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" - - # 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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), - 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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), - 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", [ - (ReservationServiceClient, transports.ReservationServiceGrpcTransport, "grpc", "true"), - (ReservationServiceAsyncClient, transports.ReservationServiceGrpcAsyncIOTransport, "grpc_asyncio", "true"), - (ReservationServiceClient, transports.ReservationServiceGrpcTransport, "grpc", "false"), - (ReservationServiceAsyncClient, transports.ReservationServiceGrpcAsyncIOTransport, "grpc_asyncio", "false"), - (ReservationServiceClient, transports.ReservationServiceRestTransport, "rest", "true"), - (ReservationServiceClient, transports.ReservationServiceRestTransport, "rest", "false"), -]) -@mock.patch.object(ReservationServiceClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(ReservationServiceClient)) -@mock.patch.object(ReservationServiceAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(ReservationServiceAsyncClient)) -@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) -def test_reservation_service_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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE) - 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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE) - 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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), - 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", [ - ReservationServiceClient, ReservationServiceAsyncClient -]) -@mock.patch.object(ReservationServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(ReservationServiceClient)) -@mock.patch.object(ReservationServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(ReservationServiceAsyncClient)) -def test_reservation_service_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 - - # 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) as excinfo: - client_class.get_mtls_endpoint_and_cert_source() - - assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" - - # 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) as excinfo: - client_class.get_mtls_endpoint_and_cert_source() - - assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" - -@pytest.mark.parametrize("client_class", [ - ReservationServiceClient, ReservationServiceAsyncClient -]) -@mock.patch.object(ReservationServiceClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(ReservationServiceClient)) -@mock.patch.object(ReservationServiceAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(ReservationServiceAsyncClient)) -def test_reservation_service_client_client_api_endpoint(client_class): - mock_client_cert_source = client_cert_source_callback - api_override = "foo.com" - default_universe = ReservationServiceClient._DEFAULT_UNIVERSE - default_endpoint = ReservationServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=default_universe) - mock_universe = "bar.com" - mock_endpoint = ReservationServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=mock_universe) - - # If ClientOptions.api_endpoint is set and GOOGLE_API_USE_CLIENT_CERTIFICATE="true", - # use ClientOptions.api_endpoint as the api endpoint regardless. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): - with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel"): - options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=api_override) - client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) - assert client.api_endpoint == api_override - - # If ClientOptions.api_endpoint is not set and GOOGLE_API_USE_MTLS_ENDPOINT="never", - # use the _DEFAULT_ENDPOINT_TEMPLATE populated with GDU as the api endpoint. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): - client = client_class(credentials=ga_credentials.AnonymousCredentials()) - assert client.api_endpoint == default_endpoint - - # If ClientOptions.api_endpoint is not set and GOOGLE_API_USE_MTLS_ENDPOINT="always", - # use the DEFAULT_MTLS_ENDPOINT as the api endpoint. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): - client = client_class(credentials=ga_credentials.AnonymousCredentials()) - assert client.api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT - - # If ClientOptions.api_endpoint is not set, GOOGLE_API_USE_MTLS_ENDPOINT="auto" (default), - # GOOGLE_API_USE_CLIENT_CERTIFICATE="false" (default), default cert source doesn't exist, - # and ClientOptions.universe_domain="bar.com", - # use the _DEFAULT_ENDPOINT_TEMPLATE populated with universe domain as the api endpoint. - options = client_options.ClientOptions() - universe_exists = hasattr(options, "universe_domain") - if universe_exists: - options = client_options.ClientOptions(universe_domain=mock_universe) - client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) - else: - client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) - assert client.api_endpoint == (mock_endpoint if universe_exists else default_endpoint) - assert client.universe_domain == (mock_universe if universe_exists else default_universe) - - # If ClientOptions does not have a universe domain attribute and GOOGLE_API_USE_MTLS_ENDPOINT="never", - # use the _DEFAULT_ENDPOINT_TEMPLATE populated with GDU as the api endpoint. - options = client_options.ClientOptions() - if hasattr(options, "universe_domain"): - delattr(options, "universe_domain") - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): - client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) - assert client.api_endpoint == default_endpoint - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (ReservationServiceClient, transports.ReservationServiceGrpcTransport, "grpc"), - (ReservationServiceAsyncClient, transports.ReservationServiceGrpcAsyncIOTransport, "grpc_asyncio"), - (ReservationServiceClient, transports.ReservationServiceRestTransport, "rest"), -]) -def test_reservation_service_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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), - 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", [ - (ReservationServiceClient, transports.ReservationServiceGrpcTransport, "grpc", grpc_helpers), - (ReservationServiceAsyncClient, transports.ReservationServiceGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), - (ReservationServiceClient, transports.ReservationServiceRestTransport, "rest", None), -]) -def test_reservation_service_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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), - 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_reservation_service_client_client_options_from_dict(): - with mock.patch('google.cloud.bigquery_reservation_v1.services.reservation_service.transports.ReservationServiceGrpcTransport.__init__') as grpc_transport: - grpc_transport.return_value = None - client = ReservationServiceClient( - 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", [ - (ReservationServiceClient, transports.ReservationServiceGrpcTransport, "grpc", grpc_helpers), - (ReservationServiceAsyncClient, transports.ReservationServiceGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), -]) -def test_reservation_service_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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), - 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( - "bigqueryreservation.googleapis.com:443", - credentials=file_creds, - credentials_file=None, - quota_project_id=None, - default_scopes=( - 'https://www.googleapis.com/auth/bigquery', - 'https://www.googleapis.com/auth/cloud-platform', -), - scopes=None, - default_host="bigqueryreservation.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("request_type", [ - gcbr_reservation.CreateReservationRequest, - dict, -]) -def test_create_reservation(request_type, transport: str = 'grpc'): - client = ReservationServiceClient( - 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_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = gcbr_reservation.Reservation( - name='name_value', - slot_capacity=1391, - ignore_idle_slots=True, - concurrency=1195, - multi_region_auxiliary=True, - edition=gcbr_reservation.Edition.STANDARD, - primary_location='primary_location_value', - secondary_location='secondary_location_value', - original_primary_location='original_primary_location_value', - max_slots=986, - scaling_mode=gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, - reservation_group='reservation_group_value', - ) - response = client.create_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = gcbr_reservation.CreateReservationRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, gcbr_reservation.Reservation) - assert response.name == 'name_value' - assert response.slot_capacity == 1391 - assert response.ignore_idle_slots is True - assert response.concurrency == 1195 - assert response.multi_region_auxiliary is True - assert response.edition == gcbr_reservation.Edition.STANDARD - assert response.primary_location == 'primary_location_value' - assert response.secondary_location == 'secondary_location_value' - assert response.original_primary_location == 'original_primary_location_value' - assert response.max_slots == 986 - assert response.scaling_mode == gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY - assert response.reservation_group == 'reservation_group_value' - - -def test_create_reservation_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = gcbr_reservation.CreateReservationRequest( - parent='parent_value', - reservation_id='reservation_id_value', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_reservation), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.create_reservation(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == gcbr_reservation.CreateReservationRequest( - parent='parent_value', - reservation_id='reservation_id_value', - ) - -def test_create_reservation_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.create_reservation in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.create_reservation] = mock_rpc - request = {} - client.create_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.create_reservation(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_create_reservation_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.create_reservation in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.AsyncMock() - mock_rpc.return_value = mock.Mock() - client._client._transport._wrapped_methods[client._client._transport.create_reservation] = mock_rpc - - request = {} - await client.create_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - await client.create_reservation(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_create_reservation_async(transport: str = 'grpc_asyncio', request_type=gcbr_reservation.CreateReservationRequest): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - 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_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(gcbr_reservation.Reservation( - name='name_value', - slot_capacity=1391, - ignore_idle_slots=True, - concurrency=1195, - multi_region_auxiliary=True, - edition=gcbr_reservation.Edition.STANDARD, - primary_location='primary_location_value', - secondary_location='secondary_location_value', - original_primary_location='original_primary_location_value', - max_slots=986, - scaling_mode=gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, - reservation_group='reservation_group_value', - )) - response = await client.create_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = gcbr_reservation.CreateReservationRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, gcbr_reservation.Reservation) - assert response.name == 'name_value' - assert response.slot_capacity == 1391 - assert response.ignore_idle_slots is True - assert response.concurrency == 1195 - assert response.multi_region_auxiliary is True - assert response.edition == gcbr_reservation.Edition.STANDARD - assert response.primary_location == 'primary_location_value' - assert response.secondary_location == 'secondary_location_value' - assert response.original_primary_location == 'original_primary_location_value' - assert response.max_slots == 986 - assert response.scaling_mode == gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY - assert response.reservation_group == 'reservation_group_value' - - -@pytest.mark.asyncio -async def test_create_reservation_async_from_dict(): - await test_create_reservation_async(request_type=dict) - -def test_create_reservation_field_headers(): - client = ReservationServiceClient( - 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 = gcbr_reservation.CreateReservationRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_reservation), - '__call__') as call: - call.return_value = gcbr_reservation.Reservation() - client.create_reservation(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_reservation_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # 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 = gcbr_reservation.CreateReservationRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_reservation), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(gcbr_reservation.Reservation()) - await client.create_reservation(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_reservation_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = gcbr_reservation.Reservation() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.create_reservation( - parent='parent_value', - reservation=gcbr_reservation.Reservation(name='name_value'), - reservation_id='reservation_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].reservation - mock_val = gcbr_reservation.Reservation(name='name_value') - assert arg == mock_val - arg = args[0].reservation_id - mock_val = 'reservation_id_value' - assert arg == mock_val - - -def test_create_reservation_flattened_error(): - client = ReservationServiceClient( - 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_reservation( - gcbr_reservation.CreateReservationRequest(), - parent='parent_value', - reservation=gcbr_reservation.Reservation(name='name_value'), - reservation_id='reservation_id_value', - ) - -@pytest.mark.asyncio -async def test_create_reservation_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = gcbr_reservation.Reservation() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(gcbr_reservation.Reservation()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.create_reservation( - parent='parent_value', - reservation=gcbr_reservation.Reservation(name='name_value'), - reservation_id='reservation_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].reservation - mock_val = gcbr_reservation.Reservation(name='name_value') - assert arg == mock_val - arg = args[0].reservation_id - mock_val = 'reservation_id_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_create_reservation_flattened_error_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.create_reservation( - gcbr_reservation.CreateReservationRequest(), - parent='parent_value', - reservation=gcbr_reservation.Reservation(name='name_value'), - reservation_id='reservation_id_value', - ) - - -@pytest.mark.parametrize("request_type", [ - reservation.ListReservationsRequest, - dict, -]) -def test_list_reservations(request_type, transport: str = 'grpc'): - client = ReservationServiceClient( - 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_reservations), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.ListReservationsResponse( - next_page_token='next_page_token_value', - ) - response = client.list_reservations(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = reservation.ListReservationsRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListReservationsPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_list_reservations_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = reservation.ListReservationsRequest( - parent='parent_value', - page_token='page_token_value', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_reservations), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.list_reservations(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.ListReservationsRequest( - parent='parent_value', - page_token='page_token_value', - ) - -def test_list_reservations_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.list_reservations in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.list_reservations] = mock_rpc - request = {} - client.list_reservations(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.list_reservations(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_list_reservations_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.list_reservations in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.AsyncMock() - mock_rpc.return_value = mock.Mock() - client._client._transport._wrapped_methods[client._client._transport.list_reservations] = mock_rpc - - request = {} - await client.list_reservations(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - await client.list_reservations(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_list_reservations_async(transport: str = 'grpc_asyncio', request_type=reservation.ListReservationsRequest): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - 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_reservations), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListReservationsResponse( - next_page_token='next_page_token_value', - )) - response = await client.list_reservations(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = reservation.ListReservationsRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListReservationsAsyncPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.asyncio -async def test_list_reservations_async_from_dict(): - await test_list_reservations_async(request_type=dict) - -def test_list_reservations_field_headers(): - client = ReservationServiceClient( - 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 = reservation.ListReservationsRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_reservations), - '__call__') as call: - call.return_value = reservation.ListReservationsResponse() - client.list_reservations(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_reservations_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # 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 = reservation.ListReservationsRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_reservations), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListReservationsResponse()) - await client.list_reservations(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_reservations_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_reservations), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.ListReservationsResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.list_reservations( - 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_reservations_flattened_error(): - client = ReservationServiceClient( - 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_reservations( - reservation.ListReservationsRequest(), - parent='parent_value', - ) - -@pytest.mark.asyncio -async def test_list_reservations_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_reservations), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.ListReservationsResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListReservationsResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.list_reservations( - 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_reservations_flattened_error_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.list_reservations( - reservation.ListReservationsRequest(), - parent='parent_value', - ) - - -def test_list_reservations_pager(transport_name: str = "grpc"): - client = ReservationServiceClient( - 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_reservations), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.ListReservationsResponse( - reservations=[ - reservation.Reservation(), - reservation.Reservation(), - reservation.Reservation(), - ], - next_page_token='abc', - ), - reservation.ListReservationsResponse( - reservations=[], - next_page_token='def', - ), - reservation.ListReservationsResponse( - reservations=[ - reservation.Reservation(), - ], - next_page_token='ghi', - ), - reservation.ListReservationsResponse( - reservations=[ - reservation.Reservation(), - reservation.Reservation(), - ], - ), - RuntimeError, - ) - - expected_metadata = () - retry = retries.Retry() - timeout = 5 - expected_metadata = tuple(expected_metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('parent', ''), - )), - ) - pager = client.list_reservations(request={}, retry=retry, timeout=timeout) - - assert pager._metadata == expected_metadata - assert pager._retry == retry - assert pager._timeout == timeout - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, reservation.Reservation) - for i in results) -def test_list_reservations_pages(transport_name: str = "grpc"): - client = ReservationServiceClient( - 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_reservations), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.ListReservationsResponse( - reservations=[ - reservation.Reservation(), - reservation.Reservation(), - reservation.Reservation(), - ], - next_page_token='abc', - ), - reservation.ListReservationsResponse( - reservations=[], - next_page_token='def', - ), - reservation.ListReservationsResponse( - reservations=[ - reservation.Reservation(), - ], - next_page_token='ghi', - ), - reservation.ListReservationsResponse( - reservations=[ - reservation.Reservation(), - reservation.Reservation(), - ], - ), - RuntimeError, - ) - pages = list(client.list_reservations(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_reservations_async_pager(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_reservations), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.ListReservationsResponse( - reservations=[ - reservation.Reservation(), - reservation.Reservation(), - reservation.Reservation(), - ], - next_page_token='abc', - ), - reservation.ListReservationsResponse( - reservations=[], - next_page_token='def', - ), - reservation.ListReservationsResponse( - reservations=[ - reservation.Reservation(), - ], - next_page_token='ghi', - ), - reservation.ListReservationsResponse( - reservations=[ - reservation.Reservation(), - reservation.Reservation(), - ], - ), - RuntimeError, - ) - async_pager = await client.list_reservations(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, reservation.Reservation) - for i in responses) - - -@pytest.mark.asyncio -async def test_list_reservations_async_pages(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_reservations), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.ListReservationsResponse( - reservations=[ - reservation.Reservation(), - reservation.Reservation(), - reservation.Reservation(), - ], - next_page_token='abc', - ), - reservation.ListReservationsResponse( - reservations=[], - next_page_token='def', - ), - reservation.ListReservationsResponse( - reservations=[ - reservation.Reservation(), - ], - next_page_token='ghi', - ), - reservation.ListReservationsResponse( - reservations=[ - reservation.Reservation(), - reservation.Reservation(), - ], - ), - RuntimeError, - ) - pages = [] - # Workaround issue in python 3.9 related to code coverage by adding `# pragma: no branch` - # See https://github.com/googleapis/gapic-generator-python/pull/1174#issuecomment-1025132372 - async for page_ in ( # pragma: no branch - await client.list_reservations(request={}) - ).pages: - 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", [ - reservation.GetReservationRequest, - dict, -]) -def test_get_reservation(request_type, transport: str = 'grpc'): - client = ReservationServiceClient( - 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_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.Reservation( - name='name_value', - slot_capacity=1391, - ignore_idle_slots=True, - concurrency=1195, - multi_region_auxiliary=True, - edition=reservation.Edition.STANDARD, - primary_location='primary_location_value', - secondary_location='secondary_location_value', - original_primary_location='original_primary_location_value', - max_slots=986, - scaling_mode=reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, - reservation_group='reservation_group_value', - ) - response = client.get_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = reservation.GetReservationRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.Reservation) - assert response.name == 'name_value' - assert response.slot_capacity == 1391 - assert response.ignore_idle_slots is True - assert response.concurrency == 1195 - assert response.multi_region_auxiliary is True - assert response.edition == reservation.Edition.STANDARD - assert response.primary_location == 'primary_location_value' - assert response.secondary_location == 'secondary_location_value' - assert response.original_primary_location == 'original_primary_location_value' - assert response.max_slots == 986 - assert response.scaling_mode == reservation.Reservation.ScalingMode.AUTOSCALE_ONLY - assert response.reservation_group == 'reservation_group_value' - - -def test_get_reservation_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = reservation.GetReservationRequest( - name='name_value', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_reservation), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.get_reservation(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.GetReservationRequest( - name='name_value', - ) - -def test_get_reservation_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.get_reservation in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.get_reservation] = mock_rpc - request = {} - client.get_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.get_reservation(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_get_reservation_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.get_reservation in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.AsyncMock() - mock_rpc.return_value = mock.Mock() - client._client._transport._wrapped_methods[client._client._transport.get_reservation] = mock_rpc - - request = {} - await client.get_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - await client.get_reservation(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_get_reservation_async(transport: str = 'grpc_asyncio', request_type=reservation.GetReservationRequest): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - 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_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.Reservation( - name='name_value', - slot_capacity=1391, - ignore_idle_slots=True, - concurrency=1195, - multi_region_auxiliary=True, - edition=reservation.Edition.STANDARD, - primary_location='primary_location_value', - secondary_location='secondary_location_value', - original_primary_location='original_primary_location_value', - max_slots=986, - scaling_mode=reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, - reservation_group='reservation_group_value', - )) - response = await client.get_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = reservation.GetReservationRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.Reservation) - assert response.name == 'name_value' - assert response.slot_capacity == 1391 - assert response.ignore_idle_slots is True - assert response.concurrency == 1195 - assert response.multi_region_auxiliary is True - assert response.edition == reservation.Edition.STANDARD - assert response.primary_location == 'primary_location_value' - assert response.secondary_location == 'secondary_location_value' - assert response.original_primary_location == 'original_primary_location_value' - assert response.max_slots == 986 - assert response.scaling_mode == reservation.Reservation.ScalingMode.AUTOSCALE_ONLY - assert response.reservation_group == 'reservation_group_value' - - -@pytest.mark.asyncio -async def test_get_reservation_async_from_dict(): - await test_get_reservation_async(request_type=dict) - -def test_get_reservation_field_headers(): - client = ReservationServiceClient( - 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 = reservation.GetReservationRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_reservation), - '__call__') as call: - call.return_value = reservation.Reservation() - client.get_reservation(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_reservation_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # 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 = reservation.GetReservationRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_reservation), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Reservation()) - await client.get_reservation(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_reservation_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.Reservation() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_reservation( - 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_reservation_flattened_error(): - client = ReservationServiceClient( - 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_reservation( - reservation.GetReservationRequest(), - name='name_value', - ) - -@pytest.mark.asyncio -async def test_get_reservation_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.Reservation() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Reservation()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_reservation( - 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_reservation_flattened_error_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.get_reservation( - reservation.GetReservationRequest(), - name='name_value', - ) - - -@pytest.mark.parametrize("request_type", [ - reservation.DeleteReservationRequest, - dict, -]) -def test_delete_reservation(request_type, transport: str = 'grpc'): - client = ReservationServiceClient( - 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_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = None - response = client.delete_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = reservation.DeleteReservationRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert response is None - - -def test_delete_reservation_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = reservation.DeleteReservationRequest( - name='name_value', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_reservation), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.delete_reservation(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.DeleteReservationRequest( - name='name_value', - ) - -def test_delete_reservation_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.delete_reservation in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.delete_reservation] = mock_rpc - request = {} - client.delete_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.delete_reservation(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_delete_reservation_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.delete_reservation in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.AsyncMock() - mock_rpc.return_value = mock.Mock() - client._client._transport._wrapped_methods[client._client._transport.delete_reservation] = mock_rpc - - request = {} - await client.delete_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - await client.delete_reservation(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_delete_reservation_async(transport: str = 'grpc_asyncio', request_type=reservation.DeleteReservationRequest): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - 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_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - response = await client.delete_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = reservation.DeleteReservationRequest() - 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_reservation_async_from_dict(): - await test_delete_reservation_async(request_type=dict) - -def test_delete_reservation_field_headers(): - client = ReservationServiceClient( - 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 = reservation.DeleteReservationRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_reservation), - '__call__') as call: - call.return_value = None - client.delete_reservation(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_reservation_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # 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 = reservation.DeleteReservationRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_reservation), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - await client.delete_reservation(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_reservation_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = None - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.delete_reservation( - 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_reservation_flattened_error(): - client = ReservationServiceClient( - 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_reservation( - reservation.DeleteReservationRequest(), - name='name_value', - ) - -@pytest.mark.asyncio -async def test_delete_reservation_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = None - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.delete_reservation( - 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_reservation_flattened_error_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.delete_reservation( - reservation.DeleteReservationRequest(), - name='name_value', - ) - - -@pytest.mark.parametrize("request_type", [ - gcbr_reservation.UpdateReservationRequest, - dict, -]) -def test_update_reservation(request_type, transport: str = 'grpc'): - client = ReservationServiceClient( - 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_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = gcbr_reservation.Reservation( - name='name_value', - slot_capacity=1391, - ignore_idle_slots=True, - concurrency=1195, - multi_region_auxiliary=True, - edition=gcbr_reservation.Edition.STANDARD, - primary_location='primary_location_value', - secondary_location='secondary_location_value', - original_primary_location='original_primary_location_value', - max_slots=986, - scaling_mode=gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, - reservation_group='reservation_group_value', - ) - response = client.update_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = gcbr_reservation.UpdateReservationRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, gcbr_reservation.Reservation) - assert response.name == 'name_value' - assert response.slot_capacity == 1391 - assert response.ignore_idle_slots is True - assert response.concurrency == 1195 - assert response.multi_region_auxiliary is True - assert response.edition == gcbr_reservation.Edition.STANDARD - assert response.primary_location == 'primary_location_value' - assert response.secondary_location == 'secondary_location_value' - assert response.original_primary_location == 'original_primary_location_value' - assert response.max_slots == 986 - assert response.scaling_mode == gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY - assert response.reservation_group == 'reservation_group_value' - - -def test_update_reservation_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = gcbr_reservation.UpdateReservationRequest( - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_reservation), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.update_reservation(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == gcbr_reservation.UpdateReservationRequest( - ) - -def test_update_reservation_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.update_reservation in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.update_reservation] = mock_rpc - request = {} - client.update_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.update_reservation(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_update_reservation_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.update_reservation in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.AsyncMock() - mock_rpc.return_value = mock.Mock() - client._client._transport._wrapped_methods[client._client._transport.update_reservation] = mock_rpc - - request = {} - await client.update_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - await client.update_reservation(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_update_reservation_async(transport: str = 'grpc_asyncio', request_type=gcbr_reservation.UpdateReservationRequest): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - 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_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(gcbr_reservation.Reservation( - name='name_value', - slot_capacity=1391, - ignore_idle_slots=True, - concurrency=1195, - multi_region_auxiliary=True, - edition=gcbr_reservation.Edition.STANDARD, - primary_location='primary_location_value', - secondary_location='secondary_location_value', - original_primary_location='original_primary_location_value', - max_slots=986, - scaling_mode=gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, - reservation_group='reservation_group_value', - )) - response = await client.update_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = gcbr_reservation.UpdateReservationRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, gcbr_reservation.Reservation) - assert response.name == 'name_value' - assert response.slot_capacity == 1391 - assert response.ignore_idle_slots is True - assert response.concurrency == 1195 - assert response.multi_region_auxiliary is True - assert response.edition == gcbr_reservation.Edition.STANDARD - assert response.primary_location == 'primary_location_value' - assert response.secondary_location == 'secondary_location_value' - assert response.original_primary_location == 'original_primary_location_value' - assert response.max_slots == 986 - assert response.scaling_mode == gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY - assert response.reservation_group == 'reservation_group_value' - - -@pytest.mark.asyncio -async def test_update_reservation_async_from_dict(): - await test_update_reservation_async(request_type=dict) - -def test_update_reservation_field_headers(): - client = ReservationServiceClient( - 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 = gcbr_reservation.UpdateReservationRequest() - - request.reservation.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_reservation), - '__call__') as call: - call.return_value = gcbr_reservation.Reservation() - client.update_reservation(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', - 'reservation.name=name_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_update_reservation_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # 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 = gcbr_reservation.UpdateReservationRequest() - - request.reservation.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_reservation), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(gcbr_reservation.Reservation()) - await client.update_reservation(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', - 'reservation.name=name_value', - ) in kw['metadata'] - - -def test_update_reservation_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = gcbr_reservation.Reservation() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.update_reservation( - reservation=gcbr_reservation.Reservation(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].reservation - mock_val = gcbr_reservation.Reservation(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_reservation_flattened_error(): - client = ReservationServiceClient( - 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_reservation( - gcbr_reservation.UpdateReservationRequest(), - reservation=gcbr_reservation.Reservation(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - -@pytest.mark.asyncio -async def test_update_reservation_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = gcbr_reservation.Reservation() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(gcbr_reservation.Reservation()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.update_reservation( - reservation=gcbr_reservation.Reservation(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].reservation - mock_val = gcbr_reservation.Reservation(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_reservation_flattened_error_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.update_reservation( - gcbr_reservation.UpdateReservationRequest(), - reservation=gcbr_reservation.Reservation(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -@pytest.mark.parametrize("request_type", [ - reservation.FailoverReservationRequest, - dict, -]) -def test_failover_reservation(request_type, transport: str = 'grpc'): - client = ReservationServiceClient( - 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.failover_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.Reservation( - name='name_value', - slot_capacity=1391, - ignore_idle_slots=True, - concurrency=1195, - multi_region_auxiliary=True, - edition=reservation.Edition.STANDARD, - primary_location='primary_location_value', - secondary_location='secondary_location_value', - original_primary_location='original_primary_location_value', - max_slots=986, - scaling_mode=reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, - reservation_group='reservation_group_value', - ) - response = client.failover_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = reservation.FailoverReservationRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.Reservation) - assert response.name == 'name_value' - assert response.slot_capacity == 1391 - assert response.ignore_idle_slots is True - assert response.concurrency == 1195 - assert response.multi_region_auxiliary is True - assert response.edition == reservation.Edition.STANDARD - assert response.primary_location == 'primary_location_value' - assert response.secondary_location == 'secondary_location_value' - assert response.original_primary_location == 'original_primary_location_value' - assert response.max_slots == 986 - assert response.scaling_mode == reservation.Reservation.ScalingMode.AUTOSCALE_ONLY - assert response.reservation_group == 'reservation_group_value' - - -def test_failover_reservation_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = reservation.FailoverReservationRequest( - name='name_value', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.failover_reservation), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.failover_reservation(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.FailoverReservationRequest( - name='name_value', - ) - -def test_failover_reservation_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.failover_reservation in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.failover_reservation] = mock_rpc - request = {} - client.failover_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.failover_reservation(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_failover_reservation_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.failover_reservation in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.AsyncMock() - mock_rpc.return_value = mock.Mock() - client._client._transport._wrapped_methods[client._client._transport.failover_reservation] = mock_rpc - - request = {} - await client.failover_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - await client.failover_reservation(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_failover_reservation_async(transport: str = 'grpc_asyncio', request_type=reservation.FailoverReservationRequest): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - 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.failover_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.Reservation( - name='name_value', - slot_capacity=1391, - ignore_idle_slots=True, - concurrency=1195, - multi_region_auxiliary=True, - edition=reservation.Edition.STANDARD, - primary_location='primary_location_value', - secondary_location='secondary_location_value', - original_primary_location='original_primary_location_value', - max_slots=986, - scaling_mode=reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, - reservation_group='reservation_group_value', - )) - response = await client.failover_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = reservation.FailoverReservationRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.Reservation) - assert response.name == 'name_value' - assert response.slot_capacity == 1391 - assert response.ignore_idle_slots is True - assert response.concurrency == 1195 - assert response.multi_region_auxiliary is True - assert response.edition == reservation.Edition.STANDARD - assert response.primary_location == 'primary_location_value' - assert response.secondary_location == 'secondary_location_value' - assert response.original_primary_location == 'original_primary_location_value' - assert response.max_slots == 986 - assert response.scaling_mode == reservation.Reservation.ScalingMode.AUTOSCALE_ONLY - assert response.reservation_group == 'reservation_group_value' - - -@pytest.mark.asyncio -async def test_failover_reservation_async_from_dict(): - await test_failover_reservation_async(request_type=dict) - -def test_failover_reservation_field_headers(): - client = ReservationServiceClient( - 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 = reservation.FailoverReservationRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.failover_reservation), - '__call__') as call: - call.return_value = reservation.Reservation() - client.failover_reservation(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_failover_reservation_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # 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 = reservation.FailoverReservationRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.failover_reservation), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Reservation()) - await client.failover_reservation(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", [ - reservation.CreateCapacityCommitmentRequest, - dict, -]) -def test_create_capacity_commitment(request_type, transport: str = 'grpc'): - client = ReservationServiceClient( - 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_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.CapacityCommitment( - name='name_value', - slot_count=1098, - plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - state=reservation.CapacityCommitment.State.PENDING, - renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - multi_region_auxiliary=True, - edition=reservation.Edition.STANDARD, - is_flat_rate=True, - ) - response = client.create_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = reservation.CreateCapacityCommitmentRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.CapacityCommitment) - assert response.name == 'name_value' - assert response.slot_count == 1098 - assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.state == reservation.CapacityCommitment.State.PENDING - assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.multi_region_auxiliary is True - assert response.edition == reservation.Edition.STANDARD - assert response.is_flat_rate is True - - -def test_create_capacity_commitment_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = reservation.CreateCapacityCommitmentRequest( - parent='parent_value', - capacity_commitment_id='capacity_commitment_id_value', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_capacity_commitment), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.create_capacity_commitment(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.CreateCapacityCommitmentRequest( - parent='parent_value', - capacity_commitment_id='capacity_commitment_id_value', - ) - -def test_create_capacity_commitment_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.create_capacity_commitment in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.create_capacity_commitment] = mock_rpc - request = {} - client.create_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.create_capacity_commitment(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_create_capacity_commitment_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.create_capacity_commitment in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.AsyncMock() - mock_rpc.return_value = mock.Mock() - client._client._transport._wrapped_methods[client._client._transport.create_capacity_commitment] = mock_rpc - - request = {} - await client.create_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - await client.create_capacity_commitment(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_create_capacity_commitment_async(transport: str = 'grpc_asyncio', request_type=reservation.CreateCapacityCommitmentRequest): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - 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_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment( - name='name_value', - slot_count=1098, - plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - state=reservation.CapacityCommitment.State.PENDING, - renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - multi_region_auxiliary=True, - edition=reservation.Edition.STANDARD, - is_flat_rate=True, - )) - response = await client.create_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = reservation.CreateCapacityCommitmentRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.CapacityCommitment) - assert response.name == 'name_value' - assert response.slot_count == 1098 - assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.state == reservation.CapacityCommitment.State.PENDING - assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.multi_region_auxiliary is True - assert response.edition == reservation.Edition.STANDARD - assert response.is_flat_rate is True - - -@pytest.mark.asyncio -async def test_create_capacity_commitment_async_from_dict(): - await test_create_capacity_commitment_async(request_type=dict) - -def test_create_capacity_commitment_field_headers(): - client = ReservationServiceClient( - 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 = reservation.CreateCapacityCommitmentRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_capacity_commitment), - '__call__') as call: - call.return_value = reservation.CapacityCommitment() - client.create_capacity_commitment(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_capacity_commitment_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # 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 = reservation.CreateCapacityCommitmentRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_capacity_commitment), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment()) - await client.create_capacity_commitment(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_capacity_commitment_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.CapacityCommitment() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.create_capacity_commitment( - parent='parent_value', - capacity_commitment=reservation.CapacityCommitment(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].parent - mock_val = 'parent_value' - assert arg == mock_val - arg = args[0].capacity_commitment - mock_val = reservation.CapacityCommitment(name='name_value') - assert arg == mock_val - - -def test_create_capacity_commitment_flattened_error(): - client = ReservationServiceClient( - 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_capacity_commitment( - reservation.CreateCapacityCommitmentRequest(), - parent='parent_value', - capacity_commitment=reservation.CapacityCommitment(name='name_value'), - ) - -@pytest.mark.asyncio -async def test_create_capacity_commitment_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.CapacityCommitment() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.create_capacity_commitment( - parent='parent_value', - capacity_commitment=reservation.CapacityCommitment(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].parent - mock_val = 'parent_value' - assert arg == mock_val - arg = args[0].capacity_commitment - mock_val = reservation.CapacityCommitment(name='name_value') - assert arg == mock_val - -@pytest.mark.asyncio -async def test_create_capacity_commitment_flattened_error_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.create_capacity_commitment( - reservation.CreateCapacityCommitmentRequest(), - parent='parent_value', - capacity_commitment=reservation.CapacityCommitment(name='name_value'), - ) - - -@pytest.mark.parametrize("request_type", [ - reservation.ListCapacityCommitmentsRequest, - dict, -]) -def test_list_capacity_commitments(request_type, transport: str = 'grpc'): - client = ReservationServiceClient( - 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_capacity_commitments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.ListCapacityCommitmentsResponse( - next_page_token='next_page_token_value', - ) - response = client.list_capacity_commitments(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = reservation.ListCapacityCommitmentsRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListCapacityCommitmentsPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_list_capacity_commitments_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = reservation.ListCapacityCommitmentsRequest( - parent='parent_value', - page_token='page_token_value', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_capacity_commitments), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.list_capacity_commitments(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.ListCapacityCommitmentsRequest( - parent='parent_value', - page_token='page_token_value', - ) - -def test_list_capacity_commitments_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.list_capacity_commitments in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.list_capacity_commitments] = mock_rpc - request = {} - client.list_capacity_commitments(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.list_capacity_commitments(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_list_capacity_commitments_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.list_capacity_commitments in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.AsyncMock() - mock_rpc.return_value = mock.Mock() - client._client._transport._wrapped_methods[client._client._transport.list_capacity_commitments] = mock_rpc - - request = {} - await client.list_capacity_commitments(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - await client.list_capacity_commitments(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_list_capacity_commitments_async(transport: str = 'grpc_asyncio', request_type=reservation.ListCapacityCommitmentsRequest): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - 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_capacity_commitments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListCapacityCommitmentsResponse( - next_page_token='next_page_token_value', - )) - response = await client.list_capacity_commitments(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = reservation.ListCapacityCommitmentsRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListCapacityCommitmentsAsyncPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.asyncio -async def test_list_capacity_commitments_async_from_dict(): - await test_list_capacity_commitments_async(request_type=dict) - -def test_list_capacity_commitments_field_headers(): - client = ReservationServiceClient( - 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 = reservation.ListCapacityCommitmentsRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_capacity_commitments), - '__call__') as call: - call.return_value = reservation.ListCapacityCommitmentsResponse() - client.list_capacity_commitments(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_capacity_commitments_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # 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 = reservation.ListCapacityCommitmentsRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_capacity_commitments), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListCapacityCommitmentsResponse()) - await client.list_capacity_commitments(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_capacity_commitments_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_capacity_commitments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.ListCapacityCommitmentsResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.list_capacity_commitments( - 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_capacity_commitments_flattened_error(): - client = ReservationServiceClient( - 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_capacity_commitments( - reservation.ListCapacityCommitmentsRequest(), - parent='parent_value', - ) - -@pytest.mark.asyncio -async def test_list_capacity_commitments_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_capacity_commitments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.ListCapacityCommitmentsResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListCapacityCommitmentsResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.list_capacity_commitments( - 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_capacity_commitments_flattened_error_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.list_capacity_commitments( - reservation.ListCapacityCommitmentsRequest(), - parent='parent_value', - ) - - -def test_list_capacity_commitments_pager(transport_name: str = "grpc"): - client = ReservationServiceClient( - 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_capacity_commitments), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[ - reservation.CapacityCommitment(), - reservation.CapacityCommitment(), - reservation.CapacityCommitment(), - ], - next_page_token='abc', - ), - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[], - next_page_token='def', - ), - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[ - reservation.CapacityCommitment(), - ], - next_page_token='ghi', - ), - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[ - reservation.CapacityCommitment(), - reservation.CapacityCommitment(), - ], - ), - RuntimeError, - ) - - expected_metadata = () - retry = retries.Retry() - timeout = 5 - expected_metadata = tuple(expected_metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('parent', ''), - )), - ) - pager = client.list_capacity_commitments(request={}, retry=retry, timeout=timeout) - - assert pager._metadata == expected_metadata - assert pager._retry == retry - assert pager._timeout == timeout - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, reservation.CapacityCommitment) - for i in results) -def test_list_capacity_commitments_pages(transport_name: str = "grpc"): - client = ReservationServiceClient( - 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_capacity_commitments), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[ - reservation.CapacityCommitment(), - reservation.CapacityCommitment(), - reservation.CapacityCommitment(), - ], - next_page_token='abc', - ), - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[], - next_page_token='def', - ), - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[ - reservation.CapacityCommitment(), - ], - next_page_token='ghi', - ), - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[ - reservation.CapacityCommitment(), - reservation.CapacityCommitment(), - ], - ), - RuntimeError, - ) - pages = list(client.list_capacity_commitments(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_capacity_commitments_async_pager(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_capacity_commitments), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[ - reservation.CapacityCommitment(), - reservation.CapacityCommitment(), - reservation.CapacityCommitment(), - ], - next_page_token='abc', - ), - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[], - next_page_token='def', - ), - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[ - reservation.CapacityCommitment(), - ], - next_page_token='ghi', - ), - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[ - reservation.CapacityCommitment(), - reservation.CapacityCommitment(), - ], - ), - RuntimeError, - ) - async_pager = await client.list_capacity_commitments(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, reservation.CapacityCommitment) - for i in responses) - - -@pytest.mark.asyncio -async def test_list_capacity_commitments_async_pages(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_capacity_commitments), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[ - reservation.CapacityCommitment(), - reservation.CapacityCommitment(), - reservation.CapacityCommitment(), - ], - next_page_token='abc', - ), - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[], - next_page_token='def', - ), - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[ - reservation.CapacityCommitment(), - ], - next_page_token='ghi', - ), - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[ - reservation.CapacityCommitment(), - reservation.CapacityCommitment(), - ], - ), - RuntimeError, - ) - pages = [] - # Workaround issue in python 3.9 related to code coverage by adding `# pragma: no branch` - # See https://github.com/googleapis/gapic-generator-python/pull/1174#issuecomment-1025132372 - async for page_ in ( # pragma: no branch - await client.list_capacity_commitments(request={}) - ).pages: - 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", [ - reservation.GetCapacityCommitmentRequest, - dict, -]) -def test_get_capacity_commitment(request_type, transport: str = 'grpc'): - client = ReservationServiceClient( - 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_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.CapacityCommitment( - name='name_value', - slot_count=1098, - plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - state=reservation.CapacityCommitment.State.PENDING, - renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - multi_region_auxiliary=True, - edition=reservation.Edition.STANDARD, - is_flat_rate=True, - ) - response = client.get_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = reservation.GetCapacityCommitmentRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.CapacityCommitment) - assert response.name == 'name_value' - assert response.slot_count == 1098 - assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.state == reservation.CapacityCommitment.State.PENDING - assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.multi_region_auxiliary is True - assert response.edition == reservation.Edition.STANDARD - assert response.is_flat_rate is True - - -def test_get_capacity_commitment_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = reservation.GetCapacityCommitmentRequest( - name='name_value', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_capacity_commitment), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.get_capacity_commitment(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.GetCapacityCommitmentRequest( - name='name_value', - ) - -def test_get_capacity_commitment_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.get_capacity_commitment in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.get_capacity_commitment] = mock_rpc - request = {} - client.get_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.get_capacity_commitment(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_get_capacity_commitment_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.get_capacity_commitment in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.AsyncMock() - mock_rpc.return_value = mock.Mock() - client._client._transport._wrapped_methods[client._client._transport.get_capacity_commitment] = mock_rpc - - request = {} - await client.get_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - await client.get_capacity_commitment(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_get_capacity_commitment_async(transport: str = 'grpc_asyncio', request_type=reservation.GetCapacityCommitmentRequest): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - 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_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment( - name='name_value', - slot_count=1098, - plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - state=reservation.CapacityCommitment.State.PENDING, - renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - multi_region_auxiliary=True, - edition=reservation.Edition.STANDARD, - is_flat_rate=True, - )) - response = await client.get_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = reservation.GetCapacityCommitmentRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.CapacityCommitment) - assert response.name == 'name_value' - assert response.slot_count == 1098 - assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.state == reservation.CapacityCommitment.State.PENDING - assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.multi_region_auxiliary is True - assert response.edition == reservation.Edition.STANDARD - assert response.is_flat_rate is True - - -@pytest.mark.asyncio -async def test_get_capacity_commitment_async_from_dict(): - await test_get_capacity_commitment_async(request_type=dict) - -def test_get_capacity_commitment_field_headers(): - client = ReservationServiceClient( - 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 = reservation.GetCapacityCommitmentRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_capacity_commitment), - '__call__') as call: - call.return_value = reservation.CapacityCommitment() - client.get_capacity_commitment(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_capacity_commitment_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # 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 = reservation.GetCapacityCommitmentRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_capacity_commitment), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment()) - await client.get_capacity_commitment(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_capacity_commitment_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.CapacityCommitment() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_capacity_commitment( - 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_capacity_commitment_flattened_error(): - client = ReservationServiceClient( - 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_capacity_commitment( - reservation.GetCapacityCommitmentRequest(), - name='name_value', - ) - -@pytest.mark.asyncio -async def test_get_capacity_commitment_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.CapacityCommitment() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_capacity_commitment( - 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_capacity_commitment_flattened_error_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.get_capacity_commitment( - reservation.GetCapacityCommitmentRequest(), - name='name_value', - ) - - -@pytest.mark.parametrize("request_type", [ - reservation.DeleteCapacityCommitmentRequest, - dict, -]) -def test_delete_capacity_commitment(request_type, transport: str = 'grpc'): - client = ReservationServiceClient( - 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_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = None - response = client.delete_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = reservation.DeleteCapacityCommitmentRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert response is None - - -def test_delete_capacity_commitment_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = reservation.DeleteCapacityCommitmentRequest( - name='name_value', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_capacity_commitment), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.delete_capacity_commitment(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.DeleteCapacityCommitmentRequest( - name='name_value', - ) - -def test_delete_capacity_commitment_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.delete_capacity_commitment in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.delete_capacity_commitment] = mock_rpc - request = {} - client.delete_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.delete_capacity_commitment(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_delete_capacity_commitment_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.delete_capacity_commitment in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.AsyncMock() - mock_rpc.return_value = mock.Mock() - client._client._transport._wrapped_methods[client._client._transport.delete_capacity_commitment] = mock_rpc - - request = {} - await client.delete_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - await client.delete_capacity_commitment(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_delete_capacity_commitment_async(transport: str = 'grpc_asyncio', request_type=reservation.DeleteCapacityCommitmentRequest): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - 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_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - response = await client.delete_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = reservation.DeleteCapacityCommitmentRequest() - 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_capacity_commitment_async_from_dict(): - await test_delete_capacity_commitment_async(request_type=dict) - -def test_delete_capacity_commitment_field_headers(): - client = ReservationServiceClient( - 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 = reservation.DeleteCapacityCommitmentRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_capacity_commitment), - '__call__') as call: - call.return_value = None - client.delete_capacity_commitment(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_capacity_commitment_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # 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 = reservation.DeleteCapacityCommitmentRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_capacity_commitment), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - await client.delete_capacity_commitment(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_capacity_commitment_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = None - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.delete_capacity_commitment( - 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_capacity_commitment_flattened_error(): - client = ReservationServiceClient( - 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_capacity_commitment( - reservation.DeleteCapacityCommitmentRequest(), - name='name_value', - ) - -@pytest.mark.asyncio -async def test_delete_capacity_commitment_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = None - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.delete_capacity_commitment( - 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_capacity_commitment_flattened_error_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.delete_capacity_commitment( - reservation.DeleteCapacityCommitmentRequest(), - name='name_value', - ) - - -@pytest.mark.parametrize("request_type", [ - reservation.UpdateCapacityCommitmentRequest, - dict, -]) -def test_update_capacity_commitment(request_type, transport: str = 'grpc'): - client = ReservationServiceClient( - 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_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.CapacityCommitment( - name='name_value', - slot_count=1098, - plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - state=reservation.CapacityCommitment.State.PENDING, - renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - multi_region_auxiliary=True, - edition=reservation.Edition.STANDARD, - is_flat_rate=True, - ) - response = client.update_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = reservation.UpdateCapacityCommitmentRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.CapacityCommitment) - assert response.name == 'name_value' - assert response.slot_count == 1098 - assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.state == reservation.CapacityCommitment.State.PENDING - assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.multi_region_auxiliary is True - assert response.edition == reservation.Edition.STANDARD - assert response.is_flat_rate is True - - -def test_update_capacity_commitment_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = reservation.UpdateCapacityCommitmentRequest( - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_capacity_commitment), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.update_capacity_commitment(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.UpdateCapacityCommitmentRequest( - ) - -def test_update_capacity_commitment_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.update_capacity_commitment in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.update_capacity_commitment] = mock_rpc - request = {} - client.update_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.update_capacity_commitment(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_update_capacity_commitment_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.update_capacity_commitment in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.AsyncMock() - mock_rpc.return_value = mock.Mock() - client._client._transport._wrapped_methods[client._client._transport.update_capacity_commitment] = mock_rpc - - request = {} - await client.update_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - await client.update_capacity_commitment(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_update_capacity_commitment_async(transport: str = 'grpc_asyncio', request_type=reservation.UpdateCapacityCommitmentRequest): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - 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_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment( - name='name_value', - slot_count=1098, - plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - state=reservation.CapacityCommitment.State.PENDING, - renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - multi_region_auxiliary=True, - edition=reservation.Edition.STANDARD, - is_flat_rate=True, - )) - response = await client.update_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = reservation.UpdateCapacityCommitmentRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.CapacityCommitment) - assert response.name == 'name_value' - assert response.slot_count == 1098 - assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.state == reservation.CapacityCommitment.State.PENDING - assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.multi_region_auxiliary is True - assert response.edition == reservation.Edition.STANDARD - assert response.is_flat_rate is True - - -@pytest.mark.asyncio -async def test_update_capacity_commitment_async_from_dict(): - await test_update_capacity_commitment_async(request_type=dict) - -def test_update_capacity_commitment_field_headers(): - client = ReservationServiceClient( - 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 = reservation.UpdateCapacityCommitmentRequest() - - request.capacity_commitment.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_capacity_commitment), - '__call__') as call: - call.return_value = reservation.CapacityCommitment() - client.update_capacity_commitment(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', - 'capacity_commitment.name=name_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_update_capacity_commitment_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # 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 = reservation.UpdateCapacityCommitmentRequest() - - request.capacity_commitment.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_capacity_commitment), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment()) - await client.update_capacity_commitment(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', - 'capacity_commitment.name=name_value', - ) in kw['metadata'] - - -def test_update_capacity_commitment_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.CapacityCommitment() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.update_capacity_commitment( - capacity_commitment=reservation.CapacityCommitment(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].capacity_commitment - mock_val = reservation.CapacityCommitment(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_capacity_commitment_flattened_error(): - client = ReservationServiceClient( - 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_capacity_commitment( - reservation.UpdateCapacityCommitmentRequest(), - capacity_commitment=reservation.CapacityCommitment(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - -@pytest.mark.asyncio -async def test_update_capacity_commitment_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.CapacityCommitment() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.update_capacity_commitment( - capacity_commitment=reservation.CapacityCommitment(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].capacity_commitment - mock_val = reservation.CapacityCommitment(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_capacity_commitment_flattened_error_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.update_capacity_commitment( - reservation.UpdateCapacityCommitmentRequest(), - capacity_commitment=reservation.CapacityCommitment(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -@pytest.mark.parametrize("request_type", [ - reservation.SplitCapacityCommitmentRequest, - dict, -]) -def test_split_capacity_commitment(request_type, transport: str = 'grpc'): - client = ReservationServiceClient( - 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.split_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.SplitCapacityCommitmentResponse( - ) - response = client.split_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = reservation.SplitCapacityCommitmentRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.SplitCapacityCommitmentResponse) - - -def test_split_capacity_commitment_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = reservation.SplitCapacityCommitmentRequest( - name='name_value', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.split_capacity_commitment), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.split_capacity_commitment(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.SplitCapacityCommitmentRequest( - name='name_value', - ) - -def test_split_capacity_commitment_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.split_capacity_commitment in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.split_capacity_commitment] = mock_rpc - request = {} - client.split_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.split_capacity_commitment(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_split_capacity_commitment_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.split_capacity_commitment in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.AsyncMock() - mock_rpc.return_value = mock.Mock() - client._client._transport._wrapped_methods[client._client._transport.split_capacity_commitment] = mock_rpc - - request = {} - await client.split_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - await client.split_capacity_commitment(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_split_capacity_commitment_async(transport: str = 'grpc_asyncio', request_type=reservation.SplitCapacityCommitmentRequest): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - 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.split_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.SplitCapacityCommitmentResponse( - )) - response = await client.split_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = reservation.SplitCapacityCommitmentRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.SplitCapacityCommitmentResponse) - - -@pytest.mark.asyncio -async def test_split_capacity_commitment_async_from_dict(): - await test_split_capacity_commitment_async(request_type=dict) - -def test_split_capacity_commitment_field_headers(): - client = ReservationServiceClient( - 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 = reservation.SplitCapacityCommitmentRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.split_capacity_commitment), - '__call__') as call: - call.return_value = reservation.SplitCapacityCommitmentResponse() - client.split_capacity_commitment(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_split_capacity_commitment_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # 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 = reservation.SplitCapacityCommitmentRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.split_capacity_commitment), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.SplitCapacityCommitmentResponse()) - await client.split_capacity_commitment(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_split_capacity_commitment_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.split_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.SplitCapacityCommitmentResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.split_capacity_commitment( - name='name_value', - slot_count=1098, - ) - - # 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 - arg = args[0].slot_count - mock_val = 1098 - assert arg == mock_val - - -def test_split_capacity_commitment_flattened_error(): - client = ReservationServiceClient( - 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.split_capacity_commitment( - reservation.SplitCapacityCommitmentRequest(), - name='name_value', - slot_count=1098, - ) - -@pytest.mark.asyncio -async def test_split_capacity_commitment_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.split_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.SplitCapacityCommitmentResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.SplitCapacityCommitmentResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.split_capacity_commitment( - name='name_value', - slot_count=1098, - ) - - # 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 - arg = args[0].slot_count - mock_val = 1098 - assert arg == mock_val - -@pytest.mark.asyncio -async def test_split_capacity_commitment_flattened_error_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.split_capacity_commitment( - reservation.SplitCapacityCommitmentRequest(), - name='name_value', - slot_count=1098, - ) - - -@pytest.mark.parametrize("request_type", [ - reservation.MergeCapacityCommitmentsRequest, - dict, -]) -def test_merge_capacity_commitments(request_type, transport: str = 'grpc'): - client = ReservationServiceClient( - 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.merge_capacity_commitments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.CapacityCommitment( - name='name_value', - slot_count=1098, - plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - state=reservation.CapacityCommitment.State.PENDING, - renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - multi_region_auxiliary=True, - edition=reservation.Edition.STANDARD, - is_flat_rate=True, - ) - response = client.merge_capacity_commitments(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = reservation.MergeCapacityCommitmentsRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.CapacityCommitment) - assert response.name == 'name_value' - assert response.slot_count == 1098 - assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.state == reservation.CapacityCommitment.State.PENDING - assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.multi_region_auxiliary is True - assert response.edition == reservation.Edition.STANDARD - assert response.is_flat_rate is True - - -def test_merge_capacity_commitments_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = reservation.MergeCapacityCommitmentsRequest( - parent='parent_value', - capacity_commitment_id='capacity_commitment_id_value', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.merge_capacity_commitments), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.merge_capacity_commitments(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.MergeCapacityCommitmentsRequest( - parent='parent_value', - capacity_commitment_id='capacity_commitment_id_value', - ) - -def test_merge_capacity_commitments_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.merge_capacity_commitments in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.merge_capacity_commitments] = mock_rpc - request = {} - client.merge_capacity_commitments(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.merge_capacity_commitments(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_merge_capacity_commitments_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.merge_capacity_commitments in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.AsyncMock() - mock_rpc.return_value = mock.Mock() - client._client._transport._wrapped_methods[client._client._transport.merge_capacity_commitments] = mock_rpc - - request = {} - await client.merge_capacity_commitments(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - await client.merge_capacity_commitments(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_merge_capacity_commitments_async(transport: str = 'grpc_asyncio', request_type=reservation.MergeCapacityCommitmentsRequest): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - 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.merge_capacity_commitments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment( - name='name_value', - slot_count=1098, - plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - state=reservation.CapacityCommitment.State.PENDING, - renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - multi_region_auxiliary=True, - edition=reservation.Edition.STANDARD, - is_flat_rate=True, - )) - response = await client.merge_capacity_commitments(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = reservation.MergeCapacityCommitmentsRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.CapacityCommitment) - assert response.name == 'name_value' - assert response.slot_count == 1098 - assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.state == reservation.CapacityCommitment.State.PENDING - assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.multi_region_auxiliary is True - assert response.edition == reservation.Edition.STANDARD - assert response.is_flat_rate is True - - -@pytest.mark.asyncio -async def test_merge_capacity_commitments_async_from_dict(): - await test_merge_capacity_commitments_async(request_type=dict) - -def test_merge_capacity_commitments_field_headers(): - client = ReservationServiceClient( - 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 = reservation.MergeCapacityCommitmentsRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.merge_capacity_commitments), - '__call__') as call: - call.return_value = reservation.CapacityCommitment() - client.merge_capacity_commitments(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_merge_capacity_commitments_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # 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 = reservation.MergeCapacityCommitmentsRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.merge_capacity_commitments), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment()) - await client.merge_capacity_commitments(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_merge_capacity_commitments_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.merge_capacity_commitments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.CapacityCommitment() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.merge_capacity_commitments( - parent='parent_value', - capacity_commitment_ids=['capacity_commitment_ids_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].capacity_commitment_ids - mock_val = ['capacity_commitment_ids_value'] - assert arg == mock_val - - -def test_merge_capacity_commitments_flattened_error(): - client = ReservationServiceClient( - 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.merge_capacity_commitments( - reservation.MergeCapacityCommitmentsRequest(), - parent='parent_value', - capacity_commitment_ids=['capacity_commitment_ids_value'], - ) - -@pytest.mark.asyncio -async def test_merge_capacity_commitments_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.merge_capacity_commitments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.CapacityCommitment() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.merge_capacity_commitments( - parent='parent_value', - capacity_commitment_ids=['capacity_commitment_ids_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].capacity_commitment_ids - mock_val = ['capacity_commitment_ids_value'] - assert arg == mock_val - -@pytest.mark.asyncio -async def test_merge_capacity_commitments_flattened_error_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.merge_capacity_commitments( - reservation.MergeCapacityCommitmentsRequest(), - parent='parent_value', - capacity_commitment_ids=['capacity_commitment_ids_value'], - ) - - -@pytest.mark.parametrize("request_type", [ - reservation.CreateAssignmentRequest, - dict, -]) -def test_create_assignment(request_type, transport: str = 'grpc'): - client = ReservationServiceClient( - 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_assignment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.Assignment( - name='name_value', - assignee='assignee_value', - job_type=reservation.Assignment.JobType.PIPELINE, - state=reservation.Assignment.State.PENDING, - enable_gemini_in_bigquery=True, - ) - response = client.create_assignment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = reservation.CreateAssignmentRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.Assignment) - assert response.name == 'name_value' - assert response.assignee == 'assignee_value' - assert response.job_type == reservation.Assignment.JobType.PIPELINE - assert response.state == reservation.Assignment.State.PENDING - assert response.enable_gemini_in_bigquery is True - - -def test_create_assignment_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = reservation.CreateAssignmentRequest( - parent='parent_value', - assignment_id='assignment_id_value', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_assignment), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.create_assignment(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.CreateAssignmentRequest( - parent='parent_value', - assignment_id='assignment_id_value', - ) - -def test_create_assignment_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.create_assignment in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.create_assignment] = mock_rpc - request = {} - client.create_assignment(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.create_assignment(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_create_assignment_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.create_assignment in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.AsyncMock() - mock_rpc.return_value = mock.Mock() - client._client._transport._wrapped_methods[client._client._transport.create_assignment] = mock_rpc - - request = {} - await client.create_assignment(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - await client.create_assignment(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_create_assignment_async(transport: str = 'grpc_asyncio', request_type=reservation.CreateAssignmentRequest): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - 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_assignment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment( - name='name_value', - assignee='assignee_value', - job_type=reservation.Assignment.JobType.PIPELINE, - state=reservation.Assignment.State.PENDING, - enable_gemini_in_bigquery=True, - )) - response = await client.create_assignment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = reservation.CreateAssignmentRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.Assignment) - assert response.name == 'name_value' - assert response.assignee == 'assignee_value' - assert response.job_type == reservation.Assignment.JobType.PIPELINE - assert response.state == reservation.Assignment.State.PENDING - assert response.enable_gemini_in_bigquery is True - - -@pytest.mark.asyncio -async def test_create_assignment_async_from_dict(): - await test_create_assignment_async(request_type=dict) - -def test_create_assignment_field_headers(): - client = ReservationServiceClient( - 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 = reservation.CreateAssignmentRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_assignment), - '__call__') as call: - call.return_value = reservation.Assignment() - client.create_assignment(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_assignment_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # 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 = reservation.CreateAssignmentRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_assignment), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment()) - await client.create_assignment(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_assignment_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_assignment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.Assignment() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.create_assignment( - parent='parent_value', - assignment=reservation.Assignment(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].parent - mock_val = 'parent_value' - assert arg == mock_val - arg = args[0].assignment - mock_val = reservation.Assignment(name='name_value') - assert arg == mock_val - - -def test_create_assignment_flattened_error(): - client = ReservationServiceClient( - 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_assignment( - reservation.CreateAssignmentRequest(), - parent='parent_value', - assignment=reservation.Assignment(name='name_value'), - ) - -@pytest.mark.asyncio -async def test_create_assignment_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_assignment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.Assignment() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.create_assignment( - parent='parent_value', - assignment=reservation.Assignment(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].parent - mock_val = 'parent_value' - assert arg == mock_val - arg = args[0].assignment - mock_val = reservation.Assignment(name='name_value') - assert arg == mock_val - -@pytest.mark.asyncio -async def test_create_assignment_flattened_error_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.create_assignment( - reservation.CreateAssignmentRequest(), - parent='parent_value', - assignment=reservation.Assignment(name='name_value'), - ) - - -@pytest.mark.parametrize("request_type", [ - reservation.ListAssignmentsRequest, - dict, -]) -def test_list_assignments(request_type, transport: str = 'grpc'): - client = ReservationServiceClient( - 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_assignments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.ListAssignmentsResponse( - next_page_token='next_page_token_value', - ) - response = client.list_assignments(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = reservation.ListAssignmentsRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListAssignmentsPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_list_assignments_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = reservation.ListAssignmentsRequest( - parent='parent_value', - page_token='page_token_value', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_assignments), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.list_assignments(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.ListAssignmentsRequest( - parent='parent_value', - page_token='page_token_value', - ) - -def test_list_assignments_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.list_assignments in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.list_assignments] = mock_rpc - request = {} - client.list_assignments(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.list_assignments(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_list_assignments_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.list_assignments in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.AsyncMock() - mock_rpc.return_value = mock.Mock() - client._client._transport._wrapped_methods[client._client._transport.list_assignments] = mock_rpc - - request = {} - await client.list_assignments(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - await client.list_assignments(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_list_assignments_async(transport: str = 'grpc_asyncio', request_type=reservation.ListAssignmentsRequest): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - 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_assignments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListAssignmentsResponse( - next_page_token='next_page_token_value', - )) - response = await client.list_assignments(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = reservation.ListAssignmentsRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListAssignmentsAsyncPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.asyncio -async def test_list_assignments_async_from_dict(): - await test_list_assignments_async(request_type=dict) - -def test_list_assignments_field_headers(): - client = ReservationServiceClient( - 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 = reservation.ListAssignmentsRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_assignments), - '__call__') as call: - call.return_value = reservation.ListAssignmentsResponse() - client.list_assignments(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_assignments_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # 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 = reservation.ListAssignmentsRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_assignments), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListAssignmentsResponse()) - await client.list_assignments(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_assignments_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_assignments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.ListAssignmentsResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.list_assignments( - 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_assignments_flattened_error(): - client = ReservationServiceClient( - 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_assignments( - reservation.ListAssignmentsRequest(), - parent='parent_value', - ) - -@pytest.mark.asyncio -async def test_list_assignments_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_assignments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.ListAssignmentsResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListAssignmentsResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.list_assignments( - 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_assignments_flattened_error_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.list_assignments( - reservation.ListAssignmentsRequest(), - parent='parent_value', - ) - - -def test_list_assignments_pager(transport_name: str = "grpc"): - client = ReservationServiceClient( - 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_assignments), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.ListAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - reservation.Assignment(), - ], - next_page_token='abc', - ), - reservation.ListAssignmentsResponse( - assignments=[], - next_page_token='def', - ), - reservation.ListAssignmentsResponse( - assignments=[ - reservation.Assignment(), - ], - next_page_token='ghi', - ), - reservation.ListAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - ], - ), - RuntimeError, - ) - - expected_metadata = () - retry = retries.Retry() - timeout = 5 - expected_metadata = tuple(expected_metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('parent', ''), - )), - ) - pager = client.list_assignments(request={}, retry=retry, timeout=timeout) - - assert pager._metadata == expected_metadata - assert pager._retry == retry - assert pager._timeout == timeout - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, reservation.Assignment) - for i in results) -def test_list_assignments_pages(transport_name: str = "grpc"): - client = ReservationServiceClient( - 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_assignments), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.ListAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - reservation.Assignment(), - ], - next_page_token='abc', - ), - reservation.ListAssignmentsResponse( - assignments=[], - next_page_token='def', - ), - reservation.ListAssignmentsResponse( - assignments=[ - reservation.Assignment(), - ], - next_page_token='ghi', - ), - reservation.ListAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - ], - ), - RuntimeError, - ) - pages = list(client.list_assignments(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_assignments_async_pager(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_assignments), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.ListAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - reservation.Assignment(), - ], - next_page_token='abc', - ), - reservation.ListAssignmentsResponse( - assignments=[], - next_page_token='def', - ), - reservation.ListAssignmentsResponse( - assignments=[ - reservation.Assignment(), - ], - next_page_token='ghi', - ), - reservation.ListAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - ], - ), - RuntimeError, - ) - async_pager = await client.list_assignments(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, reservation.Assignment) - for i in responses) - - -@pytest.mark.asyncio -async def test_list_assignments_async_pages(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_assignments), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.ListAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - reservation.Assignment(), - ], - next_page_token='abc', - ), - reservation.ListAssignmentsResponse( - assignments=[], - next_page_token='def', - ), - reservation.ListAssignmentsResponse( - assignments=[ - reservation.Assignment(), - ], - next_page_token='ghi', - ), - reservation.ListAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - ], - ), - RuntimeError, - ) - pages = [] - # Workaround issue in python 3.9 related to code coverage by adding `# pragma: no branch` - # See https://github.com/googleapis/gapic-generator-python/pull/1174#issuecomment-1025132372 - async for page_ in ( # pragma: no branch - await client.list_assignments(request={}) - ).pages: - 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", [ - reservation.DeleteAssignmentRequest, - dict, -]) -def test_delete_assignment(request_type, transport: str = 'grpc'): - client = ReservationServiceClient( - 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_assignment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = None - response = client.delete_assignment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = reservation.DeleteAssignmentRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert response is None - - -def test_delete_assignment_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = reservation.DeleteAssignmentRequest( - name='name_value', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_assignment), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.delete_assignment(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.DeleteAssignmentRequest( - name='name_value', - ) - -def test_delete_assignment_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.delete_assignment in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.delete_assignment] = mock_rpc - request = {} - client.delete_assignment(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.delete_assignment(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_delete_assignment_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.delete_assignment in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.AsyncMock() - mock_rpc.return_value = mock.Mock() - client._client._transport._wrapped_methods[client._client._transport.delete_assignment] = mock_rpc - - request = {} - await client.delete_assignment(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - await client.delete_assignment(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_delete_assignment_async(transport: str = 'grpc_asyncio', request_type=reservation.DeleteAssignmentRequest): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - 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_assignment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - response = await client.delete_assignment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = reservation.DeleteAssignmentRequest() - 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_assignment_async_from_dict(): - await test_delete_assignment_async(request_type=dict) - -def test_delete_assignment_field_headers(): - client = ReservationServiceClient( - 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 = reservation.DeleteAssignmentRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_assignment), - '__call__') as call: - call.return_value = None - client.delete_assignment(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_assignment_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # 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 = reservation.DeleteAssignmentRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_assignment), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - await client.delete_assignment(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_assignment_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_assignment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = None - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.delete_assignment( - 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_assignment_flattened_error(): - client = ReservationServiceClient( - 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_assignment( - reservation.DeleteAssignmentRequest(), - name='name_value', - ) - -@pytest.mark.asyncio -async def test_delete_assignment_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_assignment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = None - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.delete_assignment( - 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_assignment_flattened_error_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.delete_assignment( - reservation.DeleteAssignmentRequest(), - name='name_value', - ) - - -@pytest.mark.parametrize("request_type", [ - reservation.SearchAssignmentsRequest, - dict, -]) -def test_search_assignments(request_type, transport: str = 'grpc'): - client = ReservationServiceClient( - 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.search_assignments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.SearchAssignmentsResponse( - next_page_token='next_page_token_value', - ) - response = client.search_assignments(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = reservation.SearchAssignmentsRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.SearchAssignmentsPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_search_assignments_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = reservation.SearchAssignmentsRequest( - parent='parent_value', - query='query_value', - page_token='page_token_value', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_assignments), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.search_assignments(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.SearchAssignmentsRequest( - parent='parent_value', - query='query_value', - page_token='page_token_value', - ) - -def test_search_assignments_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.search_assignments in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.search_assignments] = mock_rpc - request = {} - client.search_assignments(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.search_assignments(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_search_assignments_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.search_assignments in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.AsyncMock() - mock_rpc.return_value = mock.Mock() - client._client._transport._wrapped_methods[client._client._transport.search_assignments] = mock_rpc - - request = {} - await client.search_assignments(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - await client.search_assignments(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_search_assignments_async(transport: str = 'grpc_asyncio', request_type=reservation.SearchAssignmentsRequest): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - 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.search_assignments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.SearchAssignmentsResponse( - next_page_token='next_page_token_value', - )) - response = await client.search_assignments(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = reservation.SearchAssignmentsRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.SearchAssignmentsAsyncPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.asyncio -async def test_search_assignments_async_from_dict(): - await test_search_assignments_async(request_type=dict) - -def test_search_assignments_field_headers(): - client = ReservationServiceClient( - 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 = reservation.SearchAssignmentsRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_assignments), - '__call__') as call: - call.return_value = reservation.SearchAssignmentsResponse() - client.search_assignments(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_search_assignments_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # 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 = reservation.SearchAssignmentsRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_assignments), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.SearchAssignmentsResponse()) - await client.search_assignments(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_search_assignments_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_assignments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.SearchAssignmentsResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.search_assignments( - parent='parent_value', - query='query_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].query - mock_val = 'query_value' - assert arg == mock_val - - -def test_search_assignments_flattened_error(): - client = ReservationServiceClient( - 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.search_assignments( - reservation.SearchAssignmentsRequest(), - parent='parent_value', - query='query_value', - ) - -@pytest.mark.asyncio -async def test_search_assignments_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_assignments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.SearchAssignmentsResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.SearchAssignmentsResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.search_assignments( - parent='parent_value', - query='query_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].query - mock_val = 'query_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_search_assignments_flattened_error_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.search_assignments( - reservation.SearchAssignmentsRequest(), - parent='parent_value', - query='query_value', - ) - - -def test_search_assignments_pager(transport_name: str = "grpc"): - client = ReservationServiceClient( - 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.search_assignments), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.SearchAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - reservation.Assignment(), - ], - next_page_token='abc', - ), - reservation.SearchAssignmentsResponse( - assignments=[], - next_page_token='def', - ), - reservation.SearchAssignmentsResponse( - assignments=[ - reservation.Assignment(), - ], - next_page_token='ghi', - ), - reservation.SearchAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - ], - ), - RuntimeError, - ) - - expected_metadata = () - retry = retries.Retry() - timeout = 5 - expected_metadata = tuple(expected_metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('parent', ''), - )), - ) - pager = client.search_assignments(request={}, retry=retry, timeout=timeout) - - assert pager._metadata == expected_metadata - assert pager._retry == retry - assert pager._timeout == timeout - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, reservation.Assignment) - for i in results) -def test_search_assignments_pages(transport_name: str = "grpc"): - client = ReservationServiceClient( - 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.search_assignments), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.SearchAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - reservation.Assignment(), - ], - next_page_token='abc', - ), - reservation.SearchAssignmentsResponse( - assignments=[], - next_page_token='def', - ), - reservation.SearchAssignmentsResponse( - assignments=[ - reservation.Assignment(), - ], - next_page_token='ghi', - ), - reservation.SearchAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - ], - ), - RuntimeError, - ) - pages = list(client.search_assignments(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_search_assignments_async_pager(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_assignments), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.SearchAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - reservation.Assignment(), - ], - next_page_token='abc', - ), - reservation.SearchAssignmentsResponse( - assignments=[], - next_page_token='def', - ), - reservation.SearchAssignmentsResponse( - assignments=[ - reservation.Assignment(), - ], - next_page_token='ghi', - ), - reservation.SearchAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - ], - ), - RuntimeError, - ) - async_pager = await client.search_assignments(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, reservation.Assignment) - for i in responses) - - -@pytest.mark.asyncio -async def test_search_assignments_async_pages(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_assignments), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.SearchAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - reservation.Assignment(), - ], - next_page_token='abc', - ), - reservation.SearchAssignmentsResponse( - assignments=[], - next_page_token='def', - ), - reservation.SearchAssignmentsResponse( - assignments=[ - reservation.Assignment(), - ], - next_page_token='ghi', - ), - reservation.SearchAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - ], - ), - RuntimeError, - ) - pages = [] - # Workaround issue in python 3.9 related to code coverage by adding `# pragma: no branch` - # See https://github.com/googleapis/gapic-generator-python/pull/1174#issuecomment-1025132372 - async for page_ in ( # pragma: no branch - await client.search_assignments(request={}) - ).pages: - 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", [ - reservation.SearchAllAssignmentsRequest, - dict, -]) -def test_search_all_assignments(request_type, transport: str = 'grpc'): - client = ReservationServiceClient( - 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.search_all_assignments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.SearchAllAssignmentsResponse( - next_page_token='next_page_token_value', - ) - response = client.search_all_assignments(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = reservation.SearchAllAssignmentsRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.SearchAllAssignmentsPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_search_all_assignments_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = reservation.SearchAllAssignmentsRequest( - parent='parent_value', - query='query_value', - page_token='page_token_value', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_all_assignments), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.search_all_assignments(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.SearchAllAssignmentsRequest( - parent='parent_value', - query='query_value', - page_token='page_token_value', - ) - -def test_search_all_assignments_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.search_all_assignments in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.search_all_assignments] = mock_rpc - request = {} - client.search_all_assignments(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.search_all_assignments(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_search_all_assignments_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.search_all_assignments in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.AsyncMock() - mock_rpc.return_value = mock.Mock() - client._client._transport._wrapped_methods[client._client._transport.search_all_assignments] = mock_rpc - - request = {} - await client.search_all_assignments(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - await client.search_all_assignments(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_search_all_assignments_async(transport: str = 'grpc_asyncio', request_type=reservation.SearchAllAssignmentsRequest): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - 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.search_all_assignments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.SearchAllAssignmentsResponse( - next_page_token='next_page_token_value', - )) - response = await client.search_all_assignments(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = reservation.SearchAllAssignmentsRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.SearchAllAssignmentsAsyncPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.asyncio -async def test_search_all_assignments_async_from_dict(): - await test_search_all_assignments_async(request_type=dict) - -def test_search_all_assignments_field_headers(): - client = ReservationServiceClient( - 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 = reservation.SearchAllAssignmentsRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_all_assignments), - '__call__') as call: - call.return_value = reservation.SearchAllAssignmentsResponse() - client.search_all_assignments(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_search_all_assignments_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # 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 = reservation.SearchAllAssignmentsRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_all_assignments), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.SearchAllAssignmentsResponse()) - await client.search_all_assignments(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_search_all_assignments_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_all_assignments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.SearchAllAssignmentsResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.search_all_assignments( - parent='parent_value', - query='query_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].query - mock_val = 'query_value' - assert arg == mock_val - - -def test_search_all_assignments_flattened_error(): - client = ReservationServiceClient( - 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.search_all_assignments( - reservation.SearchAllAssignmentsRequest(), - parent='parent_value', - query='query_value', - ) - -@pytest.mark.asyncio -async def test_search_all_assignments_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_all_assignments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.SearchAllAssignmentsResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.SearchAllAssignmentsResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.search_all_assignments( - parent='parent_value', - query='query_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].query - mock_val = 'query_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_search_all_assignments_flattened_error_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.search_all_assignments( - reservation.SearchAllAssignmentsRequest(), - parent='parent_value', - query='query_value', - ) - - -def test_search_all_assignments_pager(transport_name: str = "grpc"): - client = ReservationServiceClient( - 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.search_all_assignments), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.SearchAllAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - reservation.Assignment(), - ], - next_page_token='abc', - ), - reservation.SearchAllAssignmentsResponse( - assignments=[], - next_page_token='def', - ), - reservation.SearchAllAssignmentsResponse( - assignments=[ - reservation.Assignment(), - ], - next_page_token='ghi', - ), - reservation.SearchAllAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - ], - ), - RuntimeError, - ) - - expected_metadata = () - retry = retries.Retry() - timeout = 5 - expected_metadata = tuple(expected_metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('parent', ''), - )), - ) - pager = client.search_all_assignments(request={}, retry=retry, timeout=timeout) - - assert pager._metadata == expected_metadata - assert pager._retry == retry - assert pager._timeout == timeout - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, reservation.Assignment) - for i in results) -def test_search_all_assignments_pages(transport_name: str = "grpc"): - client = ReservationServiceClient( - 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.search_all_assignments), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.SearchAllAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - reservation.Assignment(), - ], - next_page_token='abc', - ), - reservation.SearchAllAssignmentsResponse( - assignments=[], - next_page_token='def', - ), - reservation.SearchAllAssignmentsResponse( - assignments=[ - reservation.Assignment(), - ], - next_page_token='ghi', - ), - reservation.SearchAllAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - ], - ), - RuntimeError, - ) - pages = list(client.search_all_assignments(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_search_all_assignments_async_pager(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_all_assignments), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.SearchAllAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - reservation.Assignment(), - ], - next_page_token='abc', - ), - reservation.SearchAllAssignmentsResponse( - assignments=[], - next_page_token='def', - ), - reservation.SearchAllAssignmentsResponse( - assignments=[ - reservation.Assignment(), - ], - next_page_token='ghi', - ), - reservation.SearchAllAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - ], - ), - RuntimeError, - ) - async_pager = await client.search_all_assignments(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, reservation.Assignment) - for i in responses) - - -@pytest.mark.asyncio -async def test_search_all_assignments_async_pages(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.search_all_assignments), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.SearchAllAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - reservation.Assignment(), - ], - next_page_token='abc', - ), - reservation.SearchAllAssignmentsResponse( - assignments=[], - next_page_token='def', - ), - reservation.SearchAllAssignmentsResponse( - assignments=[ - reservation.Assignment(), - ], - next_page_token='ghi', - ), - reservation.SearchAllAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - ], - ), - RuntimeError, - ) - pages = [] - # Workaround issue in python 3.9 related to code coverage by adding `# pragma: no branch` - # See https://github.com/googleapis/gapic-generator-python/pull/1174#issuecomment-1025132372 - async for page_ in ( # pragma: no branch - await client.search_all_assignments(request={}) - ).pages: - 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", [ - reservation.MoveAssignmentRequest, - dict, -]) -def test_move_assignment(request_type, transport: str = 'grpc'): - client = ReservationServiceClient( - 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.move_assignment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.Assignment( - name='name_value', - assignee='assignee_value', - job_type=reservation.Assignment.JobType.PIPELINE, - state=reservation.Assignment.State.PENDING, - enable_gemini_in_bigquery=True, - ) - response = client.move_assignment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = reservation.MoveAssignmentRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.Assignment) - assert response.name == 'name_value' - assert response.assignee == 'assignee_value' - assert response.job_type == reservation.Assignment.JobType.PIPELINE - assert response.state == reservation.Assignment.State.PENDING - assert response.enable_gemini_in_bigquery is True - - -def test_move_assignment_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = reservation.MoveAssignmentRequest( - name='name_value', - destination_id='destination_id_value', - assignment_id='assignment_id_value', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.move_assignment), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.move_assignment(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.MoveAssignmentRequest( - name='name_value', - destination_id='destination_id_value', - assignment_id='assignment_id_value', - ) - -def test_move_assignment_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.move_assignment in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.move_assignment] = mock_rpc - request = {} - client.move_assignment(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.move_assignment(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_move_assignment_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.move_assignment in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.AsyncMock() - mock_rpc.return_value = mock.Mock() - client._client._transport._wrapped_methods[client._client._transport.move_assignment] = mock_rpc - - request = {} - await client.move_assignment(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - await client.move_assignment(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_move_assignment_async(transport: str = 'grpc_asyncio', request_type=reservation.MoveAssignmentRequest): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - 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.move_assignment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment( - name='name_value', - assignee='assignee_value', - job_type=reservation.Assignment.JobType.PIPELINE, - state=reservation.Assignment.State.PENDING, - enable_gemini_in_bigquery=True, - )) - response = await client.move_assignment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = reservation.MoveAssignmentRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.Assignment) - assert response.name == 'name_value' - assert response.assignee == 'assignee_value' - assert response.job_type == reservation.Assignment.JobType.PIPELINE - assert response.state == reservation.Assignment.State.PENDING - assert response.enable_gemini_in_bigquery is True - - -@pytest.mark.asyncio -async def test_move_assignment_async_from_dict(): - await test_move_assignment_async(request_type=dict) - -def test_move_assignment_field_headers(): - client = ReservationServiceClient( - 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 = reservation.MoveAssignmentRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.move_assignment), - '__call__') as call: - call.return_value = reservation.Assignment() - client.move_assignment(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_move_assignment_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # 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 = reservation.MoveAssignmentRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.move_assignment), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment()) - await client.move_assignment(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_move_assignment_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.move_assignment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.Assignment() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.move_assignment( - name='name_value', - destination_id='destination_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].name - mock_val = 'name_value' - assert arg == mock_val - arg = args[0].destination_id - mock_val = 'destination_id_value' - assert arg == mock_val - - -def test_move_assignment_flattened_error(): - client = ReservationServiceClient( - 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.move_assignment( - reservation.MoveAssignmentRequest(), - name='name_value', - destination_id='destination_id_value', - ) - -@pytest.mark.asyncio -async def test_move_assignment_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.move_assignment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.Assignment() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.move_assignment( - name='name_value', - destination_id='destination_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].name - mock_val = 'name_value' - assert arg == mock_val - arg = args[0].destination_id - mock_val = 'destination_id_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_move_assignment_flattened_error_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.move_assignment( - reservation.MoveAssignmentRequest(), - name='name_value', - destination_id='destination_id_value', - ) - - -@pytest.mark.parametrize("request_type", [ - reservation.UpdateAssignmentRequest, - dict, -]) -def test_update_assignment(request_type, transport: str = 'grpc'): - client = ReservationServiceClient( - 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_assignment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.Assignment( - name='name_value', - assignee='assignee_value', - job_type=reservation.Assignment.JobType.PIPELINE, - state=reservation.Assignment.State.PENDING, - enable_gemini_in_bigquery=True, - ) - response = client.update_assignment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = reservation.UpdateAssignmentRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.Assignment) - assert response.name == 'name_value' - assert response.assignee == 'assignee_value' - assert response.job_type == reservation.Assignment.JobType.PIPELINE - assert response.state == reservation.Assignment.State.PENDING - assert response.enable_gemini_in_bigquery is True - - -def test_update_assignment_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = reservation.UpdateAssignmentRequest( - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_assignment), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.update_assignment(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.UpdateAssignmentRequest( - ) - -def test_update_assignment_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.update_assignment in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.update_assignment] = mock_rpc - request = {} - client.update_assignment(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.update_assignment(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_update_assignment_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.update_assignment in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.AsyncMock() - mock_rpc.return_value = mock.Mock() - client._client._transport._wrapped_methods[client._client._transport.update_assignment] = mock_rpc - - request = {} - await client.update_assignment(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - await client.update_assignment(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_update_assignment_async(transport: str = 'grpc_asyncio', request_type=reservation.UpdateAssignmentRequest): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - 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_assignment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment( - name='name_value', - assignee='assignee_value', - job_type=reservation.Assignment.JobType.PIPELINE, - state=reservation.Assignment.State.PENDING, - enable_gemini_in_bigquery=True, - )) - response = await client.update_assignment(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = reservation.UpdateAssignmentRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.Assignment) - assert response.name == 'name_value' - assert response.assignee == 'assignee_value' - assert response.job_type == reservation.Assignment.JobType.PIPELINE - assert response.state == reservation.Assignment.State.PENDING - assert response.enable_gemini_in_bigquery is True - - -@pytest.mark.asyncio -async def test_update_assignment_async_from_dict(): - await test_update_assignment_async(request_type=dict) - -def test_update_assignment_field_headers(): - client = ReservationServiceClient( - 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 = reservation.UpdateAssignmentRequest() - - request.assignment.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_assignment), - '__call__') as call: - call.return_value = reservation.Assignment() - client.update_assignment(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', - 'assignment.name=name_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_update_assignment_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # 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 = reservation.UpdateAssignmentRequest() - - request.assignment.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_assignment), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment()) - await client.update_assignment(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', - 'assignment.name=name_value', - ) in kw['metadata'] - - -def test_update_assignment_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_assignment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.Assignment() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.update_assignment( - assignment=reservation.Assignment(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].assignment - mock_val = reservation.Assignment(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_assignment_flattened_error(): - client = ReservationServiceClient( - 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_assignment( - reservation.UpdateAssignmentRequest(), - assignment=reservation.Assignment(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - -@pytest.mark.asyncio -async def test_update_assignment_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_assignment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.Assignment() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.update_assignment( - assignment=reservation.Assignment(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].assignment - mock_val = reservation.Assignment(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_assignment_flattened_error_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.update_assignment( - reservation.UpdateAssignmentRequest(), - assignment=reservation.Assignment(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -@pytest.mark.parametrize("request_type", [ - reservation.GetBiReservationRequest, - dict, -]) -def test_get_bi_reservation(request_type, transport: str = 'grpc'): - client = ReservationServiceClient( - 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_bi_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.BiReservation( - name='name_value', - size=443, - ) - response = client.get_bi_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = reservation.GetBiReservationRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.BiReservation) - assert response.name == 'name_value' - assert response.size == 443 - - -def test_get_bi_reservation_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = reservation.GetBiReservationRequest( - name='name_value', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_bi_reservation), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.get_bi_reservation(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.GetBiReservationRequest( - name='name_value', - ) - -def test_get_bi_reservation_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.get_bi_reservation in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.get_bi_reservation] = mock_rpc - request = {} - client.get_bi_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.get_bi_reservation(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_get_bi_reservation_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.get_bi_reservation in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.AsyncMock() - mock_rpc.return_value = mock.Mock() - client._client._transport._wrapped_methods[client._client._transport.get_bi_reservation] = mock_rpc - - request = {} - await client.get_bi_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - await client.get_bi_reservation(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_get_bi_reservation_async(transport: str = 'grpc_asyncio', request_type=reservation.GetBiReservationRequest): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - 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_bi_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.BiReservation( - name='name_value', - size=443, - )) - response = await client.get_bi_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = reservation.GetBiReservationRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.BiReservation) - assert response.name == 'name_value' - assert response.size == 443 - - -@pytest.mark.asyncio -async def test_get_bi_reservation_async_from_dict(): - await test_get_bi_reservation_async(request_type=dict) - -def test_get_bi_reservation_field_headers(): - client = ReservationServiceClient( - 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 = reservation.GetBiReservationRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_bi_reservation), - '__call__') as call: - call.return_value = reservation.BiReservation() - client.get_bi_reservation(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_bi_reservation_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # 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 = reservation.GetBiReservationRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_bi_reservation), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.BiReservation()) - await client.get_bi_reservation(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_bi_reservation_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_bi_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.BiReservation() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_bi_reservation( - 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_bi_reservation_flattened_error(): - client = ReservationServiceClient( - 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_bi_reservation( - reservation.GetBiReservationRequest(), - name='name_value', - ) - -@pytest.mark.asyncio -async def test_get_bi_reservation_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_bi_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.BiReservation() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.BiReservation()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_bi_reservation( - 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_bi_reservation_flattened_error_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.get_bi_reservation( - reservation.GetBiReservationRequest(), - name='name_value', - ) - - -@pytest.mark.parametrize("request_type", [ - reservation.UpdateBiReservationRequest, - dict, -]) -def test_update_bi_reservation(request_type, transport: str = 'grpc'): - client = ReservationServiceClient( - 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_bi_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.BiReservation( - name='name_value', - size=443, - ) - response = client.update_bi_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = reservation.UpdateBiReservationRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.BiReservation) - assert response.name == 'name_value' - assert response.size == 443 - - -def test_update_bi_reservation_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = reservation.UpdateBiReservationRequest( - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_bi_reservation), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.update_bi_reservation(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.UpdateBiReservationRequest( - ) - -def test_update_bi_reservation_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.update_bi_reservation in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.update_bi_reservation] = mock_rpc - request = {} - client.update_bi_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.update_bi_reservation(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_update_bi_reservation_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.update_bi_reservation in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.AsyncMock() - mock_rpc.return_value = mock.Mock() - client._client._transport._wrapped_methods[client._client._transport.update_bi_reservation] = mock_rpc - - request = {} - await client.update_bi_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - await client.update_bi_reservation(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_update_bi_reservation_async(transport: str = 'grpc_asyncio', request_type=reservation.UpdateBiReservationRequest): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - 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_bi_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.BiReservation( - name='name_value', - size=443, - )) - response = await client.update_bi_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = reservation.UpdateBiReservationRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.BiReservation) - assert response.name == 'name_value' - assert response.size == 443 - - -@pytest.mark.asyncio -async def test_update_bi_reservation_async_from_dict(): - await test_update_bi_reservation_async(request_type=dict) - -def test_update_bi_reservation_field_headers(): - client = ReservationServiceClient( - 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 = reservation.UpdateBiReservationRequest() - - request.bi_reservation.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_bi_reservation), - '__call__') as call: - call.return_value = reservation.BiReservation() - client.update_bi_reservation(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', - 'bi_reservation.name=name_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_update_bi_reservation_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # 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 = reservation.UpdateBiReservationRequest() - - request.bi_reservation.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_bi_reservation), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.BiReservation()) - await client.update_bi_reservation(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', - 'bi_reservation.name=name_value', - ) in kw['metadata'] - - -def test_update_bi_reservation_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_bi_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.BiReservation() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.update_bi_reservation( - bi_reservation=reservation.BiReservation(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].bi_reservation - mock_val = reservation.BiReservation(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_bi_reservation_flattened_error(): - client = ReservationServiceClient( - 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_bi_reservation( - reservation.UpdateBiReservationRequest(), - bi_reservation=reservation.BiReservation(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - -@pytest.mark.asyncio -async def test_update_bi_reservation_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_bi_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.BiReservation() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.BiReservation()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.update_bi_reservation( - bi_reservation=reservation.BiReservation(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].bi_reservation - mock_val = reservation.BiReservation(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_bi_reservation_flattened_error_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.update_bi_reservation( - reservation.UpdateBiReservationRequest(), - bi_reservation=reservation.BiReservation(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -@pytest.mark.parametrize("request_type", [ - iam_policy_pb2.GetIamPolicyRequest, - dict, -]) -def test_get_iam_policy(request_type, transport: str = 'grpc'): - client = ReservationServiceClient( - 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_iam_policy), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = policy_pb2.Policy( - version=774, - etag=b'etag_blob', - ) - response = client.get_iam_policy(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = iam_policy_pb2.GetIamPolicyRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, policy_pb2.Policy) - assert response.version == 774 - assert response.etag == b'etag_blob' - - -def test_get_iam_policy_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = iam_policy_pb2.GetIamPolicyRequest( - resource='resource_value', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_iam_policy), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.get_iam_policy(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == iam_policy_pb2.GetIamPolicyRequest( - resource='resource_value', - ) - -def test_get_iam_policy_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.get_iam_policy in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.get_iam_policy] = mock_rpc - request = {} - client.get_iam_policy(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.get_iam_policy(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_get_iam_policy_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.get_iam_policy in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.AsyncMock() - mock_rpc.return_value = mock.Mock() - client._client._transport._wrapped_methods[client._client._transport.get_iam_policy] = mock_rpc - - request = {} - await client.get_iam_policy(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - await client.get_iam_policy(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_get_iam_policy_async(transport: str = 'grpc_asyncio', request_type=iam_policy_pb2.GetIamPolicyRequest): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - 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_iam_policy), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy( - version=774, - etag=b'etag_blob', - )) - response = await client.get_iam_policy(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = iam_policy_pb2.GetIamPolicyRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, policy_pb2.Policy) - assert response.version == 774 - assert response.etag == b'etag_blob' - - -@pytest.mark.asyncio -async def test_get_iam_policy_async_from_dict(): - await test_get_iam_policy_async(request_type=dict) - -def test_get_iam_policy_field_headers(): - client = ReservationServiceClient( - 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 = iam_policy_pb2.GetIamPolicyRequest() - - request.resource = 'resource_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_iam_policy), - '__call__') as call: - call.return_value = policy_pb2.Policy() - client.get_iam_policy(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', - 'resource=resource_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_get_iam_policy_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # 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 = iam_policy_pb2.GetIamPolicyRequest() - - request.resource = 'resource_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_iam_policy), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy()) - await client.get_iam_policy(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', - 'resource=resource_value', - ) in kw['metadata'] - -def test_get_iam_policy_from_dict_foreign(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_iam_policy), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = policy_pb2.Policy() - response = client.get_iam_policy(request={ - 'resource': 'resource_value', - 'options': options_pb2.GetPolicyOptions(requested_policy_version=2598), - } - ) - call.assert_called() - - -def test_get_iam_policy_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_iam_policy), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = policy_pb2.Policy() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_iam_policy( - resource='resource_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].resource - mock_val = 'resource_value' - assert arg == mock_val - - -def test_get_iam_policy_flattened_error(): - client = ReservationServiceClient( - 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_iam_policy( - iam_policy_pb2.GetIamPolicyRequest(), - resource='resource_value', - ) - -@pytest.mark.asyncio -async def test_get_iam_policy_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_iam_policy), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = policy_pb2.Policy() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_iam_policy( - resource='resource_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].resource - mock_val = 'resource_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_get_iam_policy_flattened_error_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.get_iam_policy( - iam_policy_pb2.GetIamPolicyRequest(), - resource='resource_value', - ) - - -@pytest.mark.parametrize("request_type", [ - iam_policy_pb2.SetIamPolicyRequest, - dict, -]) -def test_set_iam_policy(request_type, transport: str = 'grpc'): - client = ReservationServiceClient( - 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.set_iam_policy), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = policy_pb2.Policy( - version=774, - etag=b'etag_blob', - ) - response = client.set_iam_policy(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = iam_policy_pb2.SetIamPolicyRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, policy_pb2.Policy) - assert response.version == 774 - assert response.etag == b'etag_blob' - - -def test_set_iam_policy_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = iam_policy_pb2.SetIamPolicyRequest( - resource='resource_value', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.set_iam_policy), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.set_iam_policy(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == iam_policy_pb2.SetIamPolicyRequest( - resource='resource_value', - ) - -def test_set_iam_policy_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.set_iam_policy in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.set_iam_policy] = mock_rpc - request = {} - client.set_iam_policy(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.set_iam_policy(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_set_iam_policy_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.set_iam_policy in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.AsyncMock() - mock_rpc.return_value = mock.Mock() - client._client._transport._wrapped_methods[client._client._transport.set_iam_policy] = mock_rpc - - request = {} - await client.set_iam_policy(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - await client.set_iam_policy(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_set_iam_policy_async(transport: str = 'grpc_asyncio', request_type=iam_policy_pb2.SetIamPolicyRequest): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - 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.set_iam_policy), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy( - version=774, - etag=b'etag_blob', - )) - response = await client.set_iam_policy(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = iam_policy_pb2.SetIamPolicyRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, policy_pb2.Policy) - assert response.version == 774 - assert response.etag == b'etag_blob' - - -@pytest.mark.asyncio -async def test_set_iam_policy_async_from_dict(): - await test_set_iam_policy_async(request_type=dict) - -def test_set_iam_policy_field_headers(): - client = ReservationServiceClient( - 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 = iam_policy_pb2.SetIamPolicyRequest() - - request.resource = 'resource_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.set_iam_policy), - '__call__') as call: - call.return_value = policy_pb2.Policy() - client.set_iam_policy(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', - 'resource=resource_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_set_iam_policy_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # 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 = iam_policy_pb2.SetIamPolicyRequest() - - request.resource = 'resource_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.set_iam_policy), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy()) - await client.set_iam_policy(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', - 'resource=resource_value', - ) in kw['metadata'] - -def test_set_iam_policy_from_dict_foreign(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.set_iam_policy), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = policy_pb2.Policy() - response = client.set_iam_policy(request={ - 'resource': 'resource_value', - 'policy': policy_pb2.Policy(version=774), - 'update_mask': field_mask_pb2.FieldMask(paths=['paths_value']), - } - ) - call.assert_called() - - -def test_set_iam_policy_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.set_iam_policy), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = policy_pb2.Policy() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.set_iam_policy( - resource='resource_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].resource - mock_val = 'resource_value' - assert arg == mock_val - - -def test_set_iam_policy_flattened_error(): - client = ReservationServiceClient( - 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.set_iam_policy( - iam_policy_pb2.SetIamPolicyRequest(), - resource='resource_value', - ) - -@pytest.mark.asyncio -async def test_set_iam_policy_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.set_iam_policy), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = policy_pb2.Policy() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.set_iam_policy( - resource='resource_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].resource - mock_val = 'resource_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_set_iam_policy_flattened_error_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.set_iam_policy( - iam_policy_pb2.SetIamPolicyRequest(), - resource='resource_value', - ) - - -@pytest.mark.parametrize("request_type", [ - iam_policy_pb2.TestIamPermissionsRequest, - dict, -]) -def test_test_iam_permissions(request_type, transport: str = 'grpc'): - client = ReservationServiceClient( - 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.test_iam_permissions), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = iam_policy_pb2.TestIamPermissionsResponse( - permissions=['permissions_value'], - ) - response = client.test_iam_permissions(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = iam_policy_pb2.TestIamPermissionsRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, iam_policy_pb2.TestIamPermissionsResponse) - assert response.permissions == ['permissions_value'] - - -def test_test_iam_permissions_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = iam_policy_pb2.TestIamPermissionsRequest( - resource='resource_value', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.test_iam_permissions), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.test_iam_permissions(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == iam_policy_pb2.TestIamPermissionsRequest( - resource='resource_value', - ) - -def test_test_iam_permissions_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.test_iam_permissions in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.test_iam_permissions] = mock_rpc - request = {} - client.test_iam_permissions(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.test_iam_permissions(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_test_iam_permissions_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.test_iam_permissions in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.AsyncMock() - mock_rpc.return_value = mock.Mock() - client._client._transport._wrapped_methods[client._client._transport.test_iam_permissions] = mock_rpc - - request = {} - await client.test_iam_permissions(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - await client.test_iam_permissions(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_test_iam_permissions_async(transport: str = 'grpc_asyncio', request_type=iam_policy_pb2.TestIamPermissionsRequest): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - 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.test_iam_permissions), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(iam_policy_pb2.TestIamPermissionsResponse( - permissions=['permissions_value'], - )) - response = await client.test_iam_permissions(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = iam_policy_pb2.TestIamPermissionsRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, iam_policy_pb2.TestIamPermissionsResponse) - assert response.permissions == ['permissions_value'] - - -@pytest.mark.asyncio -async def test_test_iam_permissions_async_from_dict(): - await test_test_iam_permissions_async(request_type=dict) - -def test_test_iam_permissions_field_headers(): - client = ReservationServiceClient( - 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 = iam_policy_pb2.TestIamPermissionsRequest() - - request.resource = 'resource_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.test_iam_permissions), - '__call__') as call: - call.return_value = iam_policy_pb2.TestIamPermissionsResponse() - client.test_iam_permissions(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', - 'resource=resource_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_test_iam_permissions_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # 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 = iam_policy_pb2.TestIamPermissionsRequest() - - request.resource = 'resource_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.test_iam_permissions), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(iam_policy_pb2.TestIamPermissionsResponse()) - await client.test_iam_permissions(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', - 'resource=resource_value', - ) in kw['metadata'] - -def test_test_iam_permissions_from_dict_foreign(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.test_iam_permissions), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = iam_policy_pb2.TestIamPermissionsResponse() - response = client.test_iam_permissions(request={ - 'resource': 'resource_value', - 'permissions': ['permissions_value'], - } - ) - call.assert_called() - - -@pytest.mark.parametrize("request_type", [ - reservation.CreateReservationGroupRequest, - dict, -]) -def test_create_reservation_group(request_type, transport: str = 'grpc'): - client = ReservationServiceClient( - 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_reservation_group), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.ReservationGroup( - name='name_value', - ) - response = client.create_reservation_group(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = reservation.CreateReservationGroupRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.ReservationGroup) - assert response.name == 'name_value' - - -def test_create_reservation_group_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = reservation.CreateReservationGroupRequest( - parent='parent_value', - reservation_group_id='reservation_group_id_value', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_reservation_group), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.create_reservation_group(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.CreateReservationGroupRequest( - parent='parent_value', - reservation_group_id='reservation_group_id_value', - ) - -def test_create_reservation_group_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.create_reservation_group in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.create_reservation_group] = mock_rpc - request = {} - client.create_reservation_group(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.create_reservation_group(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_create_reservation_group_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.create_reservation_group in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.AsyncMock() - mock_rpc.return_value = mock.Mock() - client._client._transport._wrapped_methods[client._client._transport.create_reservation_group] = mock_rpc - - request = {} - await client.create_reservation_group(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - await client.create_reservation_group(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_create_reservation_group_async(transport: str = 'grpc_asyncio', request_type=reservation.CreateReservationGroupRequest): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - 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_reservation_group), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.ReservationGroup( - name='name_value', - )) - response = await client.create_reservation_group(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = reservation.CreateReservationGroupRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.ReservationGroup) - assert response.name == 'name_value' - - -@pytest.mark.asyncio -async def test_create_reservation_group_async_from_dict(): - await test_create_reservation_group_async(request_type=dict) - -def test_create_reservation_group_field_headers(): - client = ReservationServiceClient( - 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 = reservation.CreateReservationGroupRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_reservation_group), - '__call__') as call: - call.return_value = reservation.ReservationGroup() - client.create_reservation_group(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_reservation_group_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # 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 = reservation.CreateReservationGroupRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_reservation_group), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ReservationGroup()) - await client.create_reservation_group(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", [ - reservation.GetReservationGroupRequest, - dict, -]) -def test_get_reservation_group(request_type, transport: str = 'grpc'): - client = ReservationServiceClient( - 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_reservation_group), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.ReservationGroup( - name='name_value', - ) - response = client.get_reservation_group(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = reservation.GetReservationGroupRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.ReservationGroup) - assert response.name == 'name_value' - - -def test_get_reservation_group_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = reservation.GetReservationGroupRequest( - name='name_value', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_reservation_group), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.get_reservation_group(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.GetReservationGroupRequest( - name='name_value', - ) - -def test_get_reservation_group_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.get_reservation_group in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.get_reservation_group] = mock_rpc - request = {} - client.get_reservation_group(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.get_reservation_group(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_get_reservation_group_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.get_reservation_group in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.AsyncMock() - mock_rpc.return_value = mock.Mock() - client._client._transport._wrapped_methods[client._client._transport.get_reservation_group] = mock_rpc - - request = {} - await client.get_reservation_group(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - await client.get_reservation_group(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_get_reservation_group_async(transport: str = 'grpc_asyncio', request_type=reservation.GetReservationGroupRequest): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - 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_reservation_group), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.ReservationGroup( - name='name_value', - )) - response = await client.get_reservation_group(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = reservation.GetReservationGroupRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.ReservationGroup) - assert response.name == 'name_value' - - -@pytest.mark.asyncio -async def test_get_reservation_group_async_from_dict(): - await test_get_reservation_group_async(request_type=dict) - -def test_get_reservation_group_field_headers(): - client = ReservationServiceClient( - 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 = reservation.GetReservationGroupRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_reservation_group), - '__call__') as call: - call.return_value = reservation.ReservationGroup() - client.get_reservation_group(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_reservation_group_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # 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 = reservation.GetReservationGroupRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_reservation_group), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ReservationGroup()) - await client.get_reservation_group(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_reservation_group_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_reservation_group), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.ReservationGroup() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_reservation_group( - 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_reservation_group_flattened_error(): - client = ReservationServiceClient( - 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_reservation_group( - reservation.GetReservationGroupRequest(), - name='name_value', - ) - -@pytest.mark.asyncio -async def test_get_reservation_group_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_reservation_group), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.ReservationGroup() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ReservationGroup()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_reservation_group( - 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_reservation_group_flattened_error_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.get_reservation_group( - reservation.GetReservationGroupRequest(), - name='name_value', - ) - - -@pytest.mark.parametrize("request_type", [ - reservation.DeleteReservationGroupRequest, - dict, -]) -def test_delete_reservation_group(request_type, transport: str = 'grpc'): - client = ReservationServiceClient( - 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_reservation_group), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = None - response = client.delete_reservation_group(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = reservation.DeleteReservationGroupRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert response is None - - -def test_delete_reservation_group_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = reservation.DeleteReservationGroupRequest( - name='name_value', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_reservation_group), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.delete_reservation_group(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.DeleteReservationGroupRequest( - name='name_value', - ) - -def test_delete_reservation_group_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.delete_reservation_group in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.delete_reservation_group] = mock_rpc - request = {} - client.delete_reservation_group(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.delete_reservation_group(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_delete_reservation_group_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.delete_reservation_group in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.AsyncMock() - mock_rpc.return_value = mock.Mock() - client._client._transport._wrapped_methods[client._client._transport.delete_reservation_group] = mock_rpc - - request = {} - await client.delete_reservation_group(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - await client.delete_reservation_group(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_delete_reservation_group_async(transport: str = 'grpc_asyncio', request_type=reservation.DeleteReservationGroupRequest): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - 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_reservation_group), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - response = await client.delete_reservation_group(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = reservation.DeleteReservationGroupRequest() - 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_reservation_group_async_from_dict(): - await test_delete_reservation_group_async(request_type=dict) - -def test_delete_reservation_group_field_headers(): - client = ReservationServiceClient( - 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 = reservation.DeleteReservationGroupRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_reservation_group), - '__call__') as call: - call.return_value = None - client.delete_reservation_group(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_reservation_group_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # 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 = reservation.DeleteReservationGroupRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_reservation_group), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - await client.delete_reservation_group(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_reservation_group_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_reservation_group), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = None - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.delete_reservation_group( - 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_reservation_group_flattened_error(): - client = ReservationServiceClient( - 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_reservation_group( - reservation.DeleteReservationGroupRequest(), - name='name_value', - ) - -@pytest.mark.asyncio -async def test_delete_reservation_group_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_reservation_group), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = None - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.delete_reservation_group( - 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_reservation_group_flattened_error_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.delete_reservation_group( - reservation.DeleteReservationGroupRequest(), - name='name_value', - ) - - -@pytest.mark.parametrize("request_type", [ - reservation.ListReservationGroupsRequest, - dict, -]) -def test_list_reservation_groups(request_type, transport: str = 'grpc'): - client = ReservationServiceClient( - 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_reservation_groups), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.ListReservationGroupsResponse( - next_page_token='next_page_token_value', - ) - response = client.list_reservation_groups(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = reservation.ListReservationGroupsRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListReservationGroupsPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_list_reservation_groups_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = reservation.ListReservationGroupsRequest( - parent='parent_value', - page_token='page_token_value', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_reservation_groups), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.list_reservation_groups(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == reservation.ListReservationGroupsRequest( - parent='parent_value', - page_token='page_token_value', - ) - -def test_list_reservation_groups_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.list_reservation_groups in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.list_reservation_groups] = mock_rpc - request = {} - client.list_reservation_groups(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.list_reservation_groups(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_list_reservation_groups_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.list_reservation_groups in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.AsyncMock() - mock_rpc.return_value = mock.Mock() - client._client._transport._wrapped_methods[client._client._transport.list_reservation_groups] = mock_rpc - - request = {} - await client.list_reservation_groups(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - await client.list_reservation_groups(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_list_reservation_groups_async(transport: str = 'grpc_asyncio', request_type=reservation.ListReservationGroupsRequest): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - 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_reservation_groups), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListReservationGroupsResponse( - next_page_token='next_page_token_value', - )) - response = await client.list_reservation_groups(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = reservation.ListReservationGroupsRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListReservationGroupsAsyncPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.asyncio -async def test_list_reservation_groups_async_from_dict(): - await test_list_reservation_groups_async(request_type=dict) - -def test_list_reservation_groups_field_headers(): - client = ReservationServiceClient( - 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 = reservation.ListReservationGroupsRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_reservation_groups), - '__call__') as call: - call.return_value = reservation.ListReservationGroupsResponse() - client.list_reservation_groups(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_reservation_groups_field_headers_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # 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 = reservation.ListReservationGroupsRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_reservation_groups), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListReservationGroupsResponse()) - await client.list_reservation_groups(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_reservation_groups_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_reservation_groups), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.ListReservationGroupsResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.list_reservation_groups( - 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_reservation_groups_flattened_error(): - client = ReservationServiceClient( - 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_reservation_groups( - reservation.ListReservationGroupsRequest(), - parent='parent_value', - ) - -@pytest.mark.asyncio -async def test_list_reservation_groups_flattened_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_reservation_groups), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = reservation.ListReservationGroupsResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListReservationGroupsResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.list_reservation_groups( - 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_reservation_groups_flattened_error_async(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.list_reservation_groups( - reservation.ListReservationGroupsRequest(), - parent='parent_value', - ) - - -def test_list_reservation_groups_pager(transport_name: str = "grpc"): - client = ReservationServiceClient( - 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_reservation_groups), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.ListReservationGroupsResponse( - reservation_groups=[ - reservation.ReservationGroup(), - reservation.ReservationGroup(), - reservation.ReservationGroup(), - ], - next_page_token='abc', - ), - reservation.ListReservationGroupsResponse( - reservation_groups=[], - next_page_token='def', - ), - reservation.ListReservationGroupsResponse( - reservation_groups=[ - reservation.ReservationGroup(), - ], - next_page_token='ghi', - ), - reservation.ListReservationGroupsResponse( - reservation_groups=[ - reservation.ReservationGroup(), - reservation.ReservationGroup(), - ], - ), - RuntimeError, - ) - - expected_metadata = () - retry = retries.Retry() - timeout = 5 - expected_metadata = tuple(expected_metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('parent', ''), - )), - ) - pager = client.list_reservation_groups(request={}, retry=retry, timeout=timeout) - - assert pager._metadata == expected_metadata - assert pager._retry == retry - assert pager._timeout == timeout - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, reservation.ReservationGroup) - for i in results) -def test_list_reservation_groups_pages(transport_name: str = "grpc"): - client = ReservationServiceClient( - 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_reservation_groups), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.ListReservationGroupsResponse( - reservation_groups=[ - reservation.ReservationGroup(), - reservation.ReservationGroup(), - reservation.ReservationGroup(), - ], - next_page_token='abc', - ), - reservation.ListReservationGroupsResponse( - reservation_groups=[], - next_page_token='def', - ), - reservation.ListReservationGroupsResponse( - reservation_groups=[ - reservation.ReservationGroup(), - ], - next_page_token='ghi', - ), - reservation.ListReservationGroupsResponse( - reservation_groups=[ - reservation.ReservationGroup(), - reservation.ReservationGroup(), - ], - ), - RuntimeError, - ) - pages = list(client.list_reservation_groups(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_reservation_groups_async_pager(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_reservation_groups), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.ListReservationGroupsResponse( - reservation_groups=[ - reservation.ReservationGroup(), - reservation.ReservationGroup(), - reservation.ReservationGroup(), - ], - next_page_token='abc', - ), - reservation.ListReservationGroupsResponse( - reservation_groups=[], - next_page_token='def', - ), - reservation.ListReservationGroupsResponse( - reservation_groups=[ - reservation.ReservationGroup(), - ], - next_page_token='ghi', - ), - reservation.ListReservationGroupsResponse( - reservation_groups=[ - reservation.ReservationGroup(), - reservation.ReservationGroup(), - ], - ), - RuntimeError, - ) - async_pager = await client.list_reservation_groups(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, reservation.ReservationGroup) - for i in responses) - - -@pytest.mark.asyncio -async def test_list_reservation_groups_async_pages(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_reservation_groups), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - reservation.ListReservationGroupsResponse( - reservation_groups=[ - reservation.ReservationGroup(), - reservation.ReservationGroup(), - reservation.ReservationGroup(), - ], - next_page_token='abc', - ), - reservation.ListReservationGroupsResponse( - reservation_groups=[], - next_page_token='def', - ), - reservation.ListReservationGroupsResponse( - reservation_groups=[ - reservation.ReservationGroup(), - ], - next_page_token='ghi', - ), - reservation.ListReservationGroupsResponse( - reservation_groups=[ - reservation.ReservationGroup(), - reservation.ReservationGroup(), - ], - ), - RuntimeError, - ) - pages = [] - # Workaround issue in python 3.9 related to code coverage by adding `# pragma: no branch` - # See https://github.com/googleapis/gapic-generator-python/pull/1174#issuecomment-1025132372 - async for page_ in ( # pragma: no branch - await client.list_reservation_groups(request={}) - ).pages: - pages.append(page_) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - - -def test_create_reservation_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.create_reservation in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.create_reservation] = mock_rpc - - request = {} - client.create_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.create_reservation(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_create_reservation_rest_required_fields(request_type=gcbr_reservation.CreateReservationRequest): - transport_class = transports.ReservationServiceRestTransport - - 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, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_reservation._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_reservation._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("reservation_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 = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = gcbr_reservation.Reservation() - # 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 - - # Convert return value to protobuf type - return_value = gcbr_reservation.Reservation.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - response = client.create_reservation(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_create_reservation_rest_unset_required_fields(): - transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.create_reservation._get_unset_required_fields({}) - assert set(unset_fields) == (set(("reservationId", )) & set(("parent", ))) - - -def test_create_reservation_rest_flattened(): - client = ReservationServiceClient( - 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 = gcbr_reservation.Reservation() - - # 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', - reservation=gcbr_reservation.Reservation(name='name_value'), - reservation_id='reservation_id_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = gcbr_reservation.Reservation.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - client.create_reservation(**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/v1/{parent=projects/*/locations/*}/reservations" % client.transport._host, args[1]) - - -def test_create_reservation_rest_flattened_error(transport: str = 'rest'): - client = ReservationServiceClient( - 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_reservation( - gcbr_reservation.CreateReservationRequest(), - parent='parent_value', - reservation=gcbr_reservation.Reservation(name='name_value'), - reservation_id='reservation_id_value', - ) - - -def test_list_reservations_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.list_reservations in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.list_reservations] = mock_rpc - - request = {} - client.list_reservations(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.list_reservations(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_list_reservations_rest_required_fields(request_type=reservation.ListReservationsRequest): - transport_class = transports.ReservationServiceRestTransport - - 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, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_reservations._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_reservations._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 = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = reservation.ListReservationsResponse() - # 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 - - # Convert return value to protobuf type - return_value = reservation.ListReservationsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - response = client.list_reservations(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_list_reservations_rest_unset_required_fields(): - transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.list_reservations._get_unset_required_fields({}) - assert set(unset_fields) == (set(("pageSize", "pageToken", )) & set(("parent", ))) - - -def test_list_reservations_rest_flattened(): - client = ReservationServiceClient( - 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 = reservation.ListReservationsResponse() - - # 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 - # Convert return value to protobuf type - return_value = reservation.ListReservationsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - client.list_reservations(**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/v1/{parent=projects/*/locations/*}/reservations" % client.transport._host, args[1]) - - -def test_list_reservations_rest_flattened_error(transport: str = 'rest'): - client = ReservationServiceClient( - 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_reservations( - reservation.ListReservationsRequest(), - parent='parent_value', - ) - - -def test_list_reservations_rest_pager(transport: str = 'rest'): - client = ReservationServiceClient( - 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 = ( - reservation.ListReservationsResponse( - reservations=[ - reservation.Reservation(), - reservation.Reservation(), - reservation.Reservation(), - ], - next_page_token='abc', - ), - reservation.ListReservationsResponse( - reservations=[], - next_page_token='def', - ), - reservation.ListReservationsResponse( - reservations=[ - reservation.Reservation(), - ], - next_page_token='ghi', - ), - reservation.ListReservationsResponse( - reservations=[ - reservation.Reservation(), - reservation.Reservation(), - ], - ), - ) - # Two responses for two calls - response = response + response - - # Wrap the values into proper Response objs - response = tuple(reservation.ListReservationsResponse.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_reservations(request=sample_request) - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, reservation.Reservation) - for i in results) - - pages = list(client.list_reservations(request=sample_request).pages) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - - -def test_get_reservation_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.get_reservation in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.get_reservation] = mock_rpc - - request = {} - client.get_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.get_reservation(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_get_reservation_rest_required_fields(request_type=reservation.GetReservationRequest): - transport_class = transports.ReservationServiceRestTransport - - 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, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_reservation._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_reservation._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 = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = reservation.Reservation() - # 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 - - # Convert return value to protobuf type - return_value = reservation.Reservation.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - response = client.get_reservation(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_get_reservation_rest_unset_required_fields(): - transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.get_reservation._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("name", ))) - - -def test_get_reservation_rest_flattened(): - client = ReservationServiceClient( - 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 = reservation.Reservation() - - # get arguments that satisfy an http rule for this method - sample_request = {'name': 'projects/sample1/locations/sample2/reservations/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 - # Convert return value to protobuf type - return_value = reservation.Reservation.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - client.get_reservation(**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/v1/{name=projects/*/locations/*/reservations/*}" % client.transport._host, args[1]) - - -def test_get_reservation_rest_flattened_error(transport: str = 'rest'): - client = ReservationServiceClient( - 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_reservation( - reservation.GetReservationRequest(), - name='name_value', - ) - - -def test_delete_reservation_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.delete_reservation in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.delete_reservation] = mock_rpc - - request = {} - client.delete_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.delete_reservation(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_delete_reservation_rest_required_fields(request_type=reservation.DeleteReservationRequest): - transport_class = transports.ReservationServiceRestTransport - - 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, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_reservation._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_reservation._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 = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = None - # 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 = '' - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - response = client.delete_reservation(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_delete_reservation_rest_unset_required_fields(): - transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.delete_reservation._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("name", ))) - - -def test_delete_reservation_rest_flattened(): - client = ReservationServiceClient( - 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 = None - - # get arguments that satisfy an http rule for this method - sample_request = {'name': 'projects/sample1/locations/sample2/reservations/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 = '' - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - client.delete_reservation(**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/v1/{name=projects/*/locations/*/reservations/*}" % client.transport._host, args[1]) - - -def test_delete_reservation_rest_flattened_error(transport: str = 'rest'): - client = ReservationServiceClient( - 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_reservation( - reservation.DeleteReservationRequest(), - name='name_value', - ) - - -def test_update_reservation_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.update_reservation in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.update_reservation] = mock_rpc - - request = {} - client.update_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.update_reservation(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_update_reservation_rest_flattened(): - client = ReservationServiceClient( - 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 = gcbr_reservation.Reservation() - - # get arguments that satisfy an http rule for this method - sample_request = {'reservation': {'name': 'projects/sample1/locations/sample2/reservations/sample3'}} - - # get truthy value for each flattened field - mock_args = dict( - reservation=gcbr_reservation.Reservation(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 - # Convert return value to protobuf type - return_value = gcbr_reservation.Reservation.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - client.update_reservation(**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/v1/{reservation.name=projects/*/locations/*/reservations/*}" % client.transport._host, args[1]) - - -def test_update_reservation_rest_flattened_error(transport: str = 'rest'): - client = ReservationServiceClient( - 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_reservation( - gcbr_reservation.UpdateReservationRequest(), - reservation=gcbr_reservation.Reservation(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -def test_failover_reservation_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.failover_reservation in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.failover_reservation] = mock_rpc - - request = {} - client.failover_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.failover_reservation(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_failover_reservation_rest_required_fields(request_type=reservation.FailoverReservationRequest): - transport_class = transports.ReservationServiceRestTransport - - 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, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).failover_reservation._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()).failover_reservation._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 = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = reservation.Reservation() - # 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 - - # Convert return value to protobuf type - return_value = reservation.Reservation.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - response = client.failover_reservation(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_failover_reservation_rest_unset_required_fields(): - transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.failover_reservation._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("name", ))) - - -def test_create_capacity_commitment_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.create_capacity_commitment in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.create_capacity_commitment] = mock_rpc - - request = {} - client.create_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.create_capacity_commitment(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_create_capacity_commitment_rest_required_fields(request_type=reservation.CreateCapacityCommitmentRequest): - transport_class = transports.ReservationServiceRestTransport - - 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, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_capacity_commitment._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_capacity_commitment._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("capacity_commitment_id", "enforce_single_admin_project_per_org", )) - 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 = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = reservation.CapacityCommitment() - # 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 - - # Convert return value to protobuf type - return_value = reservation.CapacityCommitment.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - response = client.create_capacity_commitment(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_create_capacity_commitment_rest_unset_required_fields(): - transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.create_capacity_commitment._get_unset_required_fields({}) - assert set(unset_fields) == (set(("capacityCommitmentId", "enforceSingleAdminProjectPerOrg", )) & set(("parent", ))) - - -def test_create_capacity_commitment_rest_flattened(): - client = ReservationServiceClient( - 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 = reservation.CapacityCommitment() - - # 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', - capacity_commitment=reservation.CapacityCommitment(name='name_value'), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = reservation.CapacityCommitment.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - client.create_capacity_commitment(**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/v1/{parent=projects/*/locations/*}/capacityCommitments" % client.transport._host, args[1]) - - -def test_create_capacity_commitment_rest_flattened_error(transport: str = 'rest'): - client = ReservationServiceClient( - 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_capacity_commitment( - reservation.CreateCapacityCommitmentRequest(), - parent='parent_value', - capacity_commitment=reservation.CapacityCommitment(name='name_value'), - ) - - -def test_list_capacity_commitments_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.list_capacity_commitments in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.list_capacity_commitments] = mock_rpc - - request = {} - client.list_capacity_commitments(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.list_capacity_commitments(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_list_capacity_commitments_rest_required_fields(request_type=reservation.ListCapacityCommitmentsRequest): - transport_class = transports.ReservationServiceRestTransport - - 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, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_capacity_commitments._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_capacity_commitments._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 = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = reservation.ListCapacityCommitmentsResponse() - # 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 - - # Convert return value to protobuf type - return_value = reservation.ListCapacityCommitmentsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - response = client.list_capacity_commitments(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_list_capacity_commitments_rest_unset_required_fields(): - transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.list_capacity_commitments._get_unset_required_fields({}) - assert set(unset_fields) == (set(("pageSize", "pageToken", )) & set(("parent", ))) - - -def test_list_capacity_commitments_rest_flattened(): - client = ReservationServiceClient( - 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 = reservation.ListCapacityCommitmentsResponse() - - # 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 - # Convert return value to protobuf type - return_value = reservation.ListCapacityCommitmentsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - client.list_capacity_commitments(**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/v1/{parent=projects/*/locations/*}/capacityCommitments" % client.transport._host, args[1]) - - -def test_list_capacity_commitments_rest_flattened_error(transport: str = 'rest'): - client = ReservationServiceClient( - 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_capacity_commitments( - reservation.ListCapacityCommitmentsRequest(), - parent='parent_value', - ) - - -def test_list_capacity_commitments_rest_pager(transport: str = 'rest'): - client = ReservationServiceClient( - 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 = ( - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[ - reservation.CapacityCommitment(), - reservation.CapacityCommitment(), - reservation.CapacityCommitment(), - ], - next_page_token='abc', - ), - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[], - next_page_token='def', - ), - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[ - reservation.CapacityCommitment(), - ], - next_page_token='ghi', - ), - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[ - reservation.CapacityCommitment(), - reservation.CapacityCommitment(), - ], - ), - ) - # Two responses for two calls - response = response + response - - # Wrap the values into proper Response objs - response = tuple(reservation.ListCapacityCommitmentsResponse.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_capacity_commitments(request=sample_request) - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, reservation.CapacityCommitment) - for i in results) - - pages = list(client.list_capacity_commitments(request=sample_request).pages) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - - -def test_get_capacity_commitment_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.get_capacity_commitment in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.get_capacity_commitment] = mock_rpc - - request = {} - client.get_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.get_capacity_commitment(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_get_capacity_commitment_rest_required_fields(request_type=reservation.GetCapacityCommitmentRequest): - transport_class = transports.ReservationServiceRestTransport - - 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, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_capacity_commitment._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_capacity_commitment._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 = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = reservation.CapacityCommitment() - # 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 - - # Convert return value to protobuf type - return_value = reservation.CapacityCommitment.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - response = client.get_capacity_commitment(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_get_capacity_commitment_rest_unset_required_fields(): - transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.get_capacity_commitment._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("name", ))) - - -def test_get_capacity_commitment_rest_flattened(): - client = ReservationServiceClient( - 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 = reservation.CapacityCommitment() - - # get arguments that satisfy an http rule for this method - sample_request = {'name': 'projects/sample1/locations/sample2/capacityCommitments/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 - # Convert return value to protobuf type - return_value = reservation.CapacityCommitment.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - client.get_capacity_commitment(**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/v1/{name=projects/*/locations/*/capacityCommitments/*}" % client.transport._host, args[1]) - - -def test_get_capacity_commitment_rest_flattened_error(transport: str = 'rest'): - client = ReservationServiceClient( - 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_capacity_commitment( - reservation.GetCapacityCommitmentRequest(), - name='name_value', - ) - - -def test_delete_capacity_commitment_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.delete_capacity_commitment in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.delete_capacity_commitment] = mock_rpc - - request = {} - client.delete_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.delete_capacity_commitment(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_delete_capacity_commitment_rest_required_fields(request_type=reservation.DeleteCapacityCommitmentRequest): - transport_class = transports.ReservationServiceRestTransport - - 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, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_capacity_commitment._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_capacity_commitment._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("force", )) - 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 = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = None - # 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 = '' - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - response = client.delete_capacity_commitment(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_delete_capacity_commitment_rest_unset_required_fields(): - transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.delete_capacity_commitment._get_unset_required_fields({}) - assert set(unset_fields) == (set(("force", )) & set(("name", ))) - - -def test_delete_capacity_commitment_rest_flattened(): - client = ReservationServiceClient( - 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 = None - - # get arguments that satisfy an http rule for this method - sample_request = {'name': 'projects/sample1/locations/sample2/capacityCommitments/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 = '' - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - client.delete_capacity_commitment(**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/v1/{name=projects/*/locations/*/capacityCommitments/*}" % client.transport._host, args[1]) - - -def test_delete_capacity_commitment_rest_flattened_error(transport: str = 'rest'): - client = ReservationServiceClient( - 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_capacity_commitment( - reservation.DeleteCapacityCommitmentRequest(), - name='name_value', - ) - - -def test_update_capacity_commitment_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.update_capacity_commitment in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.update_capacity_commitment] = mock_rpc - - request = {} - client.update_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.update_capacity_commitment(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_update_capacity_commitment_rest_flattened(): - client = ReservationServiceClient( - 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 = reservation.CapacityCommitment() - - # get arguments that satisfy an http rule for this method - sample_request = {'capacity_commitment': {'name': 'projects/sample1/locations/sample2/capacityCommitments/sample3'}} - - # get truthy value for each flattened field - mock_args = dict( - capacity_commitment=reservation.CapacityCommitment(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 - # Convert return value to protobuf type - return_value = reservation.CapacityCommitment.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - client.update_capacity_commitment(**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/v1/{capacity_commitment.name=projects/*/locations/*/capacityCommitments/*}" % client.transport._host, args[1]) - - -def test_update_capacity_commitment_rest_flattened_error(transport: str = 'rest'): - client = ReservationServiceClient( - 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_capacity_commitment( - reservation.UpdateCapacityCommitmentRequest(), - capacity_commitment=reservation.CapacityCommitment(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -def test_split_capacity_commitment_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.split_capacity_commitment in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.split_capacity_commitment] = mock_rpc - - request = {} - client.split_capacity_commitment(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.split_capacity_commitment(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_split_capacity_commitment_rest_required_fields(request_type=reservation.SplitCapacityCommitmentRequest): - transport_class = transports.ReservationServiceRestTransport - - 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, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).split_capacity_commitment._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()).split_capacity_commitment._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 = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = reservation.SplitCapacityCommitmentResponse() - # 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 - - # Convert return value to protobuf type - return_value = reservation.SplitCapacityCommitmentResponse.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - response = client.split_capacity_commitment(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_split_capacity_commitment_rest_unset_required_fields(): - transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.split_capacity_commitment._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("name", ))) - - -def test_split_capacity_commitment_rest_flattened(): - client = ReservationServiceClient( - 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 = reservation.SplitCapacityCommitmentResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'name': 'projects/sample1/locations/sample2/capacityCommitments/sample3'} - - # get truthy value for each flattened field - mock_args = dict( - name='name_value', - slot_count=1098, - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = reservation.SplitCapacityCommitmentResponse.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - client.split_capacity_commitment(**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/v1/{name=projects/*/locations/*/capacityCommitments/*}:split" % client.transport._host, args[1]) - - -def test_split_capacity_commitment_rest_flattened_error(transport: str = 'rest'): - client = ReservationServiceClient( - 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.split_capacity_commitment( - reservation.SplitCapacityCommitmentRequest(), - name='name_value', - slot_count=1098, - ) - - -def test_merge_capacity_commitments_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.merge_capacity_commitments in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.merge_capacity_commitments] = mock_rpc - - request = {} - client.merge_capacity_commitments(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.merge_capacity_commitments(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_merge_capacity_commitments_rest_flattened(): - client = ReservationServiceClient( - 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 = reservation.CapacityCommitment() - - # 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', - capacity_commitment_ids=['capacity_commitment_ids_value'], - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = reservation.CapacityCommitment.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - client.merge_capacity_commitments(**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/v1/{parent=projects/*/locations/*}/capacityCommitments:merge" % client.transport._host, args[1]) - - -def test_merge_capacity_commitments_rest_flattened_error(transport: str = 'rest'): - client = ReservationServiceClient( - 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.merge_capacity_commitments( - reservation.MergeCapacityCommitmentsRequest(), - parent='parent_value', - capacity_commitment_ids=['capacity_commitment_ids_value'], - ) - - -def test_create_assignment_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.create_assignment in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.create_assignment] = mock_rpc - - request = {} - client.create_assignment(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.create_assignment(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_create_assignment_rest_required_fields(request_type=reservation.CreateAssignmentRequest): - transport_class = transports.ReservationServiceRestTransport - - 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, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_assignment._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_assignment._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("assignment_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 = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = reservation.Assignment() - # 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 - - # Convert return value to protobuf type - return_value = reservation.Assignment.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - response = client.create_assignment(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_create_assignment_rest_unset_required_fields(): - transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.create_assignment._get_unset_required_fields({}) - assert set(unset_fields) == (set(("assignmentId", )) & set(("parent", ))) - - -def test_create_assignment_rest_flattened(): - client = ReservationServiceClient( - 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 = reservation.Assignment() - - # get arguments that satisfy an http rule for this method - sample_request = {'parent': 'projects/sample1/locations/sample2/reservations/sample3'} - - # get truthy value for each flattened field - mock_args = dict( - parent='parent_value', - assignment=reservation.Assignment(name='name_value'), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = reservation.Assignment.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - client.create_assignment(**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/v1/{parent=projects/*/locations/*/reservations/*}/assignments" % client.transport._host, args[1]) - - -def test_create_assignment_rest_flattened_error(transport: str = 'rest'): - client = ReservationServiceClient( - 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_assignment( - reservation.CreateAssignmentRequest(), - parent='parent_value', - assignment=reservation.Assignment(name='name_value'), - ) - - -def test_list_assignments_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.list_assignments in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.list_assignments] = mock_rpc - - request = {} - client.list_assignments(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.list_assignments(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_list_assignments_rest_required_fields(request_type=reservation.ListAssignmentsRequest): - transport_class = transports.ReservationServiceRestTransport - - 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, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_assignments._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_assignments._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 = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = reservation.ListAssignmentsResponse() - # 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 - - # Convert return value to protobuf type - return_value = reservation.ListAssignmentsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - response = client.list_assignments(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_list_assignments_rest_unset_required_fields(): - transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.list_assignments._get_unset_required_fields({}) - assert set(unset_fields) == (set(("pageSize", "pageToken", )) & set(("parent", ))) - - -def test_list_assignments_rest_flattened(): - client = ReservationServiceClient( - 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 = reservation.ListAssignmentsResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'parent': 'projects/sample1/locations/sample2/reservations/sample3'} - - # 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 - # Convert return value to protobuf type - return_value = reservation.ListAssignmentsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - client.list_assignments(**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/v1/{parent=projects/*/locations/*/reservations/*}/assignments" % client.transport._host, args[1]) - - -def test_list_assignments_rest_flattened_error(transport: str = 'rest'): - client = ReservationServiceClient( - 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_assignments( - reservation.ListAssignmentsRequest(), - parent='parent_value', - ) - - -def test_list_assignments_rest_pager(transport: str = 'rest'): - client = ReservationServiceClient( - 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 = ( - reservation.ListAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - reservation.Assignment(), - ], - next_page_token='abc', - ), - reservation.ListAssignmentsResponse( - assignments=[], - next_page_token='def', - ), - reservation.ListAssignmentsResponse( - assignments=[ - reservation.Assignment(), - ], - next_page_token='ghi', - ), - reservation.ListAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - ], - ), - ) - # Two responses for two calls - response = response + response - - # Wrap the values into proper Response objs - response = tuple(reservation.ListAssignmentsResponse.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/reservations/sample3'} - - pager = client.list_assignments(request=sample_request) - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, reservation.Assignment) - for i in results) - - pages = list(client.list_assignments(request=sample_request).pages) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - - -def test_delete_assignment_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.delete_assignment in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.delete_assignment] = mock_rpc - - request = {} - client.delete_assignment(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.delete_assignment(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_delete_assignment_rest_required_fields(request_type=reservation.DeleteAssignmentRequest): - transport_class = transports.ReservationServiceRestTransport - - 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, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_assignment._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_assignment._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 = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = None - # 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 = '' - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - response = client.delete_assignment(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_delete_assignment_rest_unset_required_fields(): - transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.delete_assignment._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("name", ))) - - -def test_delete_assignment_rest_flattened(): - client = ReservationServiceClient( - 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 = None - - # get arguments that satisfy an http rule for this method - sample_request = {'name': 'projects/sample1/locations/sample2/reservations/sample3/assignments/sample4'} - - # 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 = '' - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - client.delete_assignment(**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/v1/{name=projects/*/locations/*/reservations/*/assignments/*}" % client.transport._host, args[1]) - - -def test_delete_assignment_rest_flattened_error(transport: str = 'rest'): - client = ReservationServiceClient( - 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_assignment( - reservation.DeleteAssignmentRequest(), - name='name_value', - ) - - -def test_search_assignments_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.search_assignments in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.search_assignments] = mock_rpc - - request = {} - client.search_assignments(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.search_assignments(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_search_assignments_rest_required_fields(request_type=reservation.SearchAssignmentsRequest): - transport_class = transports.ReservationServiceRestTransport - - 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, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).search_assignments._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()).search_assignments._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", "query", )) - 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 = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = reservation.SearchAssignmentsResponse() - # 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 - - # Convert return value to protobuf type - return_value = reservation.SearchAssignmentsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - response = client.search_assignments(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_search_assignments_rest_unset_required_fields(): - transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.search_assignments._get_unset_required_fields({}) - assert set(unset_fields) == (set(("pageSize", "pageToken", "query", )) & set(("parent", ))) - - -def test_search_assignments_rest_flattened(): - client = ReservationServiceClient( - 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 = reservation.SearchAssignmentsResponse() - - # 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', - query='query_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = reservation.SearchAssignmentsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - client.search_assignments(**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/v1/{parent=projects/*/locations/*}:searchAssignments" % client.transport._host, args[1]) - - -def test_search_assignments_rest_flattened_error(transport: str = 'rest'): - client = ReservationServiceClient( - 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.search_assignments( - reservation.SearchAssignmentsRequest(), - parent='parent_value', - query='query_value', - ) - - -def test_search_assignments_rest_pager(transport: str = 'rest'): - client = ReservationServiceClient( - 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 = ( - reservation.SearchAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - reservation.Assignment(), - ], - next_page_token='abc', - ), - reservation.SearchAssignmentsResponse( - assignments=[], - next_page_token='def', - ), - reservation.SearchAssignmentsResponse( - assignments=[ - reservation.Assignment(), - ], - next_page_token='ghi', - ), - reservation.SearchAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - ], - ), - ) - # Two responses for two calls - response = response + response - - # Wrap the values into proper Response objs - response = tuple(reservation.SearchAssignmentsResponse.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.search_assignments(request=sample_request) - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, reservation.Assignment) - for i in results) - - pages = list(client.search_assignments(request=sample_request).pages) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - - -def test_search_all_assignments_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.search_all_assignments in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.search_all_assignments] = mock_rpc - - request = {} - client.search_all_assignments(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.search_all_assignments(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_search_all_assignments_rest_required_fields(request_type=reservation.SearchAllAssignmentsRequest): - transport_class = transports.ReservationServiceRestTransport - - 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, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).search_all_assignments._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()).search_all_assignments._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", "query", )) - 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 = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = reservation.SearchAllAssignmentsResponse() - # 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 - - # Convert return value to protobuf type - return_value = reservation.SearchAllAssignmentsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - response = client.search_all_assignments(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_search_all_assignments_rest_unset_required_fields(): - transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.search_all_assignments._get_unset_required_fields({}) - assert set(unset_fields) == (set(("pageSize", "pageToken", "query", )) & set(("parent", ))) - - -def test_search_all_assignments_rest_flattened(): - client = ReservationServiceClient( - 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 = reservation.SearchAllAssignmentsResponse() - - # 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', - query='query_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = reservation.SearchAllAssignmentsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - client.search_all_assignments(**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/v1/{parent=projects/*/locations/*}:searchAllAssignments" % client.transport._host, args[1]) - - -def test_search_all_assignments_rest_flattened_error(transport: str = 'rest'): - client = ReservationServiceClient( - 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.search_all_assignments( - reservation.SearchAllAssignmentsRequest(), - parent='parent_value', - query='query_value', - ) - - -def test_search_all_assignments_rest_pager(transport: str = 'rest'): - client = ReservationServiceClient( - 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 = ( - reservation.SearchAllAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - reservation.Assignment(), - ], - next_page_token='abc', - ), - reservation.SearchAllAssignmentsResponse( - assignments=[], - next_page_token='def', - ), - reservation.SearchAllAssignmentsResponse( - assignments=[ - reservation.Assignment(), - ], - next_page_token='ghi', - ), - reservation.SearchAllAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - ], - ), - ) - # Two responses for two calls - response = response + response - - # Wrap the values into proper Response objs - response = tuple(reservation.SearchAllAssignmentsResponse.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.search_all_assignments(request=sample_request) - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, reservation.Assignment) - for i in results) - - pages = list(client.search_all_assignments(request=sample_request).pages) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - - -def test_move_assignment_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.move_assignment in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.move_assignment] = mock_rpc - - request = {} - client.move_assignment(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.move_assignment(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_move_assignment_rest_required_fields(request_type=reservation.MoveAssignmentRequest): - transport_class = transports.ReservationServiceRestTransport - - 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, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).move_assignment._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()).move_assignment._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 = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = reservation.Assignment() - # 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 - - # Convert return value to protobuf type - return_value = reservation.Assignment.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - response = client.move_assignment(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_move_assignment_rest_unset_required_fields(): - transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.move_assignment._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("name", ))) - - -def test_move_assignment_rest_flattened(): - client = ReservationServiceClient( - 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 = reservation.Assignment() - - # get arguments that satisfy an http rule for this method - sample_request = {'name': 'projects/sample1/locations/sample2/reservations/sample3/assignments/sample4'} - - # get truthy value for each flattened field - mock_args = dict( - name='name_value', - destination_id='destination_id_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = reservation.Assignment.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - client.move_assignment(**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/v1/{name=projects/*/locations/*/reservations/*/assignments/*}:move" % client.transport._host, args[1]) - - -def test_move_assignment_rest_flattened_error(transport: str = 'rest'): - client = ReservationServiceClient( - 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.move_assignment( - reservation.MoveAssignmentRequest(), - name='name_value', - destination_id='destination_id_value', - ) - - -def test_update_assignment_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.update_assignment in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.update_assignment] = mock_rpc - - request = {} - client.update_assignment(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.update_assignment(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_update_assignment_rest_flattened(): - client = ReservationServiceClient( - 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 = reservation.Assignment() - - # get arguments that satisfy an http rule for this method - sample_request = {'assignment': {'name': 'projects/sample1/locations/sample2/reservations/sample3/assignments/sample4'}} - - # get truthy value for each flattened field - mock_args = dict( - assignment=reservation.Assignment(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 - # Convert return value to protobuf type - return_value = reservation.Assignment.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - client.update_assignment(**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/v1/{assignment.name=projects/*/locations/*/reservations/*/assignments/*}" % client.transport._host, args[1]) - - -def test_update_assignment_rest_flattened_error(transport: str = 'rest'): - client = ReservationServiceClient( - 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_assignment( - reservation.UpdateAssignmentRequest(), - assignment=reservation.Assignment(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -def test_get_bi_reservation_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.get_bi_reservation in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.get_bi_reservation] = mock_rpc - - request = {} - client.get_bi_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.get_bi_reservation(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_get_bi_reservation_rest_required_fields(request_type=reservation.GetBiReservationRequest): - transport_class = transports.ReservationServiceRestTransport - - 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, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_bi_reservation._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_bi_reservation._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 = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = reservation.BiReservation() - # 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 - - # Convert return value to protobuf type - return_value = reservation.BiReservation.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - response = client.get_bi_reservation(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_get_bi_reservation_rest_unset_required_fields(): - transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.get_bi_reservation._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("name", ))) - - -def test_get_bi_reservation_rest_flattened(): - client = ReservationServiceClient( - 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 = reservation.BiReservation() - - # get arguments that satisfy an http rule for this method - sample_request = {'name': 'projects/sample1/locations/sample2/biReservation'} - - # 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 - # Convert return value to protobuf type - return_value = reservation.BiReservation.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - client.get_bi_reservation(**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/v1/{name=projects/*/locations/*/biReservation}" % client.transport._host, args[1]) - - -def test_get_bi_reservation_rest_flattened_error(transport: str = 'rest'): - client = ReservationServiceClient( - 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_bi_reservation( - reservation.GetBiReservationRequest(), - name='name_value', - ) - - -def test_update_bi_reservation_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.update_bi_reservation in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.update_bi_reservation] = mock_rpc - - request = {} - client.update_bi_reservation(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.update_bi_reservation(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_update_bi_reservation_rest_flattened(): - client = ReservationServiceClient( - 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 = reservation.BiReservation() - - # get arguments that satisfy an http rule for this method - sample_request = {'bi_reservation': {'name': 'projects/sample1/locations/sample2/biReservation'}} - - # get truthy value for each flattened field - mock_args = dict( - bi_reservation=reservation.BiReservation(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 - # Convert return value to protobuf type - return_value = reservation.BiReservation.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - client.update_bi_reservation(**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/v1/{bi_reservation.name=projects/*/locations/*/biReservation}" % client.transport._host, args[1]) - - -def test_update_bi_reservation_rest_flattened_error(transport: str = 'rest'): - client = ReservationServiceClient( - 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_bi_reservation( - reservation.UpdateBiReservationRequest(), - bi_reservation=reservation.BiReservation(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -def test_get_iam_policy_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.get_iam_policy in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.get_iam_policy] = mock_rpc - - request = {} - client.get_iam_policy(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.get_iam_policy(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_get_iam_policy_rest_required_fields(request_type=iam_policy_pb2.GetIamPolicyRequest): - transport_class = transports.ReservationServiceRestTransport - - request_init = {} - request_init["resource"] = "" - request = request_type(**request_init) - pb_request = request - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_iam_policy._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["resource"] = 'resource_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_iam_policy._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("options", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "resource" in jsonified_request - assert jsonified_request["resource"] == 'resource_value' - - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = policy_pb2.Policy() - # 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 - 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 - - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - response = client.get_iam_policy(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_get_iam_policy_rest_unset_required_fields(): - transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.get_iam_policy._get_unset_required_fields({}) - assert set(unset_fields) == (set(("options", )) & set(("resource", ))) - - -def test_get_iam_policy_rest_flattened(): - client = ReservationServiceClient( - 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 = policy_pb2.Policy() - - # get arguments that satisfy an http rule for this method - sample_request = {'resource': 'projects/sample1/locations/sample2/reservations/sample3'} - - # get truthy value for each flattened field - mock_args = dict( - resource='resource_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 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - client.get_iam_policy(**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/v1/{resource=projects/*/locations/*/reservations/*}:getIamPolicy" % client.transport._host, args[1]) - - -def test_get_iam_policy_rest_flattened_error(transport: str = 'rest'): - client = ReservationServiceClient( - 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_iam_policy( - iam_policy_pb2.GetIamPolicyRequest(), - resource='resource_value', - ) - - -def test_set_iam_policy_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.set_iam_policy in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.set_iam_policy] = mock_rpc - - request = {} - client.set_iam_policy(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.set_iam_policy(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_set_iam_policy_rest_required_fields(request_type=iam_policy_pb2.SetIamPolicyRequest): - transport_class = transports.ReservationServiceRestTransport - - request_init = {} - request_init["resource"] = "" - request = request_type(**request_init) - pb_request = request - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).set_iam_policy._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["resource"] = 'resource_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).set_iam_policy._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "resource" in jsonified_request - assert jsonified_request["resource"] == 'resource_value' - - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = policy_pb2.Policy() - # 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 - 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 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - response = client.set_iam_policy(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_set_iam_policy_rest_unset_required_fields(): - transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.set_iam_policy._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("resource", "policy", ))) - - -def test_set_iam_policy_rest_flattened(): - client = ReservationServiceClient( - 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 = policy_pb2.Policy() - - # get arguments that satisfy an http rule for this method - sample_request = {'resource': 'projects/sample1/locations/sample2/reservations/sample3'} - - # get truthy value for each flattened field - mock_args = dict( - resource='resource_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 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - client.set_iam_policy(**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/v1/{resource=projects/*/locations/*/reservations/*}:setIamPolicy" % client.transport._host, args[1]) - - -def test_set_iam_policy_rest_flattened_error(transport: str = 'rest'): - client = ReservationServiceClient( - 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.set_iam_policy( - iam_policy_pb2.SetIamPolicyRequest(), - resource='resource_value', - ) - - -def test_test_iam_permissions_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.test_iam_permissions in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.test_iam_permissions] = mock_rpc - - request = {} - client.test_iam_permissions(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.test_iam_permissions(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_test_iam_permissions_rest_required_fields(request_type=iam_policy_pb2.TestIamPermissionsRequest): - transport_class = transports.ReservationServiceRestTransport - - request_init = {} - request_init["resource"] = "" - request_init["permissions"] = "" - request = request_type(**request_init) - pb_request = request - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).test_iam_permissions._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["resource"] = 'resource_value' - jsonified_request["permissions"] = 'permissions_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).test_iam_permissions._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "resource" in jsonified_request - assert jsonified_request["resource"] == 'resource_value' - assert "permissions" in jsonified_request - assert jsonified_request["permissions"] == 'permissions_value' - - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = iam_policy_pb2.TestIamPermissionsResponse() - # 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 - 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 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - response = client.test_iam_permissions(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_test_iam_permissions_rest_unset_required_fields(): - transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.test_iam_permissions._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("resource", "permissions", ))) - - -def test_create_reservation_group_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.create_reservation_group in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.create_reservation_group] = mock_rpc - - request = {} - client.create_reservation_group(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.create_reservation_group(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_create_reservation_group_rest_required_fields(request_type=reservation.CreateReservationGroupRequest): - transport_class = transports.ReservationServiceRestTransport - - request_init = {} - request_init["parent"] = "" - request_init["reservation_group_id"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - assert "reservationGroupId" not in jsonified_request - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_reservation_group._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - assert "reservationGroupId" in jsonified_request - assert jsonified_request["reservationGroupId"] == request_init["reservation_group_id"] - - jsonified_request["parent"] = 'parent_value' - jsonified_request["reservationGroupId"] = 'reservation_group_id_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_reservation_group._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("reservation_group_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' - assert "reservationGroupId" in jsonified_request - assert jsonified_request["reservationGroupId"] == 'reservation_group_id_value' - - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = reservation.ReservationGroup() - # 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 - - # Convert return value to protobuf type - return_value = reservation.ReservationGroup.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - response = client.create_reservation_group(request) - - expected_params = [ - ( - "reservationGroupId", - "", - ), - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_create_reservation_group_rest_unset_required_fields(): - transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.create_reservation_group._get_unset_required_fields({}) - assert set(unset_fields) == (set(("reservationGroupId", )) & set(("parent", "reservationGroupId", "reservationGroup", ))) - - -def test_get_reservation_group_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.get_reservation_group in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.get_reservation_group] = mock_rpc - - request = {} - client.get_reservation_group(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.get_reservation_group(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_get_reservation_group_rest_required_fields(request_type=reservation.GetReservationGroupRequest): - transport_class = transports.ReservationServiceRestTransport - - 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, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_reservation_group._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_reservation_group._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 = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = reservation.ReservationGroup() - # 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 - - # Convert return value to protobuf type - return_value = reservation.ReservationGroup.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - response = client.get_reservation_group(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_get_reservation_group_rest_unset_required_fields(): - transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.get_reservation_group._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("name", ))) - - -def test_get_reservation_group_rest_flattened(): - client = ReservationServiceClient( - 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 = reservation.ReservationGroup() - - # get arguments that satisfy an http rule for this method - sample_request = {'name': 'projects/sample1/locations/sample2/reservationGroups/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 - # Convert return value to protobuf type - return_value = reservation.ReservationGroup.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - client.get_reservation_group(**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/v1/{name=projects/*/locations/*/reservationGroups/*}" % client.transport._host, args[1]) - - -def test_get_reservation_group_rest_flattened_error(transport: str = 'rest'): - client = ReservationServiceClient( - 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_reservation_group( - reservation.GetReservationGroupRequest(), - name='name_value', - ) - - -def test_delete_reservation_group_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.delete_reservation_group in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.delete_reservation_group] = mock_rpc - - request = {} - client.delete_reservation_group(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.delete_reservation_group(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_delete_reservation_group_rest_required_fields(request_type=reservation.DeleteReservationGroupRequest): - transport_class = transports.ReservationServiceRestTransport - - 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, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_reservation_group._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_reservation_group._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 = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = None - # 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 = '' - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - response = client.delete_reservation_group(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_delete_reservation_group_rest_unset_required_fields(): - transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.delete_reservation_group._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("name", ))) - - -def test_delete_reservation_group_rest_flattened(): - client = ReservationServiceClient( - 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 = None - - # get arguments that satisfy an http rule for this method - sample_request = {'name': 'projects/sample1/locations/sample2/reservationGroups/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 = '' - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - client.delete_reservation_group(**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/v1/{name=projects/*/locations/*/reservationGroups/*}" % client.transport._host, args[1]) - - -def test_delete_reservation_group_rest_flattened_error(transport: str = 'rest'): - client = ReservationServiceClient( - 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_reservation_group( - reservation.DeleteReservationGroupRequest(), - name='name_value', - ) - - -def test_list_reservation_groups_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.list_reservation_groups in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.list_reservation_groups] = mock_rpc - - request = {} - client.list_reservation_groups(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.list_reservation_groups(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_list_reservation_groups_rest_required_fields(request_type=reservation.ListReservationGroupsRequest): - transport_class = transports.ReservationServiceRestTransport - - 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, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_reservation_groups._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_reservation_groups._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 = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = reservation.ListReservationGroupsResponse() - # 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 - - # Convert return value to protobuf type - return_value = reservation.ListReservationGroupsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - response = client.list_reservation_groups(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_list_reservation_groups_rest_unset_required_fields(): - transport = transports.ReservationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.list_reservation_groups._get_unset_required_fields({}) - assert set(unset_fields) == (set(("pageSize", "pageToken", )) & set(("parent", ))) - - -def test_list_reservation_groups_rest_flattened(): - client = ReservationServiceClient( - 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 = reservation.ListReservationGroupsResponse() - - # 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 - # Convert return value to protobuf type - return_value = reservation.ListReservationGroupsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - client.list_reservation_groups(**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/v1/{parent=projects/*/locations/*}/reservationGroups" % client.transport._host, args[1]) - - -def test_list_reservation_groups_rest_flattened_error(transport: str = 'rest'): - client = ReservationServiceClient( - 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_reservation_groups( - reservation.ListReservationGroupsRequest(), - parent='parent_value', - ) - - -def test_list_reservation_groups_rest_pager(transport: str = 'rest'): - client = ReservationServiceClient( - 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 = ( - reservation.ListReservationGroupsResponse( - reservation_groups=[ - reservation.ReservationGroup(), - reservation.ReservationGroup(), - reservation.ReservationGroup(), - ], - next_page_token='abc', - ), - reservation.ListReservationGroupsResponse( - reservation_groups=[], - next_page_token='def', - ), - reservation.ListReservationGroupsResponse( - reservation_groups=[ - reservation.ReservationGroup(), - ], - next_page_token='ghi', - ), - reservation.ListReservationGroupsResponse( - reservation_groups=[ - reservation.ReservationGroup(), - reservation.ReservationGroup(), - ], - ), - ) - # Two responses for two calls - response = response + response - - # Wrap the values into proper Response objs - response = tuple(reservation.ListReservationGroupsResponse.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_reservation_groups(request=sample_request) - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, reservation.ReservationGroup) - for i in results) - - pages = list(client.list_reservation_groups(request=sample_request).pages) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - - -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.ReservationServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # It is an error to provide a credentials file and a transport instance. - transport = transports.ReservationServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = ReservationServiceClient( - client_options={"credentials_file": "credentials.json"}, - transport=transport, - ) - - # It is an error to provide an api_key and a transport instance. - transport = transports.ReservationServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - options = client_options.ClientOptions() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = ReservationServiceClient( - client_options=options, - transport=transport, - ) - - # It is an error to provide an api_key and a credential. - options = client_options.ClientOptions() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = ReservationServiceClient( - client_options=options, - credentials=ga_credentials.AnonymousCredentials() - ) - - # It is an error to provide scopes and a transport instance. - transport = transports.ReservationServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = ReservationServiceClient( - client_options={"scopes": ["1", "2"]}, - transport=transport, - ) - - -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.ReservationServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - client = ReservationServiceClient(transport=transport) - assert client.transport is transport - -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.ReservationServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - - transport = transports.ReservationServiceGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - -@pytest.mark.parametrize("transport_class", [ - transports.ReservationServiceGrpcTransport, - transports.ReservationServiceGrpcAsyncIOTransport, - transports.ReservationServiceRestTransport, -]) -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() - -def test_transport_kind_grpc(): - transport = ReservationServiceClient.get_transport_class("grpc")( - credentials=ga_credentials.AnonymousCredentials() - ) - assert transport.kind == "grpc" - - -def test_initialize_client_w_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc" - ) - assert client is not None - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_create_reservation_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.create_reservation), - '__call__') as call: - call.return_value = gcbr_reservation.Reservation() - client.create_reservation(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = gcbr_reservation.CreateReservationRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_list_reservations_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.list_reservations), - '__call__') as call: - call.return_value = reservation.ListReservationsResponse() - client.list_reservations(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.ListReservationsRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_get_reservation_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.get_reservation), - '__call__') as call: - call.return_value = reservation.Reservation() - client.get_reservation(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.GetReservationRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_delete_reservation_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.delete_reservation), - '__call__') as call: - call.return_value = None - client.delete_reservation(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.DeleteReservationRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_update_reservation_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.update_reservation), - '__call__') as call: - call.return_value = gcbr_reservation.Reservation() - client.update_reservation(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = gcbr_reservation.UpdateReservationRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_failover_reservation_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.failover_reservation), - '__call__') as call: - call.return_value = reservation.Reservation() - client.failover_reservation(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.FailoverReservationRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_create_capacity_commitment_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.create_capacity_commitment), - '__call__') as call: - call.return_value = reservation.CapacityCommitment() - client.create_capacity_commitment(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.CreateCapacityCommitmentRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_list_capacity_commitments_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.list_capacity_commitments), - '__call__') as call: - call.return_value = reservation.ListCapacityCommitmentsResponse() - client.list_capacity_commitments(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.ListCapacityCommitmentsRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_get_capacity_commitment_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.get_capacity_commitment), - '__call__') as call: - call.return_value = reservation.CapacityCommitment() - client.get_capacity_commitment(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.GetCapacityCommitmentRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_delete_capacity_commitment_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.delete_capacity_commitment), - '__call__') as call: - call.return_value = None - client.delete_capacity_commitment(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.DeleteCapacityCommitmentRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_update_capacity_commitment_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.update_capacity_commitment), - '__call__') as call: - call.return_value = reservation.CapacityCommitment() - client.update_capacity_commitment(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.UpdateCapacityCommitmentRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_split_capacity_commitment_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.split_capacity_commitment), - '__call__') as call: - call.return_value = reservation.SplitCapacityCommitmentResponse() - client.split_capacity_commitment(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.SplitCapacityCommitmentRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_merge_capacity_commitments_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.merge_capacity_commitments), - '__call__') as call: - call.return_value = reservation.CapacityCommitment() - client.merge_capacity_commitments(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.MergeCapacityCommitmentsRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_create_assignment_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.create_assignment), - '__call__') as call: - call.return_value = reservation.Assignment() - client.create_assignment(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.CreateAssignmentRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_list_assignments_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.list_assignments), - '__call__') as call: - call.return_value = reservation.ListAssignmentsResponse() - client.list_assignments(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.ListAssignmentsRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_delete_assignment_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.delete_assignment), - '__call__') as call: - call.return_value = None - client.delete_assignment(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.DeleteAssignmentRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_search_assignments_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.search_assignments), - '__call__') as call: - call.return_value = reservation.SearchAssignmentsResponse() - client.search_assignments(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.SearchAssignmentsRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_search_all_assignments_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.search_all_assignments), - '__call__') as call: - call.return_value = reservation.SearchAllAssignmentsResponse() - client.search_all_assignments(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.SearchAllAssignmentsRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_move_assignment_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.move_assignment), - '__call__') as call: - call.return_value = reservation.Assignment() - client.move_assignment(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.MoveAssignmentRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_update_assignment_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.update_assignment), - '__call__') as call: - call.return_value = reservation.Assignment() - client.update_assignment(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.UpdateAssignmentRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_get_bi_reservation_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.get_bi_reservation), - '__call__') as call: - call.return_value = reservation.BiReservation() - client.get_bi_reservation(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.GetBiReservationRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_update_bi_reservation_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.update_bi_reservation), - '__call__') as call: - call.return_value = reservation.BiReservation() - client.update_bi_reservation(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.UpdateBiReservationRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_get_iam_policy_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.get_iam_policy), - '__call__') as call: - call.return_value = policy_pb2.Policy() - client.get_iam_policy(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = iam_policy_pb2.GetIamPolicyRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_set_iam_policy_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.set_iam_policy), - '__call__') as call: - call.return_value = policy_pb2.Policy() - client.set_iam_policy(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = iam_policy_pb2.SetIamPolicyRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_test_iam_permissions_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.test_iam_permissions), - '__call__') as call: - call.return_value = iam_policy_pb2.TestIamPermissionsResponse() - client.test_iam_permissions(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = iam_policy_pb2.TestIamPermissionsRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_create_reservation_group_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.create_reservation_group), - '__call__') as call: - call.return_value = reservation.ReservationGroup() - client.create_reservation_group(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.CreateReservationGroupRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_get_reservation_group_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.get_reservation_group), - '__call__') as call: - call.return_value = reservation.ReservationGroup() - client.get_reservation_group(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.GetReservationGroupRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_delete_reservation_group_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.delete_reservation_group), - '__call__') as call: - call.return_value = None - client.delete_reservation_group(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.DeleteReservationGroupRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_list_reservation_groups_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.list_reservation_groups), - '__call__') as call: - call.return_value = reservation.ListReservationGroupsResponse() - client.list_reservation_groups(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.ListReservationGroupsRequest() - - assert args[0] == request_msg - - -def test_transport_kind_grpc_asyncio(): - transport = ReservationServiceAsyncClient.get_transport_class("grpc_asyncio")( - credentials=async_anonymous_credentials() - ) - assert transport.kind == "grpc_asyncio" - - -def test_initialize_client_w_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio" - ) - assert client is not None - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_create_reservation_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.create_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(gcbr_reservation.Reservation( - name='name_value', - slot_capacity=1391, - ignore_idle_slots=True, - concurrency=1195, - multi_region_auxiliary=True, - edition=gcbr_reservation.Edition.STANDARD, - primary_location='primary_location_value', - secondary_location='secondary_location_value', - original_primary_location='original_primary_location_value', - max_slots=986, - scaling_mode=gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, - reservation_group='reservation_group_value', - )) - await client.create_reservation(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = gcbr_reservation.CreateReservationRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_list_reservations_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.list_reservations), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListReservationsResponse( - next_page_token='next_page_token_value', - )) - await client.list_reservations(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.ListReservationsRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_get_reservation_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.get_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Reservation( - name='name_value', - slot_capacity=1391, - ignore_idle_slots=True, - concurrency=1195, - multi_region_auxiliary=True, - edition=reservation.Edition.STANDARD, - primary_location='primary_location_value', - secondary_location='secondary_location_value', - original_primary_location='original_primary_location_value', - max_slots=986, - scaling_mode=reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, - reservation_group='reservation_group_value', - )) - await client.get_reservation(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.GetReservationRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_delete_reservation_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.delete_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - await client.delete_reservation(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.DeleteReservationRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_update_reservation_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.update_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(gcbr_reservation.Reservation( - name='name_value', - slot_capacity=1391, - ignore_idle_slots=True, - concurrency=1195, - multi_region_auxiliary=True, - edition=gcbr_reservation.Edition.STANDARD, - primary_location='primary_location_value', - secondary_location='secondary_location_value', - original_primary_location='original_primary_location_value', - max_slots=986, - scaling_mode=gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, - reservation_group='reservation_group_value', - )) - await client.update_reservation(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = gcbr_reservation.UpdateReservationRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_failover_reservation_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.failover_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Reservation( - name='name_value', - slot_capacity=1391, - ignore_idle_slots=True, - concurrency=1195, - multi_region_auxiliary=True, - edition=reservation.Edition.STANDARD, - primary_location='primary_location_value', - secondary_location='secondary_location_value', - original_primary_location='original_primary_location_value', - max_slots=986, - scaling_mode=reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, - reservation_group='reservation_group_value', - )) - await client.failover_reservation(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.FailoverReservationRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_create_capacity_commitment_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.create_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment( - name='name_value', - slot_count=1098, - plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - state=reservation.CapacityCommitment.State.PENDING, - renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - multi_region_auxiliary=True, - edition=reservation.Edition.STANDARD, - is_flat_rate=True, - )) - await client.create_capacity_commitment(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.CreateCapacityCommitmentRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_list_capacity_commitments_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.list_capacity_commitments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListCapacityCommitmentsResponse( - next_page_token='next_page_token_value', - )) - await client.list_capacity_commitments(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.ListCapacityCommitmentsRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_get_capacity_commitment_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.get_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment( - name='name_value', - slot_count=1098, - plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - state=reservation.CapacityCommitment.State.PENDING, - renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - multi_region_auxiliary=True, - edition=reservation.Edition.STANDARD, - is_flat_rate=True, - )) - await client.get_capacity_commitment(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.GetCapacityCommitmentRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_delete_capacity_commitment_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.delete_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - await client.delete_capacity_commitment(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.DeleteCapacityCommitmentRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_update_capacity_commitment_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.update_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment( - name='name_value', - slot_count=1098, - plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - state=reservation.CapacityCommitment.State.PENDING, - renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - multi_region_auxiliary=True, - edition=reservation.Edition.STANDARD, - is_flat_rate=True, - )) - await client.update_capacity_commitment(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.UpdateCapacityCommitmentRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_split_capacity_commitment_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.split_capacity_commitment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.SplitCapacityCommitmentResponse( - )) - await client.split_capacity_commitment(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.SplitCapacityCommitmentRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_merge_capacity_commitments_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.merge_capacity_commitments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.CapacityCommitment( - name='name_value', - slot_count=1098, - plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - state=reservation.CapacityCommitment.State.PENDING, - renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - multi_region_auxiliary=True, - edition=reservation.Edition.STANDARD, - is_flat_rate=True, - )) - await client.merge_capacity_commitments(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.MergeCapacityCommitmentsRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_create_assignment_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.create_assignment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment( - name='name_value', - assignee='assignee_value', - job_type=reservation.Assignment.JobType.PIPELINE, - state=reservation.Assignment.State.PENDING, - enable_gemini_in_bigquery=True, - )) - await client.create_assignment(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.CreateAssignmentRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_list_assignments_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.list_assignments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListAssignmentsResponse( - next_page_token='next_page_token_value', - )) - await client.list_assignments(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.ListAssignmentsRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_delete_assignment_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.delete_assignment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - await client.delete_assignment(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.DeleteAssignmentRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_search_assignments_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.search_assignments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.SearchAssignmentsResponse( - next_page_token='next_page_token_value', - )) - await client.search_assignments(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.SearchAssignmentsRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_search_all_assignments_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.search_all_assignments), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.SearchAllAssignmentsResponse( - next_page_token='next_page_token_value', - )) - await client.search_all_assignments(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.SearchAllAssignmentsRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_move_assignment_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.move_assignment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment( - name='name_value', - assignee='assignee_value', - job_type=reservation.Assignment.JobType.PIPELINE, - state=reservation.Assignment.State.PENDING, - enable_gemini_in_bigquery=True, - )) - await client.move_assignment(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.MoveAssignmentRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_update_assignment_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.update_assignment), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.Assignment( - name='name_value', - assignee='assignee_value', - job_type=reservation.Assignment.JobType.PIPELINE, - state=reservation.Assignment.State.PENDING, - enable_gemini_in_bigquery=True, - )) - await client.update_assignment(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.UpdateAssignmentRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_get_bi_reservation_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.get_bi_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.BiReservation( - name='name_value', - size=443, - )) - await client.get_bi_reservation(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.GetBiReservationRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_update_bi_reservation_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.update_bi_reservation), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.BiReservation( - name='name_value', - size=443, - )) - await client.update_bi_reservation(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.UpdateBiReservationRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_get_iam_policy_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.get_iam_policy), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy( - version=774, - etag=b'etag_blob', - )) - await client.get_iam_policy(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = iam_policy_pb2.GetIamPolicyRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_set_iam_policy_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.set_iam_policy), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy( - version=774, - etag=b'etag_blob', - )) - await client.set_iam_policy(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = iam_policy_pb2.SetIamPolicyRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_test_iam_permissions_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.test_iam_permissions), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(iam_policy_pb2.TestIamPermissionsResponse( - permissions=['permissions_value'], - )) - await client.test_iam_permissions(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = iam_policy_pb2.TestIamPermissionsRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_create_reservation_group_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.create_reservation_group), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ReservationGroup( - name='name_value', - )) - await client.create_reservation_group(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.CreateReservationGroupRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_get_reservation_group_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.get_reservation_group), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ReservationGroup( - name='name_value', - )) - await client.get_reservation_group(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.GetReservationGroupRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_delete_reservation_group_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.delete_reservation_group), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - await client.delete_reservation_group(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.DeleteReservationGroupRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_list_reservation_groups_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.list_reservation_groups), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(reservation.ListReservationGroupsResponse( - next_page_token='next_page_token_value', - )) - await client.list_reservation_groups(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.ListReservationGroupsRequest() - - assert args[0] == request_msg - - -def test_transport_kind_rest(): - transport = ReservationServiceClient.get_transport_class("rest")( - credentials=ga_credentials.AnonymousCredentials() - ) - assert transport.kind == "rest" - - -def test_create_reservation_rest_bad_request(request_type=gcbr_reservation.CreateReservationRequest): - client = ReservationServiceClient( - 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 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 = mock.Mock() - json_return_value = '' - response_value.json = mock.Mock(return_value={}) - response_value.status_code = 400 - response_value.request = mock.Mock() - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.create_reservation(request) - - -@pytest.mark.parametrize("request_type", [ - gcbr_reservation.CreateReservationRequest, - dict, -]) -def test_create_reservation_rest_call_success(request_type): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - request_init["reservation"] = {'name': 'name_value', 'slot_capacity': 1391, 'ignore_idle_slots': True, 'autoscale': {'current_slots': 1431, 'max_slots': 986}, 'concurrency': 1195, 'creation_time': {'seconds': 751, 'nanos': 543}, 'update_time': {}, 'multi_region_auxiliary': True, 'edition': 1, 'primary_location': 'primary_location_value', 'secondary_location': 'secondary_location_value', 'original_primary_location': 'original_primary_location_value', 'max_slots': 986, 'scaling_mode': 1, 'labels': {}, 'reservation_group': 'reservation_group_value', 'replication_status': {'error': {'code': 411, 'message': 'message_value', 'details': [{'type_url': 'type.googleapis.com/google.protobuf.Duration', 'value': b'\x08\x0c\x10\xdb\x07'}]}, 'last_error_time': {}, 'last_replication_time': {}, 'soft_failover_start_time': {}}, 'scheduling_policy': {'concurrency': 1195, 'max_slots': 986}} - # The version of a generated dependency at test runtime may differ from the version used during generation. - # Delete any fields which are not present in the current runtime dependency - # See https://github.com/googleapis/gapic-generator-python/issues/1748 - - # Determine if the message type is proto-plus or protobuf - test_field = gcbr_reservation.CreateReservationRequest.meta.fields["reservation"] - - def get_message_fields(field): - # Given a field which is a message (composite type), return a list with - # all the fields of the message. - # If the field is not a composite type, return an empty list. - message_fields = [] - - if hasattr(field, "message") and field.message: - is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") - - if is_field_type_proto_plus_type: - message_fields = field.message.meta.fields.values() - # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types - else: # pragma: NO COVER - message_fields = field.message.DESCRIPTOR.fields - return message_fields - - runtime_nested_fields = [ - (field.name, nested_field.name) - for field in get_message_fields(test_field) - for nested_field in get_message_fields(field) - ] - - subfields_not_in_runtime = [] - - # For each item in the sample request, create a list of sub fields which are not present at runtime - # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for field, value in request_init["reservation"].items(): # pragma: NO COVER - result = None - is_repeated = False - # For repeated fields - if isinstance(value, list) and len(value): - is_repeated = True - result = value[0] - # For fields where the type is another message - if isinstance(value, dict): - result = value - - if result and hasattr(result, "keys"): - for subfield in result.keys(): - if (field, subfield) not in runtime_nested_fields: - subfields_not_in_runtime.append( - {"field": field, "subfield": subfield, "is_repeated": is_repeated} - ) - - # Remove fields from the sample request which are not present in the runtime version of the dependency - # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER - field = subfield_to_delete.get("field") - field_repeated = subfield_to_delete.get("is_repeated") - subfield = subfield_to_delete.get("subfield") - if subfield: - if field_repeated: - for i in range(0, len(request_init["reservation"][field])): - del request_init["reservation"][field][i][subfield] - else: - del request_init["reservation"][field][subfield] - 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 = gcbr_reservation.Reservation( - name='name_value', - slot_capacity=1391, - ignore_idle_slots=True, - concurrency=1195, - multi_region_auxiliary=True, - edition=gcbr_reservation.Edition.STANDARD, - primary_location='primary_location_value', - secondary_location='secondary_location_value', - original_primary_location='original_primary_location_value', - max_slots=986, - scaling_mode=gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, - reservation_group='reservation_group_value', - ) - - # Wrap the value into a proper Response obj - response_value = mock.Mock() - response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = gcbr_reservation.Reservation.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value.content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.create_reservation(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, gcbr_reservation.Reservation) - assert response.name == 'name_value' - assert response.slot_capacity == 1391 - assert response.ignore_idle_slots is True - assert response.concurrency == 1195 - assert response.multi_region_auxiliary is True - assert response.edition == gcbr_reservation.Edition.STANDARD - assert response.primary_location == 'primary_location_value' - assert response.secondary_location == 'secondary_location_value' - assert response.original_primary_location == 'original_primary_location_value' - assert response.max_slots == 986 - assert response.scaling_mode == gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY - assert response.reservation_group == 'reservation_group_value' - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_create_reservation_rest_interceptors(null_interceptor): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), - ) - client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_create_reservation") as post, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "post_create_reservation_with_metadata") as post_with_metadata, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_create_reservation") as pre: - pre.assert_not_called() - post.assert_not_called() - post_with_metadata.assert_not_called() - pb_message = gcbr_reservation.CreateReservationRequest.pb(gcbr_reservation.CreateReservationRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = mock.Mock() - req.return_value.status_code = 200 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = gcbr_reservation.Reservation.to_json(gcbr_reservation.Reservation()) - req.return_value.content = return_value - - request = gcbr_reservation.CreateReservationRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = gcbr_reservation.Reservation() - post_with_metadata.return_value = gcbr_reservation.Reservation(), metadata - - client.create_reservation(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - post_with_metadata.assert_called_once() - - -def test_list_reservations_rest_bad_request(request_type=reservation.ListReservationsRequest): - client = ReservationServiceClient( - 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 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 = mock.Mock() - json_return_value = '' - response_value.json = mock.Mock(return_value={}) - response_value.status_code = 400 - response_value.request = mock.Mock() - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.list_reservations(request) - - -@pytest.mark.parametrize("request_type", [ - reservation.ListReservationsRequest, - dict, -]) -def test_list_reservations_rest_call_success(request_type): - client = ReservationServiceClient( - 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 = reservation.ListReservationsResponse( - next_page_token='next_page_token_value', - ) - - # Wrap the value into a proper Response obj - response_value = mock.Mock() - response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = reservation.ListReservationsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value.content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.list_reservations(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListReservationsPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_list_reservations_rest_interceptors(null_interceptor): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), - ) - client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_list_reservations") as post, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "post_list_reservations_with_metadata") as post_with_metadata, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_list_reservations") as pre: - pre.assert_not_called() - post.assert_not_called() - post_with_metadata.assert_not_called() - pb_message = reservation.ListReservationsRequest.pb(reservation.ListReservationsRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = mock.Mock() - req.return_value.status_code = 200 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.ListReservationsResponse.to_json(reservation.ListReservationsResponse()) - req.return_value.content = return_value - - request = reservation.ListReservationsRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = reservation.ListReservationsResponse() - post_with_metadata.return_value = reservation.ListReservationsResponse(), metadata - - client.list_reservations(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - post_with_metadata.assert_called_once() - - -def test_get_reservation_rest_bad_request(request_type=reservation.GetReservationRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/reservations/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 = mock.Mock() - json_return_value = '' - response_value.json = mock.Mock(return_value={}) - response_value.status_code = 400 - response_value.request = mock.Mock() - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.get_reservation(request) - - -@pytest.mark.parametrize("request_type", [ - reservation.GetReservationRequest, - dict, -]) -def test_get_reservation_rest_call_success(request_type): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/reservations/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 = reservation.Reservation( - name='name_value', - slot_capacity=1391, - ignore_idle_slots=True, - concurrency=1195, - multi_region_auxiliary=True, - edition=reservation.Edition.STANDARD, - primary_location='primary_location_value', - secondary_location='secondary_location_value', - original_primary_location='original_primary_location_value', - max_slots=986, - scaling_mode=reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, - reservation_group='reservation_group_value', - ) - - # Wrap the value into a proper Response obj - response_value = mock.Mock() - response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = reservation.Reservation.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value.content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.get_reservation(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.Reservation) - assert response.name == 'name_value' - assert response.slot_capacity == 1391 - assert response.ignore_idle_slots is True - assert response.concurrency == 1195 - assert response.multi_region_auxiliary is True - assert response.edition == reservation.Edition.STANDARD - assert response.primary_location == 'primary_location_value' - assert response.secondary_location == 'secondary_location_value' - assert response.original_primary_location == 'original_primary_location_value' - assert response.max_slots == 986 - assert response.scaling_mode == reservation.Reservation.ScalingMode.AUTOSCALE_ONLY - assert response.reservation_group == 'reservation_group_value' - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_get_reservation_rest_interceptors(null_interceptor): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), - ) - client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_get_reservation") as post, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "post_get_reservation_with_metadata") as post_with_metadata, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_get_reservation") as pre: - pre.assert_not_called() - post.assert_not_called() - post_with_metadata.assert_not_called() - pb_message = reservation.GetReservationRequest.pb(reservation.GetReservationRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = mock.Mock() - req.return_value.status_code = 200 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.Reservation.to_json(reservation.Reservation()) - req.return_value.content = return_value - - request = reservation.GetReservationRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = reservation.Reservation() - post_with_metadata.return_value = reservation.Reservation(), metadata - - client.get_reservation(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - post_with_metadata.assert_called_once() - - -def test_delete_reservation_rest_bad_request(request_type=reservation.DeleteReservationRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/reservations/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 = mock.Mock() - json_return_value = '' - response_value.json = mock.Mock(return_value={}) - response_value.status_code = 400 - response_value.request = mock.Mock() - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.delete_reservation(request) - - -@pytest.mark.parametrize("request_type", [ - reservation.DeleteReservationRequest, - dict, -]) -def test_delete_reservation_rest_call_success(request_type): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/reservations/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 = mock.Mock() - response_value.status_code = 200 - json_return_value = '' - response_value.content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.delete_reservation(request) - - # Establish that the response is the type that we expect. - assert response is None - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_delete_reservation_rest_interceptors(null_interceptor): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), - ) - client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "pre_delete_reservation") as pre: - pre.assert_not_called() - pb_message = reservation.DeleteReservationRequest.pb(reservation.DeleteReservationRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = mock.Mock() - req.return_value.status_code = 200 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - request = reservation.DeleteReservationRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - - client.delete_reservation(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - - -def test_update_reservation_rest_bad_request(request_type=gcbr_reservation.UpdateReservationRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - # send a request that will satisfy transcoding - request_init = {'reservation': {'name': 'projects/sample1/locations/sample2/reservations/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 = mock.Mock() - json_return_value = '' - response_value.json = mock.Mock(return_value={}) - response_value.status_code = 400 - response_value.request = mock.Mock() - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.update_reservation(request) - - -@pytest.mark.parametrize("request_type", [ - gcbr_reservation.UpdateReservationRequest, - dict, -]) -def test_update_reservation_rest_call_success(request_type): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - - # send a request that will satisfy transcoding - request_init = {'reservation': {'name': 'projects/sample1/locations/sample2/reservations/sample3'}} - request_init["reservation"] = {'name': 'projects/sample1/locations/sample2/reservations/sample3', 'slot_capacity': 1391, 'ignore_idle_slots': True, 'autoscale': {'current_slots': 1431, 'max_slots': 986}, 'concurrency': 1195, 'creation_time': {'seconds': 751, 'nanos': 543}, 'update_time': {}, 'multi_region_auxiliary': True, 'edition': 1, 'primary_location': 'primary_location_value', 'secondary_location': 'secondary_location_value', 'original_primary_location': 'original_primary_location_value', 'max_slots': 986, 'scaling_mode': 1, 'labels': {}, 'reservation_group': 'reservation_group_value', 'replication_status': {'error': {'code': 411, 'message': 'message_value', 'details': [{'type_url': 'type.googleapis.com/google.protobuf.Duration', 'value': b'\x08\x0c\x10\xdb\x07'}]}, 'last_error_time': {}, 'last_replication_time': {}, 'soft_failover_start_time': {}}, 'scheduling_policy': {'concurrency': 1195, 'max_slots': 986}} - # The version of a generated dependency at test runtime may differ from the version used during generation. - # Delete any fields which are not present in the current runtime dependency - # See https://github.com/googleapis/gapic-generator-python/issues/1748 - - # Determine if the message type is proto-plus or protobuf - test_field = gcbr_reservation.UpdateReservationRequest.meta.fields["reservation"] - - def get_message_fields(field): - # Given a field which is a message (composite type), return a list with - # all the fields of the message. - # If the field is not a composite type, return an empty list. - message_fields = [] - - if hasattr(field, "message") and field.message: - is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") - - if is_field_type_proto_plus_type: - message_fields = field.message.meta.fields.values() - # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types - else: # pragma: NO COVER - message_fields = field.message.DESCRIPTOR.fields - return message_fields - - runtime_nested_fields = [ - (field.name, nested_field.name) - for field in get_message_fields(test_field) - for nested_field in get_message_fields(field) - ] - - subfields_not_in_runtime = [] - - # For each item in the sample request, create a list of sub fields which are not present at runtime - # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for field, value in request_init["reservation"].items(): # pragma: NO COVER - result = None - is_repeated = False - # For repeated fields - if isinstance(value, list) and len(value): - is_repeated = True - result = value[0] - # For fields where the type is another message - if isinstance(value, dict): - result = value - - if result and hasattr(result, "keys"): - for subfield in result.keys(): - if (field, subfield) not in runtime_nested_fields: - subfields_not_in_runtime.append( - {"field": field, "subfield": subfield, "is_repeated": is_repeated} - ) - - # Remove fields from the sample request which are not present in the runtime version of the dependency - # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER - field = subfield_to_delete.get("field") - field_repeated = subfield_to_delete.get("is_repeated") - subfield = subfield_to_delete.get("subfield") - if subfield: - if field_repeated: - for i in range(0, len(request_init["reservation"][field])): - del request_init["reservation"][field][i][subfield] - else: - del request_init["reservation"][field][subfield] - 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 = gcbr_reservation.Reservation( - name='name_value', - slot_capacity=1391, - ignore_idle_slots=True, - concurrency=1195, - multi_region_auxiliary=True, - edition=gcbr_reservation.Edition.STANDARD, - primary_location='primary_location_value', - secondary_location='secondary_location_value', - original_primary_location='original_primary_location_value', - max_slots=986, - scaling_mode=gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, - reservation_group='reservation_group_value', - ) - - # Wrap the value into a proper Response obj - response_value = mock.Mock() - response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = gcbr_reservation.Reservation.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value.content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.update_reservation(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, gcbr_reservation.Reservation) - assert response.name == 'name_value' - assert response.slot_capacity == 1391 - assert response.ignore_idle_slots is True - assert response.concurrency == 1195 - assert response.multi_region_auxiliary is True - assert response.edition == gcbr_reservation.Edition.STANDARD - assert response.primary_location == 'primary_location_value' - assert response.secondary_location == 'secondary_location_value' - assert response.original_primary_location == 'original_primary_location_value' - assert response.max_slots == 986 - assert response.scaling_mode == gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY - assert response.reservation_group == 'reservation_group_value' - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_update_reservation_rest_interceptors(null_interceptor): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), - ) - client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_update_reservation") as post, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "post_update_reservation_with_metadata") as post_with_metadata, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_update_reservation") as pre: - pre.assert_not_called() - post.assert_not_called() - post_with_metadata.assert_not_called() - pb_message = gcbr_reservation.UpdateReservationRequest.pb(gcbr_reservation.UpdateReservationRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = mock.Mock() - req.return_value.status_code = 200 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = gcbr_reservation.Reservation.to_json(gcbr_reservation.Reservation()) - req.return_value.content = return_value - - request = gcbr_reservation.UpdateReservationRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = gcbr_reservation.Reservation() - post_with_metadata.return_value = gcbr_reservation.Reservation(), metadata - - client.update_reservation(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - post_with_metadata.assert_called_once() - - -def test_failover_reservation_rest_bad_request(request_type=reservation.FailoverReservationRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/reservations/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 = mock.Mock() - json_return_value = '' - response_value.json = mock.Mock(return_value={}) - response_value.status_code = 400 - response_value.request = mock.Mock() - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.failover_reservation(request) - - -@pytest.mark.parametrize("request_type", [ - reservation.FailoverReservationRequest, - dict, -]) -def test_failover_reservation_rest_call_success(request_type): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/reservations/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 = reservation.Reservation( - name='name_value', - slot_capacity=1391, - ignore_idle_slots=True, - concurrency=1195, - multi_region_auxiliary=True, - edition=reservation.Edition.STANDARD, - primary_location='primary_location_value', - secondary_location='secondary_location_value', - original_primary_location='original_primary_location_value', - max_slots=986, - scaling_mode=reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, - reservation_group='reservation_group_value', - ) - - # Wrap the value into a proper Response obj - response_value = mock.Mock() - response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = reservation.Reservation.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value.content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.failover_reservation(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.Reservation) - assert response.name == 'name_value' - assert response.slot_capacity == 1391 - assert response.ignore_idle_slots is True - assert response.concurrency == 1195 - assert response.multi_region_auxiliary is True - assert response.edition == reservation.Edition.STANDARD - assert response.primary_location == 'primary_location_value' - assert response.secondary_location == 'secondary_location_value' - assert response.original_primary_location == 'original_primary_location_value' - assert response.max_slots == 986 - assert response.scaling_mode == reservation.Reservation.ScalingMode.AUTOSCALE_ONLY - assert response.reservation_group == 'reservation_group_value' - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_failover_reservation_rest_interceptors(null_interceptor): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), - ) - client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_failover_reservation") as post, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "post_failover_reservation_with_metadata") as post_with_metadata, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_failover_reservation") as pre: - pre.assert_not_called() - post.assert_not_called() - post_with_metadata.assert_not_called() - pb_message = reservation.FailoverReservationRequest.pb(reservation.FailoverReservationRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = mock.Mock() - req.return_value.status_code = 200 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.Reservation.to_json(reservation.Reservation()) - req.return_value.content = return_value - - request = reservation.FailoverReservationRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = reservation.Reservation() - post_with_metadata.return_value = reservation.Reservation(), metadata - - client.failover_reservation(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - post_with_metadata.assert_called_once() - - -def test_create_capacity_commitment_rest_bad_request(request_type=reservation.CreateCapacityCommitmentRequest): - client = ReservationServiceClient( - 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 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 = mock.Mock() - json_return_value = '' - response_value.json = mock.Mock(return_value={}) - response_value.status_code = 400 - response_value.request = mock.Mock() - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.create_capacity_commitment(request) - - -@pytest.mark.parametrize("request_type", [ - reservation.CreateCapacityCommitmentRequest, - dict, -]) -def test_create_capacity_commitment_rest_call_success(request_type): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - request_init["capacity_commitment"] = {'name': 'name_value', 'slot_count': 1098, 'plan': 3, 'state': 1, 'commitment_start_time': {'seconds': 751, 'nanos': 543}, 'commitment_end_time': {}, 'failure_status': {'code': 411, 'message': 'message_value', 'details': [{'type_url': 'type.googleapis.com/google.protobuf.Duration', 'value': b'\x08\x0c\x10\xdb\x07'}]}, 'renewal_plan': 3, 'multi_region_auxiliary': True, 'edition': 1, 'is_flat_rate': True} - # The version of a generated dependency at test runtime may differ from the version used during generation. - # Delete any fields which are not present in the current runtime dependency - # See https://github.com/googleapis/gapic-generator-python/issues/1748 - - # Determine if the message type is proto-plus or protobuf - test_field = reservation.CreateCapacityCommitmentRequest.meta.fields["capacity_commitment"] - - def get_message_fields(field): - # Given a field which is a message (composite type), return a list with - # all the fields of the message. - # If the field is not a composite type, return an empty list. - message_fields = [] - - if hasattr(field, "message") and field.message: - is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") - - if is_field_type_proto_plus_type: - message_fields = field.message.meta.fields.values() - # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types - else: # pragma: NO COVER - message_fields = field.message.DESCRIPTOR.fields - return message_fields - - runtime_nested_fields = [ - (field.name, nested_field.name) - for field in get_message_fields(test_field) - for nested_field in get_message_fields(field) - ] - - subfields_not_in_runtime = [] - - # For each item in the sample request, create a list of sub fields which are not present at runtime - # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for field, value in request_init["capacity_commitment"].items(): # pragma: NO COVER - result = None - is_repeated = False - # For repeated fields - if isinstance(value, list) and len(value): - is_repeated = True - result = value[0] - # For fields where the type is another message - if isinstance(value, dict): - result = value - - if result and hasattr(result, "keys"): - for subfield in result.keys(): - if (field, subfield) not in runtime_nested_fields: - subfields_not_in_runtime.append( - {"field": field, "subfield": subfield, "is_repeated": is_repeated} - ) - - # Remove fields from the sample request which are not present in the runtime version of the dependency - # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER - field = subfield_to_delete.get("field") - field_repeated = subfield_to_delete.get("is_repeated") - subfield = subfield_to_delete.get("subfield") - if subfield: - if field_repeated: - for i in range(0, len(request_init["capacity_commitment"][field])): - del request_init["capacity_commitment"][field][i][subfield] - else: - del request_init["capacity_commitment"][field][subfield] - 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 = reservation.CapacityCommitment( - name='name_value', - slot_count=1098, - plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - state=reservation.CapacityCommitment.State.PENDING, - renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - multi_region_auxiliary=True, - edition=reservation.Edition.STANDARD, - is_flat_rate=True, - ) - - # Wrap the value into a proper Response obj - response_value = mock.Mock() - response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = reservation.CapacityCommitment.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value.content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.create_capacity_commitment(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.CapacityCommitment) - assert response.name == 'name_value' - assert response.slot_count == 1098 - assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.state == reservation.CapacityCommitment.State.PENDING - assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.multi_region_auxiliary is True - assert response.edition == reservation.Edition.STANDARD - assert response.is_flat_rate is True - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_create_capacity_commitment_rest_interceptors(null_interceptor): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), - ) - client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_create_capacity_commitment") as post, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "post_create_capacity_commitment_with_metadata") as post_with_metadata, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_create_capacity_commitment") as pre: - pre.assert_not_called() - post.assert_not_called() - post_with_metadata.assert_not_called() - pb_message = reservation.CreateCapacityCommitmentRequest.pb(reservation.CreateCapacityCommitmentRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = mock.Mock() - req.return_value.status_code = 200 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.CapacityCommitment.to_json(reservation.CapacityCommitment()) - req.return_value.content = return_value - - request = reservation.CreateCapacityCommitmentRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = reservation.CapacityCommitment() - post_with_metadata.return_value = reservation.CapacityCommitment(), metadata - - client.create_capacity_commitment(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - post_with_metadata.assert_called_once() - - -def test_list_capacity_commitments_rest_bad_request(request_type=reservation.ListCapacityCommitmentsRequest): - client = ReservationServiceClient( - 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 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 = mock.Mock() - json_return_value = '' - response_value.json = mock.Mock(return_value={}) - response_value.status_code = 400 - response_value.request = mock.Mock() - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.list_capacity_commitments(request) - - -@pytest.mark.parametrize("request_type", [ - reservation.ListCapacityCommitmentsRequest, - dict, -]) -def test_list_capacity_commitments_rest_call_success(request_type): - client = ReservationServiceClient( - 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 = reservation.ListCapacityCommitmentsResponse( - next_page_token='next_page_token_value', - ) - - # Wrap the value into a proper Response obj - response_value = mock.Mock() - response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = reservation.ListCapacityCommitmentsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value.content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.list_capacity_commitments(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListCapacityCommitmentsPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_list_capacity_commitments_rest_interceptors(null_interceptor): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), - ) - client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_list_capacity_commitments") as post, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "post_list_capacity_commitments_with_metadata") as post_with_metadata, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_list_capacity_commitments") as pre: - pre.assert_not_called() - post.assert_not_called() - post_with_metadata.assert_not_called() - pb_message = reservation.ListCapacityCommitmentsRequest.pb(reservation.ListCapacityCommitmentsRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = mock.Mock() - req.return_value.status_code = 200 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.ListCapacityCommitmentsResponse.to_json(reservation.ListCapacityCommitmentsResponse()) - req.return_value.content = return_value - - request = reservation.ListCapacityCommitmentsRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = reservation.ListCapacityCommitmentsResponse() - post_with_metadata.return_value = reservation.ListCapacityCommitmentsResponse(), metadata - - client.list_capacity_commitments(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - post_with_metadata.assert_called_once() - - -def test_get_capacity_commitment_rest_bad_request(request_type=reservation.GetCapacityCommitmentRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/capacityCommitments/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 = mock.Mock() - json_return_value = '' - response_value.json = mock.Mock(return_value={}) - response_value.status_code = 400 - response_value.request = mock.Mock() - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.get_capacity_commitment(request) - - -@pytest.mark.parametrize("request_type", [ - reservation.GetCapacityCommitmentRequest, - dict, -]) -def test_get_capacity_commitment_rest_call_success(request_type): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/capacityCommitments/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 = reservation.CapacityCommitment( - name='name_value', - slot_count=1098, - plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - state=reservation.CapacityCommitment.State.PENDING, - renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - multi_region_auxiliary=True, - edition=reservation.Edition.STANDARD, - is_flat_rate=True, - ) - - # Wrap the value into a proper Response obj - response_value = mock.Mock() - response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = reservation.CapacityCommitment.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value.content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.get_capacity_commitment(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.CapacityCommitment) - assert response.name == 'name_value' - assert response.slot_count == 1098 - assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.state == reservation.CapacityCommitment.State.PENDING - assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.multi_region_auxiliary is True - assert response.edition == reservation.Edition.STANDARD - assert response.is_flat_rate is True - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_get_capacity_commitment_rest_interceptors(null_interceptor): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), - ) - client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_get_capacity_commitment") as post, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "post_get_capacity_commitment_with_metadata") as post_with_metadata, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_get_capacity_commitment") as pre: - pre.assert_not_called() - post.assert_not_called() - post_with_metadata.assert_not_called() - pb_message = reservation.GetCapacityCommitmentRequest.pb(reservation.GetCapacityCommitmentRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = mock.Mock() - req.return_value.status_code = 200 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.CapacityCommitment.to_json(reservation.CapacityCommitment()) - req.return_value.content = return_value - - request = reservation.GetCapacityCommitmentRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = reservation.CapacityCommitment() - post_with_metadata.return_value = reservation.CapacityCommitment(), metadata - - client.get_capacity_commitment(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - post_with_metadata.assert_called_once() - - -def test_delete_capacity_commitment_rest_bad_request(request_type=reservation.DeleteCapacityCommitmentRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/capacityCommitments/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 = mock.Mock() - json_return_value = '' - response_value.json = mock.Mock(return_value={}) - response_value.status_code = 400 - response_value.request = mock.Mock() - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.delete_capacity_commitment(request) - - -@pytest.mark.parametrize("request_type", [ - reservation.DeleteCapacityCommitmentRequest, - dict, -]) -def test_delete_capacity_commitment_rest_call_success(request_type): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/capacityCommitments/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 = mock.Mock() - response_value.status_code = 200 - json_return_value = '' - response_value.content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.delete_capacity_commitment(request) - - # Establish that the response is the type that we expect. - assert response is None - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_delete_capacity_commitment_rest_interceptors(null_interceptor): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), - ) - client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "pre_delete_capacity_commitment") as pre: - pre.assert_not_called() - pb_message = reservation.DeleteCapacityCommitmentRequest.pb(reservation.DeleteCapacityCommitmentRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = mock.Mock() - req.return_value.status_code = 200 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - request = reservation.DeleteCapacityCommitmentRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - - client.delete_capacity_commitment(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - - -def test_update_capacity_commitment_rest_bad_request(request_type=reservation.UpdateCapacityCommitmentRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - # send a request that will satisfy transcoding - request_init = {'capacity_commitment': {'name': 'projects/sample1/locations/sample2/capacityCommitments/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 = mock.Mock() - json_return_value = '' - response_value.json = mock.Mock(return_value={}) - response_value.status_code = 400 - response_value.request = mock.Mock() - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.update_capacity_commitment(request) - - -@pytest.mark.parametrize("request_type", [ - reservation.UpdateCapacityCommitmentRequest, - dict, -]) -def test_update_capacity_commitment_rest_call_success(request_type): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - - # send a request that will satisfy transcoding - request_init = {'capacity_commitment': {'name': 'projects/sample1/locations/sample2/capacityCommitments/sample3'}} - request_init["capacity_commitment"] = {'name': 'projects/sample1/locations/sample2/capacityCommitments/sample3', 'slot_count': 1098, 'plan': 3, 'state': 1, 'commitment_start_time': {'seconds': 751, 'nanos': 543}, 'commitment_end_time': {}, 'failure_status': {'code': 411, 'message': 'message_value', 'details': [{'type_url': 'type.googleapis.com/google.protobuf.Duration', 'value': b'\x08\x0c\x10\xdb\x07'}]}, 'renewal_plan': 3, 'multi_region_auxiliary': True, 'edition': 1, 'is_flat_rate': True} - # The version of a generated dependency at test runtime may differ from the version used during generation. - # Delete any fields which are not present in the current runtime dependency - # See https://github.com/googleapis/gapic-generator-python/issues/1748 - - # Determine if the message type is proto-plus or protobuf - test_field = reservation.UpdateCapacityCommitmentRequest.meta.fields["capacity_commitment"] - - def get_message_fields(field): - # Given a field which is a message (composite type), return a list with - # all the fields of the message. - # If the field is not a composite type, return an empty list. - message_fields = [] - - if hasattr(field, "message") and field.message: - is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") - - if is_field_type_proto_plus_type: - message_fields = field.message.meta.fields.values() - # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types - else: # pragma: NO COVER - message_fields = field.message.DESCRIPTOR.fields - return message_fields - - runtime_nested_fields = [ - (field.name, nested_field.name) - for field in get_message_fields(test_field) - for nested_field in get_message_fields(field) - ] - - subfields_not_in_runtime = [] - - # For each item in the sample request, create a list of sub fields which are not present at runtime - # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for field, value in request_init["capacity_commitment"].items(): # pragma: NO COVER - result = None - is_repeated = False - # For repeated fields - if isinstance(value, list) and len(value): - is_repeated = True - result = value[0] - # For fields where the type is another message - if isinstance(value, dict): - result = value - - if result and hasattr(result, "keys"): - for subfield in result.keys(): - if (field, subfield) not in runtime_nested_fields: - subfields_not_in_runtime.append( - {"field": field, "subfield": subfield, "is_repeated": is_repeated} - ) - - # Remove fields from the sample request which are not present in the runtime version of the dependency - # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER - field = subfield_to_delete.get("field") - field_repeated = subfield_to_delete.get("is_repeated") - subfield = subfield_to_delete.get("subfield") - if subfield: - if field_repeated: - for i in range(0, len(request_init["capacity_commitment"][field])): - del request_init["capacity_commitment"][field][i][subfield] - else: - del request_init["capacity_commitment"][field][subfield] - 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 = reservation.CapacityCommitment( - name='name_value', - slot_count=1098, - plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - state=reservation.CapacityCommitment.State.PENDING, - renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - multi_region_auxiliary=True, - edition=reservation.Edition.STANDARD, - is_flat_rate=True, - ) - - # Wrap the value into a proper Response obj - response_value = mock.Mock() - response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = reservation.CapacityCommitment.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value.content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.update_capacity_commitment(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.CapacityCommitment) - assert response.name == 'name_value' - assert response.slot_count == 1098 - assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.state == reservation.CapacityCommitment.State.PENDING - assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.multi_region_auxiliary is True - assert response.edition == reservation.Edition.STANDARD - assert response.is_flat_rate is True - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_update_capacity_commitment_rest_interceptors(null_interceptor): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), - ) - client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_update_capacity_commitment") as post, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "post_update_capacity_commitment_with_metadata") as post_with_metadata, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_update_capacity_commitment") as pre: - pre.assert_not_called() - post.assert_not_called() - post_with_metadata.assert_not_called() - pb_message = reservation.UpdateCapacityCommitmentRequest.pb(reservation.UpdateCapacityCommitmentRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = mock.Mock() - req.return_value.status_code = 200 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.CapacityCommitment.to_json(reservation.CapacityCommitment()) - req.return_value.content = return_value - - request = reservation.UpdateCapacityCommitmentRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = reservation.CapacityCommitment() - post_with_metadata.return_value = reservation.CapacityCommitment(), metadata - - client.update_capacity_commitment(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - post_with_metadata.assert_called_once() - - -def test_split_capacity_commitment_rest_bad_request(request_type=reservation.SplitCapacityCommitmentRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/capacityCommitments/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 = mock.Mock() - json_return_value = '' - response_value.json = mock.Mock(return_value={}) - response_value.status_code = 400 - response_value.request = mock.Mock() - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.split_capacity_commitment(request) - - -@pytest.mark.parametrize("request_type", [ - reservation.SplitCapacityCommitmentRequest, - dict, -]) -def test_split_capacity_commitment_rest_call_success(request_type): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/capacityCommitments/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 = reservation.SplitCapacityCommitmentResponse( - ) - - # Wrap the value into a proper Response obj - response_value = mock.Mock() - response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = reservation.SplitCapacityCommitmentResponse.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value.content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.split_capacity_commitment(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.SplitCapacityCommitmentResponse) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_split_capacity_commitment_rest_interceptors(null_interceptor): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), - ) - client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_split_capacity_commitment") as post, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "post_split_capacity_commitment_with_metadata") as post_with_metadata, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_split_capacity_commitment") as pre: - pre.assert_not_called() - post.assert_not_called() - post_with_metadata.assert_not_called() - pb_message = reservation.SplitCapacityCommitmentRequest.pb(reservation.SplitCapacityCommitmentRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = mock.Mock() - req.return_value.status_code = 200 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.SplitCapacityCommitmentResponse.to_json(reservation.SplitCapacityCommitmentResponse()) - req.return_value.content = return_value - - request = reservation.SplitCapacityCommitmentRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = reservation.SplitCapacityCommitmentResponse() - post_with_metadata.return_value = reservation.SplitCapacityCommitmentResponse(), metadata - - client.split_capacity_commitment(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - post_with_metadata.assert_called_once() - - -def test_merge_capacity_commitments_rest_bad_request(request_type=reservation.MergeCapacityCommitmentsRequest): - client = ReservationServiceClient( - 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 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 = mock.Mock() - json_return_value = '' - response_value.json = mock.Mock(return_value={}) - response_value.status_code = 400 - response_value.request = mock.Mock() - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.merge_capacity_commitments(request) - - -@pytest.mark.parametrize("request_type", [ - reservation.MergeCapacityCommitmentsRequest, - dict, -]) -def test_merge_capacity_commitments_rest_call_success(request_type): - client = ReservationServiceClient( - 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 = reservation.CapacityCommitment( - name='name_value', - slot_count=1098, - plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - state=reservation.CapacityCommitment.State.PENDING, - renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - multi_region_auxiliary=True, - edition=reservation.Edition.STANDARD, - is_flat_rate=True, - ) - - # Wrap the value into a proper Response obj - response_value = mock.Mock() - response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = reservation.CapacityCommitment.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value.content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.merge_capacity_commitments(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.CapacityCommitment) - assert response.name == 'name_value' - assert response.slot_count == 1098 - assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.state == reservation.CapacityCommitment.State.PENDING - assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.multi_region_auxiliary is True - assert response.edition == reservation.Edition.STANDARD - assert response.is_flat_rate is True - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_merge_capacity_commitments_rest_interceptors(null_interceptor): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), - ) - client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_merge_capacity_commitments") as post, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "post_merge_capacity_commitments_with_metadata") as post_with_metadata, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_merge_capacity_commitments") as pre: - pre.assert_not_called() - post.assert_not_called() - post_with_metadata.assert_not_called() - pb_message = reservation.MergeCapacityCommitmentsRequest.pb(reservation.MergeCapacityCommitmentsRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = mock.Mock() - req.return_value.status_code = 200 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.CapacityCommitment.to_json(reservation.CapacityCommitment()) - req.return_value.content = return_value - - request = reservation.MergeCapacityCommitmentsRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = reservation.CapacityCommitment() - post_with_metadata.return_value = reservation.CapacityCommitment(), metadata - - client.merge_capacity_commitments(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - post_with_metadata.assert_called_once() - - -def test_create_assignment_rest_bad_request(request_type=reservation.CreateAssignmentRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2/reservations/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 = mock.Mock() - json_return_value = '' - response_value.json = mock.Mock(return_value={}) - response_value.status_code = 400 - response_value.request = mock.Mock() - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.create_assignment(request) - - -@pytest.mark.parametrize("request_type", [ - reservation.CreateAssignmentRequest, - dict, -]) -def test_create_assignment_rest_call_success(request_type): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2/reservations/sample3'} - request_init["assignment"] = {'name': 'name_value', 'assignee': 'assignee_value', 'job_type': 1, 'state': 1, 'enable_gemini_in_bigquery': True, 'scheduling_policy': {'concurrency': 1195, 'max_slots': 986}} - # The version of a generated dependency at test runtime may differ from the version used during generation. - # Delete any fields which are not present in the current runtime dependency - # See https://github.com/googleapis/gapic-generator-python/issues/1748 - - # Determine if the message type is proto-plus or protobuf - test_field = reservation.CreateAssignmentRequest.meta.fields["assignment"] - - def get_message_fields(field): - # Given a field which is a message (composite type), return a list with - # all the fields of the message. - # If the field is not a composite type, return an empty list. - message_fields = [] - - if hasattr(field, "message") and field.message: - is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") - - if is_field_type_proto_plus_type: - message_fields = field.message.meta.fields.values() - # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types - else: # pragma: NO COVER - message_fields = field.message.DESCRIPTOR.fields - return message_fields - - runtime_nested_fields = [ - (field.name, nested_field.name) - for field in get_message_fields(test_field) - for nested_field in get_message_fields(field) - ] - - subfields_not_in_runtime = [] - - # For each item in the sample request, create a list of sub fields which are not present at runtime - # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for field, value in request_init["assignment"].items(): # pragma: NO COVER - result = None - is_repeated = False - # For repeated fields - if isinstance(value, list) and len(value): - is_repeated = True - result = value[0] - # For fields where the type is another message - if isinstance(value, dict): - result = value - - if result and hasattr(result, "keys"): - for subfield in result.keys(): - if (field, subfield) not in runtime_nested_fields: - subfields_not_in_runtime.append( - {"field": field, "subfield": subfield, "is_repeated": is_repeated} - ) - - # Remove fields from the sample request which are not present in the runtime version of the dependency - # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER - field = subfield_to_delete.get("field") - field_repeated = subfield_to_delete.get("is_repeated") - subfield = subfield_to_delete.get("subfield") - if subfield: - if field_repeated: - for i in range(0, len(request_init["assignment"][field])): - del request_init["assignment"][field][i][subfield] - else: - del request_init["assignment"][field][subfield] - 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 = reservation.Assignment( - name='name_value', - assignee='assignee_value', - job_type=reservation.Assignment.JobType.PIPELINE, - state=reservation.Assignment.State.PENDING, - enable_gemini_in_bigquery=True, - ) - - # Wrap the value into a proper Response obj - response_value = mock.Mock() - response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = reservation.Assignment.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value.content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.create_assignment(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.Assignment) - assert response.name == 'name_value' - assert response.assignee == 'assignee_value' - assert response.job_type == reservation.Assignment.JobType.PIPELINE - assert response.state == reservation.Assignment.State.PENDING - assert response.enable_gemini_in_bigquery is True - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_create_assignment_rest_interceptors(null_interceptor): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), - ) - client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_create_assignment") as post, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "post_create_assignment_with_metadata") as post_with_metadata, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_create_assignment") as pre: - pre.assert_not_called() - post.assert_not_called() - post_with_metadata.assert_not_called() - pb_message = reservation.CreateAssignmentRequest.pb(reservation.CreateAssignmentRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = mock.Mock() - req.return_value.status_code = 200 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.Assignment.to_json(reservation.Assignment()) - req.return_value.content = return_value - - request = reservation.CreateAssignmentRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = reservation.Assignment() - post_with_metadata.return_value = reservation.Assignment(), metadata - - client.create_assignment(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - post_with_metadata.assert_called_once() - - -def test_list_assignments_rest_bad_request(request_type=reservation.ListAssignmentsRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2/reservations/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 = mock.Mock() - json_return_value = '' - response_value.json = mock.Mock(return_value={}) - response_value.status_code = 400 - response_value.request = mock.Mock() - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.list_assignments(request) - - -@pytest.mark.parametrize("request_type", [ - reservation.ListAssignmentsRequest, - dict, -]) -def test_list_assignments_rest_call_success(request_type): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2/reservations/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 = reservation.ListAssignmentsResponse( - next_page_token='next_page_token_value', - ) - - # Wrap the value into a proper Response obj - response_value = mock.Mock() - response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = reservation.ListAssignmentsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value.content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.list_assignments(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListAssignmentsPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_list_assignments_rest_interceptors(null_interceptor): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), - ) - client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_list_assignments") as post, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "post_list_assignments_with_metadata") as post_with_metadata, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_list_assignments") as pre: - pre.assert_not_called() - post.assert_not_called() - post_with_metadata.assert_not_called() - pb_message = reservation.ListAssignmentsRequest.pb(reservation.ListAssignmentsRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = mock.Mock() - req.return_value.status_code = 200 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.ListAssignmentsResponse.to_json(reservation.ListAssignmentsResponse()) - req.return_value.content = return_value - - request = reservation.ListAssignmentsRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = reservation.ListAssignmentsResponse() - post_with_metadata.return_value = reservation.ListAssignmentsResponse(), metadata - - client.list_assignments(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - post_with_metadata.assert_called_once() - - -def test_delete_assignment_rest_bad_request(request_type=reservation.DeleteAssignmentRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/reservations/sample3/assignments/sample4'} - 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 = mock.Mock() - json_return_value = '' - response_value.json = mock.Mock(return_value={}) - response_value.status_code = 400 - response_value.request = mock.Mock() - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.delete_assignment(request) - - -@pytest.mark.parametrize("request_type", [ - reservation.DeleteAssignmentRequest, - dict, -]) -def test_delete_assignment_rest_call_success(request_type): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/reservations/sample3/assignments/sample4'} - 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 = mock.Mock() - response_value.status_code = 200 - json_return_value = '' - response_value.content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.delete_assignment(request) - - # Establish that the response is the type that we expect. - assert response is None - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_delete_assignment_rest_interceptors(null_interceptor): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), - ) - client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "pre_delete_assignment") as pre: - pre.assert_not_called() - pb_message = reservation.DeleteAssignmentRequest.pb(reservation.DeleteAssignmentRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = mock.Mock() - req.return_value.status_code = 200 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - request = reservation.DeleteAssignmentRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - - client.delete_assignment(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - - -def test_search_assignments_rest_bad_request(request_type=reservation.SearchAssignmentsRequest): - client = ReservationServiceClient( - 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 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 = mock.Mock() - json_return_value = '' - response_value.json = mock.Mock(return_value={}) - response_value.status_code = 400 - response_value.request = mock.Mock() - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.search_assignments(request) - - -@pytest.mark.parametrize("request_type", [ - reservation.SearchAssignmentsRequest, - dict, -]) -def test_search_assignments_rest_call_success(request_type): - client = ReservationServiceClient( - 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 = reservation.SearchAssignmentsResponse( - next_page_token='next_page_token_value', - ) - - # Wrap the value into a proper Response obj - response_value = mock.Mock() - response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = reservation.SearchAssignmentsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value.content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.search_assignments(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.SearchAssignmentsPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_search_assignments_rest_interceptors(null_interceptor): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), - ) - client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_search_assignments") as post, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "post_search_assignments_with_metadata") as post_with_metadata, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_search_assignments") as pre: - pre.assert_not_called() - post.assert_not_called() - post_with_metadata.assert_not_called() - pb_message = reservation.SearchAssignmentsRequest.pb(reservation.SearchAssignmentsRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = mock.Mock() - req.return_value.status_code = 200 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.SearchAssignmentsResponse.to_json(reservation.SearchAssignmentsResponse()) - req.return_value.content = return_value - - request = reservation.SearchAssignmentsRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = reservation.SearchAssignmentsResponse() - post_with_metadata.return_value = reservation.SearchAssignmentsResponse(), metadata - - client.search_assignments(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - post_with_metadata.assert_called_once() - - -def test_search_all_assignments_rest_bad_request(request_type=reservation.SearchAllAssignmentsRequest): - client = ReservationServiceClient( - 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 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 = mock.Mock() - json_return_value = '' - response_value.json = mock.Mock(return_value={}) - response_value.status_code = 400 - response_value.request = mock.Mock() - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.search_all_assignments(request) - - -@pytest.mark.parametrize("request_type", [ - reservation.SearchAllAssignmentsRequest, - dict, -]) -def test_search_all_assignments_rest_call_success(request_type): - client = ReservationServiceClient( - 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 = reservation.SearchAllAssignmentsResponse( - next_page_token='next_page_token_value', - ) - - # Wrap the value into a proper Response obj - response_value = mock.Mock() - response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = reservation.SearchAllAssignmentsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value.content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.search_all_assignments(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.SearchAllAssignmentsPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_search_all_assignments_rest_interceptors(null_interceptor): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), - ) - client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_search_all_assignments") as post, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "post_search_all_assignments_with_metadata") as post_with_metadata, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_search_all_assignments") as pre: - pre.assert_not_called() - post.assert_not_called() - post_with_metadata.assert_not_called() - pb_message = reservation.SearchAllAssignmentsRequest.pb(reservation.SearchAllAssignmentsRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = mock.Mock() - req.return_value.status_code = 200 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.SearchAllAssignmentsResponse.to_json(reservation.SearchAllAssignmentsResponse()) - req.return_value.content = return_value - - request = reservation.SearchAllAssignmentsRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = reservation.SearchAllAssignmentsResponse() - post_with_metadata.return_value = reservation.SearchAllAssignmentsResponse(), metadata - - client.search_all_assignments(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - post_with_metadata.assert_called_once() - - -def test_move_assignment_rest_bad_request(request_type=reservation.MoveAssignmentRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/reservations/sample3/assignments/sample4'} - 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 = mock.Mock() - json_return_value = '' - response_value.json = mock.Mock(return_value={}) - response_value.status_code = 400 - response_value.request = mock.Mock() - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.move_assignment(request) - - -@pytest.mark.parametrize("request_type", [ - reservation.MoveAssignmentRequest, - dict, -]) -def test_move_assignment_rest_call_success(request_type): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/reservations/sample3/assignments/sample4'} - 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 = reservation.Assignment( - name='name_value', - assignee='assignee_value', - job_type=reservation.Assignment.JobType.PIPELINE, - state=reservation.Assignment.State.PENDING, - enable_gemini_in_bigquery=True, - ) - - # Wrap the value into a proper Response obj - response_value = mock.Mock() - response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = reservation.Assignment.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value.content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.move_assignment(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.Assignment) - assert response.name == 'name_value' - assert response.assignee == 'assignee_value' - assert response.job_type == reservation.Assignment.JobType.PIPELINE - assert response.state == reservation.Assignment.State.PENDING - assert response.enable_gemini_in_bigquery is True - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_move_assignment_rest_interceptors(null_interceptor): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), - ) - client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_move_assignment") as post, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "post_move_assignment_with_metadata") as post_with_metadata, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_move_assignment") as pre: - pre.assert_not_called() - post.assert_not_called() - post_with_metadata.assert_not_called() - pb_message = reservation.MoveAssignmentRequest.pb(reservation.MoveAssignmentRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = mock.Mock() - req.return_value.status_code = 200 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.Assignment.to_json(reservation.Assignment()) - req.return_value.content = return_value - - request = reservation.MoveAssignmentRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = reservation.Assignment() - post_with_metadata.return_value = reservation.Assignment(), metadata - - client.move_assignment(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - post_with_metadata.assert_called_once() - - -def test_update_assignment_rest_bad_request(request_type=reservation.UpdateAssignmentRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - # send a request that will satisfy transcoding - request_init = {'assignment': {'name': 'projects/sample1/locations/sample2/reservations/sample3/assignments/sample4'}} - 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 = mock.Mock() - json_return_value = '' - response_value.json = mock.Mock(return_value={}) - response_value.status_code = 400 - response_value.request = mock.Mock() - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.update_assignment(request) - - -@pytest.mark.parametrize("request_type", [ - reservation.UpdateAssignmentRequest, - dict, -]) -def test_update_assignment_rest_call_success(request_type): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - - # send a request that will satisfy transcoding - request_init = {'assignment': {'name': 'projects/sample1/locations/sample2/reservations/sample3/assignments/sample4'}} - request_init["assignment"] = {'name': 'projects/sample1/locations/sample2/reservations/sample3/assignments/sample4', 'assignee': 'assignee_value', 'job_type': 1, 'state': 1, 'enable_gemini_in_bigquery': True, 'scheduling_policy': {'concurrency': 1195, 'max_slots': 986}} - # The version of a generated dependency at test runtime may differ from the version used during generation. - # Delete any fields which are not present in the current runtime dependency - # See https://github.com/googleapis/gapic-generator-python/issues/1748 - - # Determine if the message type is proto-plus or protobuf - test_field = reservation.UpdateAssignmentRequest.meta.fields["assignment"] - - def get_message_fields(field): - # Given a field which is a message (composite type), return a list with - # all the fields of the message. - # If the field is not a composite type, return an empty list. - message_fields = [] - - if hasattr(field, "message") and field.message: - is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") - - if is_field_type_proto_plus_type: - message_fields = field.message.meta.fields.values() - # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types - else: # pragma: NO COVER - message_fields = field.message.DESCRIPTOR.fields - return message_fields - - runtime_nested_fields = [ - (field.name, nested_field.name) - for field in get_message_fields(test_field) - for nested_field in get_message_fields(field) - ] - - subfields_not_in_runtime = [] - - # For each item in the sample request, create a list of sub fields which are not present at runtime - # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for field, value in request_init["assignment"].items(): # pragma: NO COVER - result = None - is_repeated = False - # For repeated fields - if isinstance(value, list) and len(value): - is_repeated = True - result = value[0] - # For fields where the type is another message - if isinstance(value, dict): - result = value - - if result and hasattr(result, "keys"): - for subfield in result.keys(): - if (field, subfield) not in runtime_nested_fields: - subfields_not_in_runtime.append( - {"field": field, "subfield": subfield, "is_repeated": is_repeated} - ) - - # Remove fields from the sample request which are not present in the runtime version of the dependency - # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER - field = subfield_to_delete.get("field") - field_repeated = subfield_to_delete.get("is_repeated") - subfield = subfield_to_delete.get("subfield") - if subfield: - if field_repeated: - for i in range(0, len(request_init["assignment"][field])): - del request_init["assignment"][field][i][subfield] - else: - del request_init["assignment"][field][subfield] - 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 = reservation.Assignment( - name='name_value', - assignee='assignee_value', - job_type=reservation.Assignment.JobType.PIPELINE, - state=reservation.Assignment.State.PENDING, - enable_gemini_in_bigquery=True, - ) - - # Wrap the value into a proper Response obj - response_value = mock.Mock() - response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = reservation.Assignment.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value.content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.update_assignment(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.Assignment) - assert response.name == 'name_value' - assert response.assignee == 'assignee_value' - assert response.job_type == reservation.Assignment.JobType.PIPELINE - assert response.state == reservation.Assignment.State.PENDING - assert response.enable_gemini_in_bigquery is True - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_update_assignment_rest_interceptors(null_interceptor): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), - ) - client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_update_assignment") as post, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "post_update_assignment_with_metadata") as post_with_metadata, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_update_assignment") as pre: - pre.assert_not_called() - post.assert_not_called() - post_with_metadata.assert_not_called() - pb_message = reservation.UpdateAssignmentRequest.pb(reservation.UpdateAssignmentRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = mock.Mock() - req.return_value.status_code = 200 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.Assignment.to_json(reservation.Assignment()) - req.return_value.content = return_value - - request = reservation.UpdateAssignmentRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = reservation.Assignment() - post_with_metadata.return_value = reservation.Assignment(), metadata - - client.update_assignment(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - post_with_metadata.assert_called_once() - - -def test_get_bi_reservation_rest_bad_request(request_type=reservation.GetBiReservationRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/biReservation'} - 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 = mock.Mock() - json_return_value = '' - response_value.json = mock.Mock(return_value={}) - response_value.status_code = 400 - response_value.request = mock.Mock() - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.get_bi_reservation(request) - - -@pytest.mark.parametrize("request_type", [ - reservation.GetBiReservationRequest, - dict, -]) -def test_get_bi_reservation_rest_call_success(request_type): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/biReservation'} - 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 = reservation.BiReservation( - name='name_value', - size=443, - ) - - # Wrap the value into a proper Response obj - response_value = mock.Mock() - response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = reservation.BiReservation.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value.content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.get_bi_reservation(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.BiReservation) - assert response.name == 'name_value' - assert response.size == 443 - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_get_bi_reservation_rest_interceptors(null_interceptor): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), - ) - client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_get_bi_reservation") as post, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "post_get_bi_reservation_with_metadata") as post_with_metadata, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_get_bi_reservation") as pre: - pre.assert_not_called() - post.assert_not_called() - post_with_metadata.assert_not_called() - pb_message = reservation.GetBiReservationRequest.pb(reservation.GetBiReservationRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = mock.Mock() - req.return_value.status_code = 200 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.BiReservation.to_json(reservation.BiReservation()) - req.return_value.content = return_value - - request = reservation.GetBiReservationRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = reservation.BiReservation() - post_with_metadata.return_value = reservation.BiReservation(), metadata - - client.get_bi_reservation(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - post_with_metadata.assert_called_once() - - -def test_update_bi_reservation_rest_bad_request(request_type=reservation.UpdateBiReservationRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - # send a request that will satisfy transcoding - request_init = {'bi_reservation': {'name': 'projects/sample1/locations/sample2/biReservation'}} - 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 = mock.Mock() - json_return_value = '' - response_value.json = mock.Mock(return_value={}) - response_value.status_code = 400 - response_value.request = mock.Mock() - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.update_bi_reservation(request) - - -@pytest.mark.parametrize("request_type", [ - reservation.UpdateBiReservationRequest, - dict, -]) -def test_update_bi_reservation_rest_call_success(request_type): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - - # send a request that will satisfy transcoding - request_init = {'bi_reservation': {'name': 'projects/sample1/locations/sample2/biReservation'}} - request_init["bi_reservation"] = {'name': 'projects/sample1/locations/sample2/biReservation', 'update_time': {'seconds': 751, 'nanos': 543}, 'size': 443, 'preferred_tables': [{'project_id': 'project_id_value', 'dataset_id': 'dataset_id_value', 'table_id': 'table_id_value'}]} - # The version of a generated dependency at test runtime may differ from the version used during generation. - # Delete any fields which are not present in the current runtime dependency - # See https://github.com/googleapis/gapic-generator-python/issues/1748 - - # Determine if the message type is proto-plus or protobuf - test_field = reservation.UpdateBiReservationRequest.meta.fields["bi_reservation"] - - def get_message_fields(field): - # Given a field which is a message (composite type), return a list with - # all the fields of the message. - # If the field is not a composite type, return an empty list. - message_fields = [] - - if hasattr(field, "message") and field.message: - is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") - - if is_field_type_proto_plus_type: - message_fields = field.message.meta.fields.values() - # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types - else: # pragma: NO COVER - message_fields = field.message.DESCRIPTOR.fields - return message_fields - - runtime_nested_fields = [ - (field.name, nested_field.name) - for field in get_message_fields(test_field) - for nested_field in get_message_fields(field) - ] - - subfields_not_in_runtime = [] - - # For each item in the sample request, create a list of sub fields which are not present at runtime - # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for field, value in request_init["bi_reservation"].items(): # pragma: NO COVER - result = None - is_repeated = False - # For repeated fields - if isinstance(value, list) and len(value): - is_repeated = True - result = value[0] - # For fields where the type is another message - if isinstance(value, dict): - result = value - - if result and hasattr(result, "keys"): - for subfield in result.keys(): - if (field, subfield) not in runtime_nested_fields: - subfields_not_in_runtime.append( - {"field": field, "subfield": subfield, "is_repeated": is_repeated} - ) - - # Remove fields from the sample request which are not present in the runtime version of the dependency - # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER - field = subfield_to_delete.get("field") - field_repeated = subfield_to_delete.get("is_repeated") - subfield = subfield_to_delete.get("subfield") - if subfield: - if field_repeated: - for i in range(0, len(request_init["bi_reservation"][field])): - del request_init["bi_reservation"][field][i][subfield] - else: - del request_init["bi_reservation"][field][subfield] - 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 = reservation.BiReservation( - name='name_value', - size=443, - ) - - # Wrap the value into a proper Response obj - response_value = mock.Mock() - response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = reservation.BiReservation.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value.content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.update_bi_reservation(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.BiReservation) - assert response.name == 'name_value' - assert response.size == 443 - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_update_bi_reservation_rest_interceptors(null_interceptor): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), - ) - client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_update_bi_reservation") as post, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "post_update_bi_reservation_with_metadata") as post_with_metadata, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_update_bi_reservation") as pre: - pre.assert_not_called() - post.assert_not_called() - post_with_metadata.assert_not_called() - pb_message = reservation.UpdateBiReservationRequest.pb(reservation.UpdateBiReservationRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = mock.Mock() - req.return_value.status_code = 200 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.BiReservation.to_json(reservation.BiReservation()) - req.return_value.content = return_value - - request = reservation.UpdateBiReservationRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = reservation.BiReservation() - post_with_metadata.return_value = reservation.BiReservation(), metadata - - client.update_bi_reservation(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - post_with_metadata.assert_called_once() - - -def test_get_iam_policy_rest_bad_request(request_type=iam_policy_pb2.GetIamPolicyRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - # send a request that will satisfy transcoding - request_init = {'resource': 'projects/sample1/locations/sample2/reservations/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 = mock.Mock() - json_return_value = '' - response_value.json = mock.Mock(return_value={}) - response_value.status_code = 400 - response_value.request = mock.Mock() - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.get_iam_policy(request) - - -@pytest.mark.parametrize("request_type", [ - iam_policy_pb2.GetIamPolicyRequest, - dict, -]) -def test_get_iam_policy_rest_call_success(request_type): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - - # send a request that will satisfy transcoding - request_init = {'resource': 'projects/sample1/locations/sample2/reservations/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 = policy_pb2.Policy( - version=774, - etag=b'etag_blob', - ) - - # Wrap the value into a proper Response obj - response_value = mock.Mock() - 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 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.get_iam_policy(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, policy_pb2.Policy) - assert response.version == 774 - assert response.etag == b'etag_blob' - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_get_iam_policy_rest_interceptors(null_interceptor): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), - ) - client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_get_iam_policy") as post, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "post_get_iam_policy_with_metadata") as post_with_metadata, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_get_iam_policy") as pre: - pre.assert_not_called() - post.assert_not_called() - post_with_metadata.assert_not_called() - pb_message = iam_policy_pb2.GetIamPolicyRequest() - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = mock.Mock() - req.return_value.status_code = 200 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = json_format.MessageToJson(policy_pb2.Policy()) - req.return_value.content = return_value - - request = iam_policy_pb2.GetIamPolicyRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = policy_pb2.Policy() - post_with_metadata.return_value = policy_pb2.Policy(), metadata - - client.get_iam_policy(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - post_with_metadata.assert_called_once() - - -def test_set_iam_policy_rest_bad_request(request_type=iam_policy_pb2.SetIamPolicyRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - # send a request that will satisfy transcoding - request_init = {'resource': 'projects/sample1/locations/sample2/reservations/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 = mock.Mock() - json_return_value = '' - response_value.json = mock.Mock(return_value={}) - response_value.status_code = 400 - response_value.request = mock.Mock() - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.set_iam_policy(request) - - -@pytest.mark.parametrize("request_type", [ - iam_policy_pb2.SetIamPolicyRequest, - dict, -]) -def test_set_iam_policy_rest_call_success(request_type): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - - # send a request that will satisfy transcoding - request_init = {'resource': 'projects/sample1/locations/sample2/reservations/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 = policy_pb2.Policy( - version=774, - etag=b'etag_blob', - ) - - # Wrap the value into a proper Response obj - response_value = mock.Mock() - 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 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.set_iam_policy(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, policy_pb2.Policy) - assert response.version == 774 - assert response.etag == b'etag_blob' - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_set_iam_policy_rest_interceptors(null_interceptor): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), - ) - client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_set_iam_policy") as post, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "post_set_iam_policy_with_metadata") as post_with_metadata, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_set_iam_policy") as pre: - pre.assert_not_called() - post.assert_not_called() - post_with_metadata.assert_not_called() - pb_message = iam_policy_pb2.SetIamPolicyRequest() - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = mock.Mock() - req.return_value.status_code = 200 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = json_format.MessageToJson(policy_pb2.Policy()) - req.return_value.content = return_value - - request = iam_policy_pb2.SetIamPolicyRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = policy_pb2.Policy() - post_with_metadata.return_value = policy_pb2.Policy(), metadata - - client.set_iam_policy(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - post_with_metadata.assert_called_once() - - -def test_test_iam_permissions_rest_bad_request(request_type=iam_policy_pb2.TestIamPermissionsRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - # send a request that will satisfy transcoding - request_init = {'resource': 'projects/sample1/locations/sample2/reservations/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 = mock.Mock() - json_return_value = '' - response_value.json = mock.Mock(return_value={}) - response_value.status_code = 400 - response_value.request = mock.Mock() - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.test_iam_permissions(request) - - -@pytest.mark.parametrize("request_type", [ - iam_policy_pb2.TestIamPermissionsRequest, - dict, -]) -def test_test_iam_permissions_rest_call_success(request_type): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - - # send a request that will satisfy transcoding - request_init = {'resource': 'projects/sample1/locations/sample2/reservations/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 = iam_policy_pb2.TestIamPermissionsResponse( - permissions=['permissions_value'], - ) - - # Wrap the value into a proper Response obj - response_value = mock.Mock() - 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 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.test_iam_permissions(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, iam_policy_pb2.TestIamPermissionsResponse) - assert response.permissions == ['permissions_value'] - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_test_iam_permissions_rest_interceptors(null_interceptor): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), - ) - client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_test_iam_permissions") as post, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "post_test_iam_permissions_with_metadata") as post_with_metadata, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_test_iam_permissions") as pre: - pre.assert_not_called() - post.assert_not_called() - post_with_metadata.assert_not_called() - pb_message = iam_policy_pb2.TestIamPermissionsRequest() - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = mock.Mock() - req.return_value.status_code = 200 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = json_format.MessageToJson(iam_policy_pb2.TestIamPermissionsResponse()) - req.return_value.content = return_value - - request = iam_policy_pb2.TestIamPermissionsRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = iam_policy_pb2.TestIamPermissionsResponse() - post_with_metadata.return_value = iam_policy_pb2.TestIamPermissionsResponse(), metadata - - client.test_iam_permissions(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - post_with_metadata.assert_called_once() - - -def test_create_reservation_group_rest_bad_request(request_type=reservation.CreateReservationGroupRequest): - client = ReservationServiceClient( - 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 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 = mock.Mock() - json_return_value = '' - response_value.json = mock.Mock(return_value={}) - response_value.status_code = 400 - response_value.request = mock.Mock() - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.create_reservation_group(request) - - -@pytest.mark.parametrize("request_type", [ - reservation.CreateReservationGroupRequest, - dict, -]) -def test_create_reservation_group_rest_call_success(request_type): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - request_init["reservation_group"] = {'name': 'name_value'} - # The version of a generated dependency at test runtime may differ from the version used during generation. - # Delete any fields which are not present in the current runtime dependency - # See https://github.com/googleapis/gapic-generator-python/issues/1748 - - # Determine if the message type is proto-plus or protobuf - test_field = reservation.CreateReservationGroupRequest.meta.fields["reservation_group"] - - def get_message_fields(field): - # Given a field which is a message (composite type), return a list with - # all the fields of the message. - # If the field is not a composite type, return an empty list. - message_fields = [] - - if hasattr(field, "message") and field.message: - is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") - - if is_field_type_proto_plus_type: - message_fields = field.message.meta.fields.values() - # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types - else: # pragma: NO COVER - message_fields = field.message.DESCRIPTOR.fields - return message_fields - - runtime_nested_fields = [ - (field.name, nested_field.name) - for field in get_message_fields(test_field) - for nested_field in get_message_fields(field) - ] - - subfields_not_in_runtime = [] - - # For each item in the sample request, create a list of sub fields which are not present at runtime - # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for field, value in request_init["reservation_group"].items(): # pragma: NO COVER - result = None - is_repeated = False - # For repeated fields - if isinstance(value, list) and len(value): - is_repeated = True - result = value[0] - # For fields where the type is another message - if isinstance(value, dict): - result = value - - if result and hasattr(result, "keys"): - for subfield in result.keys(): - if (field, subfield) not in runtime_nested_fields: - subfields_not_in_runtime.append( - {"field": field, "subfield": subfield, "is_repeated": is_repeated} - ) - - # Remove fields from the sample request which are not present in the runtime version of the dependency - # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER - field = subfield_to_delete.get("field") - field_repeated = subfield_to_delete.get("is_repeated") - subfield = subfield_to_delete.get("subfield") - if subfield: - if field_repeated: - for i in range(0, len(request_init["reservation_group"][field])): - del request_init["reservation_group"][field][i][subfield] - else: - del request_init["reservation_group"][field][subfield] - 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 = reservation.ReservationGroup( - name='name_value', - ) - - # Wrap the value into a proper Response obj - response_value = mock.Mock() - response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = reservation.ReservationGroup.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value.content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.create_reservation_group(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.ReservationGroup) - assert response.name == 'name_value' - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_create_reservation_group_rest_interceptors(null_interceptor): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), - ) - client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_create_reservation_group") as post, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "post_create_reservation_group_with_metadata") as post_with_metadata, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_create_reservation_group") as pre: - pre.assert_not_called() - post.assert_not_called() - post_with_metadata.assert_not_called() - pb_message = reservation.CreateReservationGroupRequest.pb(reservation.CreateReservationGroupRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = mock.Mock() - req.return_value.status_code = 200 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.ReservationGroup.to_json(reservation.ReservationGroup()) - req.return_value.content = return_value - - request = reservation.CreateReservationGroupRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = reservation.ReservationGroup() - post_with_metadata.return_value = reservation.ReservationGroup(), metadata - - client.create_reservation_group(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - post_with_metadata.assert_called_once() - - -def test_get_reservation_group_rest_bad_request(request_type=reservation.GetReservationGroupRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/reservationGroups/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 = mock.Mock() - json_return_value = '' - response_value.json = mock.Mock(return_value={}) - response_value.status_code = 400 - response_value.request = mock.Mock() - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.get_reservation_group(request) - - -@pytest.mark.parametrize("request_type", [ - reservation.GetReservationGroupRequest, - dict, -]) -def test_get_reservation_group_rest_call_success(request_type): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/reservationGroups/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 = reservation.ReservationGroup( - name='name_value', - ) - - # Wrap the value into a proper Response obj - response_value = mock.Mock() - response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = reservation.ReservationGroup.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value.content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.get_reservation_group(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, reservation.ReservationGroup) - assert response.name == 'name_value' - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_get_reservation_group_rest_interceptors(null_interceptor): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), - ) - client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_get_reservation_group") as post, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "post_get_reservation_group_with_metadata") as post_with_metadata, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_get_reservation_group") as pre: - pre.assert_not_called() - post.assert_not_called() - post_with_metadata.assert_not_called() - pb_message = reservation.GetReservationGroupRequest.pb(reservation.GetReservationGroupRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = mock.Mock() - req.return_value.status_code = 200 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.ReservationGroup.to_json(reservation.ReservationGroup()) - req.return_value.content = return_value - - request = reservation.GetReservationGroupRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = reservation.ReservationGroup() - post_with_metadata.return_value = reservation.ReservationGroup(), metadata - - client.get_reservation_group(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - post_with_metadata.assert_called_once() - - -def test_delete_reservation_group_rest_bad_request(request_type=reservation.DeleteReservationGroupRequest): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/reservationGroups/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 = mock.Mock() - json_return_value = '' - response_value.json = mock.Mock(return_value={}) - response_value.status_code = 400 - response_value.request = mock.Mock() - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.delete_reservation_group(request) - - -@pytest.mark.parametrize("request_type", [ - reservation.DeleteReservationGroupRequest, - dict, -]) -def test_delete_reservation_group_rest_call_success(request_type): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/reservationGroups/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 = mock.Mock() - response_value.status_code = 200 - json_return_value = '' - response_value.content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.delete_reservation_group(request) - - # Establish that the response is the type that we expect. - assert response is None - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_delete_reservation_group_rest_interceptors(null_interceptor): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), - ) - client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "pre_delete_reservation_group") as pre: - pre.assert_not_called() - pb_message = reservation.DeleteReservationGroupRequest.pb(reservation.DeleteReservationGroupRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = mock.Mock() - req.return_value.status_code = 200 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - request = reservation.DeleteReservationGroupRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - - client.delete_reservation_group(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - - -def test_list_reservation_groups_rest_bad_request(request_type=reservation.ListReservationGroupsRequest): - client = ReservationServiceClient( - 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 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 = mock.Mock() - json_return_value = '' - response_value.json = mock.Mock(return_value={}) - response_value.status_code = 400 - response_value.request = mock.Mock() - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.list_reservation_groups(request) - - -@pytest.mark.parametrize("request_type", [ - reservation.ListReservationGroupsRequest, - dict, -]) -def test_list_reservation_groups_rest_call_success(request_type): - client = ReservationServiceClient( - 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 = reservation.ListReservationGroupsResponse( - next_page_token='next_page_token_value', - ) - - # Wrap the value into a proper Response obj - response_value = mock.Mock() - response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = reservation.ListReservationGroupsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value.content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.list_reservation_groups(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListReservationGroupsPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_list_reservation_groups_rest_interceptors(null_interceptor): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.ReservationServiceRestInterceptor(), - ) - client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_list_reservation_groups") as post, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "post_list_reservation_groups_with_metadata") as post_with_metadata, \ - mock.patch.object(transports.ReservationServiceRestInterceptor, "pre_list_reservation_groups") as pre: - pre.assert_not_called() - post.assert_not_called() - post_with_metadata.assert_not_called() - pb_message = reservation.ListReservationGroupsRequest.pb(reservation.ListReservationGroupsRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = mock.Mock() - req.return_value.status_code = 200 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.ListReservationGroupsResponse.to_json(reservation.ListReservationGroupsResponse()) - req.return_value.content = return_value - - request = reservation.ListReservationGroupsRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = reservation.ListReservationGroupsResponse() - post_with_metadata.return_value = reservation.ListReservationGroupsResponse(), metadata - - client.list_reservation_groups(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - post_with_metadata.assert_called_once() - -def test_initialize_client_w_rest(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - assert client is not None - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_create_reservation_empty_call_rest(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.create_reservation), - '__call__') as call: - client.create_reservation(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = gcbr_reservation.CreateReservationRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_list_reservations_empty_call_rest(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.list_reservations), - '__call__') as call: - client.list_reservations(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.ListReservationsRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_get_reservation_empty_call_rest(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.get_reservation), - '__call__') as call: - client.get_reservation(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.GetReservationRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_delete_reservation_empty_call_rest(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.delete_reservation), - '__call__') as call: - client.delete_reservation(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.DeleteReservationRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_update_reservation_empty_call_rest(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.update_reservation), - '__call__') as call: - client.update_reservation(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = gcbr_reservation.UpdateReservationRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_failover_reservation_empty_call_rest(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.failover_reservation), - '__call__') as call: - client.failover_reservation(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.FailoverReservationRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_create_capacity_commitment_empty_call_rest(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.create_capacity_commitment), - '__call__') as call: - client.create_capacity_commitment(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.CreateCapacityCommitmentRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_list_capacity_commitments_empty_call_rest(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.list_capacity_commitments), - '__call__') as call: - client.list_capacity_commitments(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.ListCapacityCommitmentsRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_get_capacity_commitment_empty_call_rest(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.get_capacity_commitment), - '__call__') as call: - client.get_capacity_commitment(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.GetCapacityCommitmentRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_delete_capacity_commitment_empty_call_rest(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.delete_capacity_commitment), - '__call__') as call: - client.delete_capacity_commitment(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.DeleteCapacityCommitmentRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_update_capacity_commitment_empty_call_rest(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.update_capacity_commitment), - '__call__') as call: - client.update_capacity_commitment(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.UpdateCapacityCommitmentRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_split_capacity_commitment_empty_call_rest(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.split_capacity_commitment), - '__call__') as call: - client.split_capacity_commitment(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.SplitCapacityCommitmentRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_merge_capacity_commitments_empty_call_rest(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.merge_capacity_commitments), - '__call__') as call: - client.merge_capacity_commitments(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.MergeCapacityCommitmentsRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_create_assignment_empty_call_rest(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.create_assignment), - '__call__') as call: - client.create_assignment(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.CreateAssignmentRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_list_assignments_empty_call_rest(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.list_assignments), - '__call__') as call: - client.list_assignments(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.ListAssignmentsRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_delete_assignment_empty_call_rest(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.delete_assignment), - '__call__') as call: - client.delete_assignment(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.DeleteAssignmentRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_search_assignments_empty_call_rest(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.search_assignments), - '__call__') as call: - client.search_assignments(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.SearchAssignmentsRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_search_all_assignments_empty_call_rest(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.search_all_assignments), - '__call__') as call: - client.search_all_assignments(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.SearchAllAssignmentsRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_move_assignment_empty_call_rest(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.move_assignment), - '__call__') as call: - client.move_assignment(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.MoveAssignmentRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_update_assignment_empty_call_rest(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.update_assignment), - '__call__') as call: - client.update_assignment(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.UpdateAssignmentRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_get_bi_reservation_empty_call_rest(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.get_bi_reservation), - '__call__') as call: - client.get_bi_reservation(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.GetBiReservationRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_update_bi_reservation_empty_call_rest(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.update_bi_reservation), - '__call__') as call: - client.update_bi_reservation(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.UpdateBiReservationRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_get_iam_policy_empty_call_rest(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.get_iam_policy), - '__call__') as call: - client.get_iam_policy(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = iam_policy_pb2.GetIamPolicyRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_set_iam_policy_empty_call_rest(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.set_iam_policy), - '__call__') as call: - client.set_iam_policy(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = iam_policy_pb2.SetIamPolicyRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_test_iam_permissions_empty_call_rest(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.test_iam_permissions), - '__call__') as call: - client.test_iam_permissions(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = iam_policy_pb2.TestIamPermissionsRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_create_reservation_group_empty_call_rest(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.create_reservation_group), - '__call__') as call: - client.create_reservation_group(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.CreateReservationGroupRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_get_reservation_group_empty_call_rest(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.get_reservation_group), - '__call__') as call: - client.get_reservation_group(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.GetReservationGroupRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_delete_reservation_group_empty_call_rest(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.delete_reservation_group), - '__call__') as call: - client.delete_reservation_group(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.DeleteReservationGroupRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_list_reservation_groups_empty_call_rest(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.list_reservation_groups), - '__call__') as call: - client.list_reservation_groups(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.ListReservationGroupsRequest() - - assert args[0] == request_msg - - -def test_transport_grpc_default(): - # A client should use the gRPC transport by default. - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert isinstance( - client.transport, - transports.ReservationServiceGrpcTransport, - ) - -def test_reservation_service_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.ReservationServiceTransport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json" - ) - - -def test_reservation_service_base_transport(): - # Instantiate the base transport. - with mock.patch('google.cloud.bigquery_reservation_v1.services.reservation_service.transports.ReservationServiceTransport.__init__') as Transport: - Transport.return_value = None - transport = transports.ReservationServiceTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Every method on the transport should just blindly - # raise NotImplementedError. - methods = ( - 'create_reservation', - 'list_reservations', - 'get_reservation', - 'delete_reservation', - 'update_reservation', - 'failover_reservation', - 'create_capacity_commitment', - 'list_capacity_commitments', - 'get_capacity_commitment', - 'delete_capacity_commitment', - 'update_capacity_commitment', - 'split_capacity_commitment', - 'merge_capacity_commitments', - 'create_assignment', - 'list_assignments', - 'delete_assignment', - 'search_assignments', - 'search_all_assignments', - 'move_assignment', - 'update_assignment', - 'get_bi_reservation', - 'update_bi_reservation', - 'get_iam_policy', - 'set_iam_policy', - 'test_iam_permissions', - 'create_reservation_group', - 'get_reservation_group', - 'delete_reservation_group', - 'list_reservation_groups', - ) - for method in methods: - with pytest.raises(NotImplementedError): - getattr(transport, method)(request=object()) - - with pytest.raises(NotImplementedError): - transport.close() - - # Catch all for all remaining methods and properties - remainder = [ - 'kind', - ] - for r in remainder: - with pytest.raises(NotImplementedError): - getattr(transport, r)() - - -def test_reservation_service_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.bigquery_reservation_v1.services.reservation_service.transports.ReservationServiceTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.ReservationServiceTransport( - 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/bigquery', - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id="octopus", - ) - - -def test_reservation_service_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.bigquery_reservation_v1.services.reservation_service.transports.ReservationServiceTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.ReservationServiceTransport() - adc.assert_called_once() - - -def test_reservation_service_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) - ReservationServiceClient() - adc.assert_called_once_with( - scopes=None, - default_scopes=( - 'https://www.googleapis.com/auth/bigquery', - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id=None, - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.ReservationServiceGrpcTransport, - transports.ReservationServiceGrpcAsyncIOTransport, - ], -) -def test_reservation_service_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/bigquery', 'https://www.googleapis.com/auth/cloud-platform',), - quota_project_id="octopus", - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.ReservationServiceGrpcTransport, - transports.ReservationServiceGrpcAsyncIOTransport, - transports.ReservationServiceRestTransport, - ], -) -def test_reservation_service_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.ReservationServiceGrpcTransport, grpc_helpers), - (transports.ReservationServiceGrpcAsyncIOTransport, grpc_helpers_async) - ], -) -def test_reservation_service_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( - "bigqueryreservation.googleapis.com:443", - credentials=creds, - credentials_file=None, - quota_project_id="octopus", - default_scopes=( - 'https://www.googleapis.com/auth/bigquery', - 'https://www.googleapis.com/auth/cloud-platform', -), - scopes=["1", "2"], - default_host="bigqueryreservation.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("transport_class", [transports.ReservationServiceGrpcTransport, transports.ReservationServiceGrpcAsyncIOTransport]) -def test_reservation_service_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_reservation_service_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.ReservationServiceRestTransport ( - credentials=cred, - client_cert_source_for_mtls=client_cert_source_callback - ) - mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) - - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_reservation_service_host_no_port(transport_name): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='bigqueryreservation.googleapis.com'), - transport=transport_name, - ) - assert client.transport._host == ( - 'bigqueryreservation.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://bigqueryreservation.googleapis.com' - ) - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_reservation_service_host_with_port(transport_name): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='bigqueryreservation.googleapis.com:8000'), - transport=transport_name, - ) - assert client.transport._host == ( - 'bigqueryreservation.googleapis.com:8000' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://bigqueryreservation.googleapis.com:8000' - ) - -@pytest.mark.parametrize("transport_name", [ - "rest", -]) -def test_reservation_service_client_transport_session_collision(transport_name): - creds1 = ga_credentials.AnonymousCredentials() - creds2 = ga_credentials.AnonymousCredentials() - client1 = ReservationServiceClient( - credentials=creds1, - transport=transport_name, - ) - client2 = ReservationServiceClient( - credentials=creds2, - transport=transport_name, - ) - session1 = client1.transport.create_reservation._session - session2 = client2.transport.create_reservation._session - assert session1 != session2 - session1 = client1.transport.list_reservations._session - session2 = client2.transport.list_reservations._session - assert session1 != session2 - session1 = client1.transport.get_reservation._session - session2 = client2.transport.get_reservation._session - assert session1 != session2 - session1 = client1.transport.delete_reservation._session - session2 = client2.transport.delete_reservation._session - assert session1 != session2 - session1 = client1.transport.update_reservation._session - session2 = client2.transport.update_reservation._session - assert session1 != session2 - session1 = client1.transport.failover_reservation._session - session2 = client2.transport.failover_reservation._session - assert session1 != session2 - session1 = client1.transport.create_capacity_commitment._session - session2 = client2.transport.create_capacity_commitment._session - assert session1 != session2 - session1 = client1.transport.list_capacity_commitments._session - session2 = client2.transport.list_capacity_commitments._session - assert session1 != session2 - session1 = client1.transport.get_capacity_commitment._session - session2 = client2.transport.get_capacity_commitment._session - assert session1 != session2 - session1 = client1.transport.delete_capacity_commitment._session - session2 = client2.transport.delete_capacity_commitment._session - assert session1 != session2 - session1 = client1.transport.update_capacity_commitment._session - session2 = client2.transport.update_capacity_commitment._session - assert session1 != session2 - session1 = client1.transport.split_capacity_commitment._session - session2 = client2.transport.split_capacity_commitment._session - assert session1 != session2 - session1 = client1.transport.merge_capacity_commitments._session - session2 = client2.transport.merge_capacity_commitments._session - assert session1 != session2 - session1 = client1.transport.create_assignment._session - session2 = client2.transport.create_assignment._session - assert session1 != session2 - session1 = client1.transport.list_assignments._session - session2 = client2.transport.list_assignments._session - assert session1 != session2 - session1 = client1.transport.delete_assignment._session - session2 = client2.transport.delete_assignment._session - assert session1 != session2 - session1 = client1.transport.search_assignments._session - session2 = client2.transport.search_assignments._session - assert session1 != session2 - session1 = client1.transport.search_all_assignments._session - session2 = client2.transport.search_all_assignments._session - assert session1 != session2 - session1 = client1.transport.move_assignment._session - session2 = client2.transport.move_assignment._session - assert session1 != session2 - session1 = client1.transport.update_assignment._session - session2 = client2.transport.update_assignment._session - assert session1 != session2 - session1 = client1.transport.get_bi_reservation._session - session2 = client2.transport.get_bi_reservation._session - assert session1 != session2 - session1 = client1.transport.update_bi_reservation._session - session2 = client2.transport.update_bi_reservation._session - assert session1 != session2 - session1 = client1.transport.get_iam_policy._session - session2 = client2.transport.get_iam_policy._session - assert session1 != session2 - session1 = client1.transport.set_iam_policy._session - session2 = client2.transport.set_iam_policy._session - assert session1 != session2 - session1 = client1.transport.test_iam_permissions._session - session2 = client2.transport.test_iam_permissions._session - assert session1 != session2 - session1 = client1.transport.create_reservation_group._session - session2 = client2.transport.create_reservation_group._session - assert session1 != session2 - session1 = client1.transport.get_reservation_group._session - session2 = client2.transport.get_reservation_group._session - assert session1 != session2 - session1 = client1.transport.delete_reservation_group._session - session2 = client2.transport.delete_reservation_group._session - assert session1 != session2 - session1 = client1.transport.list_reservation_groups._session - session2 = client2.transport.list_reservation_groups._session - assert session1 != session2 -def test_reservation_service_grpc_transport_channel(): - channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.ReservationServiceGrpcTransport( - 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_reservation_service_grpc_asyncio_transport_channel(): - channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.ReservationServiceGrpcAsyncIOTransport( - 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.ReservationServiceGrpcTransport, transports.ReservationServiceGrpcAsyncIOTransport]) -def test_reservation_service_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.ReservationServiceGrpcTransport, transports.ReservationServiceGrpcAsyncIOTransport]) -def test_reservation_service_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_assignment_path(): - project = "squid" - location = "clam" - reservation = "whelk" - assignment = "octopus" - expected = "projects/{project}/locations/{location}/reservations/{reservation}/assignments/{assignment}".format(project=project, location=location, reservation=reservation, assignment=assignment, ) - actual = ReservationServiceClient.assignment_path(project, location, reservation, assignment) - assert expected == actual - - -def test_parse_assignment_path(): - expected = { - "project": "oyster", - "location": "nudibranch", - "reservation": "cuttlefish", - "assignment": "mussel", - } - path = ReservationServiceClient.assignment_path(**expected) - - # Check that the path construction is reversible. - actual = ReservationServiceClient.parse_assignment_path(path) - assert expected == actual - -def test_bi_reservation_path(): - project = "winkle" - location = "nautilus" - expected = "projects/{project}/locations/{location}/biReservation".format(project=project, location=location, ) - actual = ReservationServiceClient.bi_reservation_path(project, location) - assert expected == actual - - -def test_parse_bi_reservation_path(): - expected = { - "project": "scallop", - "location": "abalone", - } - path = ReservationServiceClient.bi_reservation_path(**expected) - - # Check that the path construction is reversible. - actual = ReservationServiceClient.parse_bi_reservation_path(path) - assert expected == actual - -def test_capacity_commitment_path(): - project = "squid" - location = "clam" - capacity_commitment = "whelk" - expected = "projects/{project}/locations/{location}/capacityCommitments/{capacity_commitment}".format(project=project, location=location, capacity_commitment=capacity_commitment, ) - actual = ReservationServiceClient.capacity_commitment_path(project, location, capacity_commitment) - assert expected == actual - - -def test_parse_capacity_commitment_path(): - expected = { - "project": "octopus", - "location": "oyster", - "capacity_commitment": "nudibranch", - } - path = ReservationServiceClient.capacity_commitment_path(**expected) - - # Check that the path construction is reversible. - actual = ReservationServiceClient.parse_capacity_commitment_path(path) - assert expected == actual - -def test_reservation_path(): - project = "cuttlefish" - location = "mussel" - reservation = "winkle" - expected = "projects/{project}/locations/{location}/reservations/{reservation}".format(project=project, location=location, reservation=reservation, ) - actual = ReservationServiceClient.reservation_path(project, location, reservation) - assert expected == actual - - -def test_parse_reservation_path(): - expected = { - "project": "nautilus", - "location": "scallop", - "reservation": "abalone", - } - path = ReservationServiceClient.reservation_path(**expected) - - # Check that the path construction is reversible. - actual = ReservationServiceClient.parse_reservation_path(path) - assert expected == actual - -def test_reservation_group_path(): - project = "squid" - location = "clam" - reservation_group = "whelk" - expected = "projects/{project}/locations/{location}/reservationGroups/{reservation_group}".format(project=project, location=location, reservation_group=reservation_group, ) - actual = ReservationServiceClient.reservation_group_path(project, location, reservation_group) - assert expected == actual - - -def test_parse_reservation_group_path(): - expected = { - "project": "octopus", - "location": "oyster", - "reservation_group": "nudibranch", - } - path = ReservationServiceClient.reservation_group_path(**expected) - - # Check that the path construction is reversible. - actual = ReservationServiceClient.parse_reservation_group_path(path) - assert expected == actual - -def test_common_billing_account_path(): - billing_account = "cuttlefish" - expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - actual = ReservationServiceClient.common_billing_account_path(billing_account) - assert expected == actual - - -def test_parse_common_billing_account_path(): - expected = { - "billing_account": "mussel", - } - path = ReservationServiceClient.common_billing_account_path(**expected) - - # Check that the path construction is reversible. - actual = ReservationServiceClient.parse_common_billing_account_path(path) - assert expected == actual - -def test_common_folder_path(): - folder = "winkle" - expected = "folders/{folder}".format(folder=folder, ) - actual = ReservationServiceClient.common_folder_path(folder) - assert expected == actual - - -def test_parse_common_folder_path(): - expected = { - "folder": "nautilus", - } - path = ReservationServiceClient.common_folder_path(**expected) - - # Check that the path construction is reversible. - actual = ReservationServiceClient.parse_common_folder_path(path) - assert expected == actual - -def test_common_organization_path(): - organization = "scallop" - expected = "organizations/{organization}".format(organization=organization, ) - actual = ReservationServiceClient.common_organization_path(organization) - assert expected == actual - - -def test_parse_common_organization_path(): - expected = { - "organization": "abalone", - } - path = ReservationServiceClient.common_organization_path(**expected) - - # Check that the path construction is reversible. - actual = ReservationServiceClient.parse_common_organization_path(path) - assert expected == actual - -def test_common_project_path(): - project = "squid" - expected = "projects/{project}".format(project=project, ) - actual = ReservationServiceClient.common_project_path(project) - assert expected == actual - - -def test_parse_common_project_path(): - expected = { - "project": "clam", - } - path = ReservationServiceClient.common_project_path(**expected) - - # Check that the path construction is reversible. - actual = ReservationServiceClient.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 = ReservationServiceClient.common_location_path(project, location) - assert expected == actual - - -def test_parse_common_location_path(): - expected = { - "project": "oyster", - "location": "nudibranch", - } - path = ReservationServiceClient.common_location_path(**expected) - - # Check that the path construction is reversible. - actual = ReservationServiceClient.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.ReservationServiceTransport, '_prep_wrapped_messages') as prep: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - - with mock.patch.object(transports.ReservationServiceTransport, '_prep_wrapped_messages') as prep: - transport_class = ReservationServiceClient.get_transport_class() - transport = transport_class( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - - -def test_transport_close_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc" - ) - with mock.patch.object(type(getattr(client.transport, "_grpc_channel")), "close") as close: - with client: - close.assert_not_called() - close.assert_called_once() - - -@pytest.mark.asyncio -async def test_transport_close_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - 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_transport_close_rest(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - with mock.patch.object(type(getattr(client.transport, "_session")), "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 = ReservationServiceClient( - 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", [ - (ReservationServiceClient, transports.ReservationServiceGrpcTransport), - (ReservationServiceAsyncClient, transports.ReservationServiceGrpcAsyncIOTransport), -]) -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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), - 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/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation/__init__.py b/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation/__init__.py index 9978135e2bfb..c9f9d8d6e8f6 100644 --- a/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation/__init__.py +++ b/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation/__init__.py @@ -30,25 +30,32 @@ CapacityCommitment, CreateAssignmentRequest, CreateCapacityCommitmentRequest, + CreateReservationGroupRequest, CreateReservationRequest, DeleteAssignmentRequest, DeleteCapacityCommitmentRequest, + DeleteReservationGroupRequest, DeleteReservationRequest, Edition, FailoverMode, FailoverReservationRequest, GetBiReservationRequest, GetCapacityCommitmentRequest, + GetReservationGroupRequest, GetReservationRequest, ListAssignmentsRequest, ListAssignmentsResponse, ListCapacityCommitmentsRequest, ListCapacityCommitmentsResponse, + ListReservationGroupsRequest, + ListReservationGroupsResponse, ListReservationsRequest, ListReservationsResponse, MergeCapacityCommitmentsRequest, MoveAssignmentRequest, Reservation, + ReservationGroup, + SchedulingPolicy, SearchAllAssignmentsRequest, SearchAllAssignmentsResponse, SearchAssignmentsRequest, @@ -70,23 +77,30 @@ "CapacityCommitment", "CreateAssignmentRequest", "CreateCapacityCommitmentRequest", + "CreateReservationGroupRequest", "CreateReservationRequest", "DeleteAssignmentRequest", "DeleteCapacityCommitmentRequest", + "DeleteReservationGroupRequest", "DeleteReservationRequest", "FailoverReservationRequest", "GetBiReservationRequest", "GetCapacityCommitmentRequest", + "GetReservationGroupRequest", "GetReservationRequest", "ListAssignmentsRequest", "ListAssignmentsResponse", "ListCapacityCommitmentsRequest", "ListCapacityCommitmentsResponse", + "ListReservationGroupsRequest", + "ListReservationGroupsResponse", "ListReservationsRequest", "ListReservationsResponse", "MergeCapacityCommitmentsRequest", "MoveAssignmentRequest", "Reservation", + "ReservationGroup", + "SchedulingPolicy", "SearchAllAssignmentsRequest", "SearchAllAssignmentsResponse", "SearchAssignmentsRequest", diff --git a/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation/gapic_version.py b/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation/gapic_version.py index 7313c97c3096..20a9cd975b02 100644 --- a/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation/gapic_version.py +++ b/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation/gapic_version.py @@ -13,4 +13,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # -__version__ = "1.19.0" # {x-release-please-version} +__version__ = "0.0.0" # {x-release-please-version} diff --git a/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/__init__.py b/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/__init__.py index 3f0402d98d56..5d423369dc78 100644 --- a/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/__init__.py +++ b/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/__init__.py @@ -28,25 +28,32 @@ CapacityCommitment, CreateAssignmentRequest, CreateCapacityCommitmentRequest, + CreateReservationGroupRequest, CreateReservationRequest, DeleteAssignmentRequest, DeleteCapacityCommitmentRequest, + DeleteReservationGroupRequest, DeleteReservationRequest, Edition, FailoverMode, FailoverReservationRequest, GetBiReservationRequest, GetCapacityCommitmentRequest, + GetReservationGroupRequest, GetReservationRequest, ListAssignmentsRequest, ListAssignmentsResponse, ListCapacityCommitmentsRequest, ListCapacityCommitmentsResponse, + ListReservationGroupsRequest, + ListReservationGroupsResponse, ListReservationsRequest, ListReservationsResponse, MergeCapacityCommitmentsRequest, MoveAssignmentRequest, Reservation, + ReservationGroup, + SchedulingPolicy, SearchAllAssignmentsRequest, SearchAllAssignmentsResponse, SearchAssignmentsRequest, @@ -67,26 +74,33 @@ "CapacityCommitment", "CreateAssignmentRequest", "CreateCapacityCommitmentRequest", + "CreateReservationGroupRequest", "CreateReservationRequest", "DeleteAssignmentRequest", "DeleteCapacityCommitmentRequest", + "DeleteReservationGroupRequest", "DeleteReservationRequest", "Edition", "FailoverMode", "FailoverReservationRequest", "GetBiReservationRequest", "GetCapacityCommitmentRequest", + "GetReservationGroupRequest", "GetReservationRequest", "ListAssignmentsRequest", "ListAssignmentsResponse", "ListCapacityCommitmentsRequest", "ListCapacityCommitmentsResponse", + "ListReservationGroupsRequest", + "ListReservationGroupsResponse", "ListReservationsRequest", "ListReservationsResponse", "MergeCapacityCommitmentsRequest", "MoveAssignmentRequest", "Reservation", + "ReservationGroup", "ReservationServiceClient", + "SchedulingPolicy", "SearchAllAssignmentsRequest", "SearchAllAssignmentsResponse", "SearchAssignmentsRequest", diff --git a/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/gapic_metadata.json b/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/gapic_metadata.json index 385c3265ef89..7216bd76bb22 100644 --- a/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/gapic_metadata.json +++ b/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/gapic_metadata.json @@ -25,6 +25,11 @@ "create_reservation" ] }, + "CreateReservationGroup": { + "methods": [ + "create_reservation_group" + ] + }, "DeleteAssignment": { "methods": [ "delete_assignment" @@ -40,6 +45,11 @@ "delete_reservation" ] }, + "DeleteReservationGroup": { + "methods": [ + "delete_reservation_group" + ] + }, "FailoverReservation": { "methods": [ "failover_reservation" @@ -55,11 +65,21 @@ "get_capacity_commitment" ] }, + "GetIamPolicy": { + "methods": [ + "get_iam_policy" + ] + }, "GetReservation": { "methods": [ "get_reservation" ] }, + "GetReservationGroup": { + "methods": [ + "get_reservation_group" + ] + }, "ListAssignments": { "methods": [ "list_assignments" @@ -70,6 +90,11 @@ "list_capacity_commitments" ] }, + "ListReservationGroups": { + "methods": [ + "list_reservation_groups" + ] + }, "ListReservations": { "methods": [ "list_reservations" @@ -95,11 +120,21 @@ "search_assignments" ] }, + "SetIamPolicy": { + "methods": [ + "set_iam_policy" + ] + }, "SplitCapacityCommitment": { "methods": [ "split_capacity_commitment" ] }, + "TestIamPermissions": { + "methods": [ + "test_iam_permissions" + ] + }, "UpdateAssignment": { "methods": [ "update_assignment" @@ -140,6 +175,11 @@ "create_reservation" ] }, + "CreateReservationGroup": { + "methods": [ + "create_reservation_group" + ] + }, "DeleteAssignment": { "methods": [ "delete_assignment" @@ -155,6 +195,11 @@ "delete_reservation" ] }, + "DeleteReservationGroup": { + "methods": [ + "delete_reservation_group" + ] + }, "FailoverReservation": { "methods": [ "failover_reservation" @@ -170,11 +215,21 @@ "get_capacity_commitment" ] }, + "GetIamPolicy": { + "methods": [ + "get_iam_policy" + ] + }, "GetReservation": { "methods": [ "get_reservation" ] }, + "GetReservationGroup": { + "methods": [ + "get_reservation_group" + ] + }, "ListAssignments": { "methods": [ "list_assignments" @@ -185,6 +240,11 @@ "list_capacity_commitments" ] }, + "ListReservationGroups": { + "methods": [ + "list_reservation_groups" + ] + }, "ListReservations": { "methods": [ "list_reservations" @@ -210,11 +270,21 @@ "search_assignments" ] }, + "SetIamPolicy": { + "methods": [ + "set_iam_policy" + ] + }, "SplitCapacityCommitment": { "methods": [ "split_capacity_commitment" ] }, + "TestIamPermissions": { + "methods": [ + "test_iam_permissions" + ] + }, "UpdateAssignment": { "methods": [ "update_assignment" @@ -255,6 +325,11 @@ "create_reservation" ] }, + "CreateReservationGroup": { + "methods": [ + "create_reservation_group" + ] + }, "DeleteAssignment": { "methods": [ "delete_assignment" @@ -270,6 +345,11 @@ "delete_reservation" ] }, + "DeleteReservationGroup": { + "methods": [ + "delete_reservation_group" + ] + }, "FailoverReservation": { "methods": [ "failover_reservation" @@ -285,11 +365,21 @@ "get_capacity_commitment" ] }, + "GetIamPolicy": { + "methods": [ + "get_iam_policy" + ] + }, "GetReservation": { "methods": [ "get_reservation" ] }, + "GetReservationGroup": { + "methods": [ + "get_reservation_group" + ] + }, "ListAssignments": { "methods": [ "list_assignments" @@ -300,6 +390,11 @@ "list_capacity_commitments" ] }, + "ListReservationGroups": { + "methods": [ + "list_reservation_groups" + ] + }, "ListReservations": { "methods": [ "list_reservations" @@ -325,11 +420,21 @@ "search_assignments" ] }, + "SetIamPolicy": { + "methods": [ + "set_iam_policy" + ] + }, "SplitCapacityCommitment": { "methods": [ "split_capacity_commitment" ] }, + "TestIamPermissions": { + "methods": [ + "test_iam_permissions" + ] + }, "UpdateAssignment": { "methods": [ "update_assignment" diff --git a/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/gapic_version.py b/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/gapic_version.py index 7313c97c3096..20a9cd975b02 100644 --- a/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/gapic_version.py +++ b/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/gapic_version.py @@ -13,4 +13,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # -__version__ = "1.19.0" # {x-release-please-version} +__version__ = "0.0.0" # {x-release-please-version} diff --git a/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/services/reservation_service/async_client.py b/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/services/reservation_service/async_client.py index ca32eed92ed5..f398519c989f 100644 --- a/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/services/reservation_service/async_client.py +++ b/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/services/reservation_service/async_client.py @@ -45,6 +45,8 @@ except AttributeError: # pragma: NO COVER OptionalRetry = Union[retries.AsyncRetry, object, None] # type: ignore +from google.iam.v1 import iam_policy_pb2 # type: ignore +from google.iam.v1 import policy_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 @@ -111,6 +113,12 @@ class ReservationServiceAsyncClient: parse_reservation_path = staticmethod( ReservationServiceClient.parse_reservation_path ) + reservation_group_path = staticmethod( + ReservationServiceClient.reservation_group_path + ) + parse_reservation_group_path = staticmethod( + ReservationServiceClient.parse_reservation_group_path + ) common_billing_account_path = staticmethod( ReservationServiceClient.common_billing_account_path ) @@ -3189,6 +3197,836 @@ async def sample_update_bi_reservation(): # Done; return the response. return response + async def get_iam_policy( + self, + request: Optional[Union[iam_policy_pb2.GetIamPolicyRequest, dict]] = None, + *, + resource: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> policy_pb2.Policy: + r"""Gets the access control policy for a resource. May return: + + - A\ ``NOT_FOUND`` error if the resource doesn't exist or you + don't have the permission to view it. + - An empty policy if the resource exists but doesn't have a set + policy. + + Supported resources are: + + - Reservations + - ReservationAssignments + + To call this method, you must have the following Google IAM + permissions: + + - ``bigqueryreservation.reservations.getIamPolicy`` to get + policies on reservations. + + .. 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 bigquery_reservation_v1 + from google.iam.v1 import iam_policy_pb2 # type: ignore + + async def sample_get_iam_policy(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = iam_policy_pb2.GetIamPolicyRequest( + resource="resource_value", + ) + + # Make the request + response = await client.get_iam_policy(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]]): + The request object. Request message for ``GetIamPolicy`` method. + resource (:class:`str`): + REQUIRED: The resource for which the + policy is being requested. See the + operation documentation for the + appropriate value for this field. + + This corresponds to the ``resource`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.iam.v1.policy_pb2.Policy: + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. + + A Policy is a collection of bindings. A binding binds + one or more members, or principals, to a single role. + Principals can be user accounts, service accounts, + Google groups, and domains (such as G Suite). A role + is a named list of permissions; each role can be an + IAM predefined role or a user-created custom role. + + For some types of Google Cloud resources, a binding + can also specify a condition, which is a logical + expression that allows access to a resource only if + the expression evaluates to true. A condition can add + constraints based on attributes of the request, the + resource, or both. To learn which resources support + conditions in their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + + **JSON example:** + + :literal:`` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }`\ \` + + **YAML example:** + + :literal:`` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3`\ \` + + For a description of IAM and its features, see the + [IAM + documentation](https://cloud.google.com/iam/docs/). + + """ + # 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. + flattened_params = [resource] + has_flattened_params = ( + len([param for param in flattened_params if param is not None]) > 0 + ) + 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." + ) + + # - The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = iam_policy_pb2.GetIamPolicyRequest(**request) + elif not request: + request = iam_policy_pb2.GetIamPolicyRequest(resource=resource) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[ + self._client._transport.get_iam_policy + ] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("resource", request.resource),)), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def set_iam_policy( + self, + request: Optional[Union[iam_policy_pb2.SetIamPolicyRequest, dict]] = None, + *, + resource: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> policy_pb2.Policy: + r"""Sets an access control policy for a resource. Replaces any + existing policy. + + Supported resources are: + + - Reservations + + To call this method, you must have the following Google IAM + permissions: + + - ``bigqueryreservation.reservations.setIamPolicy`` to set + policies on reservations. + + .. 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 bigquery_reservation_v1 + from google.iam.v1 import iam_policy_pb2 # type: ignore + + async def sample_set_iam_policy(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = iam_policy_pb2.SetIamPolicyRequest( + resource="resource_value", + ) + + # Make the request + response = await client.set_iam_policy(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]]): + The request object. Request message for ``SetIamPolicy`` method. + resource (:class:`str`): + REQUIRED: The resource for which the + policy is being specified. See the + operation documentation for the + appropriate value for this field. + + This corresponds to the ``resource`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.iam.v1.policy_pb2.Policy: + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. + + A Policy is a collection of bindings. A binding binds + one or more members, or principals, to a single role. + Principals can be user accounts, service accounts, + Google groups, and domains (such as G Suite). A role + is a named list of permissions; each role can be an + IAM predefined role or a user-created custom role. + + For some types of Google Cloud resources, a binding + can also specify a condition, which is a logical + expression that allows access to a resource only if + the expression evaluates to true. A condition can add + constraints based on attributes of the request, the + resource, or both. To learn which resources support + conditions in their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + + **JSON example:** + + :literal:`` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }`\ \` + + **YAML example:** + + :literal:`` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3`\ \` + + For a description of IAM and its features, see the + [IAM + documentation](https://cloud.google.com/iam/docs/). + + """ + # 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. + flattened_params = [resource] + has_flattened_params = ( + len([param for param in flattened_params if param is not None]) > 0 + ) + 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." + ) + + # - The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = iam_policy_pb2.SetIamPolicyRequest(**request) + elif not request: + request = iam_policy_pb2.SetIamPolicyRequest(resource=resource) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[ + self._client._transport.set_iam_policy + ] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("resource", request.resource),)), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def test_iam_permissions( + self, + request: Optional[Union[iam_policy_pb2.TestIamPermissionsRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> iam_policy_pb2.TestIamPermissionsResponse: + r"""Gets your permissions on a resource. Returns an empty + set of permissions if the resource doesn't exist. + + Supported resources are: + + - Reservations + + No Google IAM permissions are required to call this + method. + + .. 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 bigquery_reservation_v1 + from google.iam.v1 import iam_policy_pb2 # type: ignore + + async def sample_test_iam_permissions(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = iam_policy_pb2.TestIamPermissionsRequest( + resource="resource_value", + permissions=['permissions_value1', 'permissions_value2'], + ) + + # Make the request + response = await client.test_iam_permissions(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]]): + The request object. Request message for ``TestIamPermissions`` method. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse: + Response message for TestIamPermissions 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 = iam_policy_pb2.TestIamPermissionsRequest(**request) + elif not request: + request = iam_policy_pb2.TestIamPermissionsRequest() + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[ + self._client._transport.test_iam_permissions + ] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("resource", request.resource),)), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def create_reservation_group( + self, + request: Optional[ + Union[reservation.CreateReservationGroupRequest, dict] + ] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> reservation.ReservationGroup: + r"""Creates a new reservation group. + + .. 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 bigquery_reservation_v1 + + async def sample_create_reservation_group(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.CreateReservationGroupRequest( + parent="parent_value", + reservation_group_id="reservation_group_id_value", + ) + + # Make the request + response = await client.create_reservation_group(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.bigquery_reservation_v1.types.CreateReservationGroupRequest, dict]]): + The request object. The request for + [ReservationService.CreateReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.CreateReservationGroup]. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.ReservationGroup: + A reservation group is a container + for reservations. + + """ + # Create or coerce a protobuf request object. + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.CreateReservationGroupRequest): + request = reservation.CreateReservationGroupRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[ + self._client._transport.create_reservation_group + ] + + # 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),)), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_reservation_group( + self, + request: Optional[Union[reservation.GetReservationGroupRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> reservation.ReservationGroup: + r"""Returns information about the reservation group. + + .. 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 bigquery_reservation_v1 + + async def sample_get_reservation_group(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.GetReservationGroupRequest( + name="name_value", + ) + + # Make the request + response = await client.get_reservation_group(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.bigquery_reservation_v1.types.GetReservationGroupRequest, dict]]): + The request object. The request for + [ReservationService.GetReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.GetReservationGroup]. + name (:class:`str`): + Required. Resource name of the reservation group to + retrieve. E.g., + ``projects/myproject/locations/US/reservationGroups/team1-prod`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.ReservationGroup: + A reservation group is a container + for reservations. + + """ + # 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. + flattened_params = [name] + has_flattened_params = ( + len([param for param in flattened_params if param is not None]) > 0 + ) + 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." + ) + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.GetReservationGroupRequest): + request = reservation.GetReservationGroupRequest(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._client._transport._wrapped_methods[ + self._client._transport.get_reservation_group + ] + + # 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),)), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def delete_reservation_group( + self, + request: Optional[ + Union[reservation.DeleteReservationGroupRequest, dict] + ] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> None: + r"""Deletes a reservation. Returns + ``google.rpc.Code.FAILED_PRECONDITION`` when reservation has + assignments. + + .. 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 bigquery_reservation_v1 + + async def sample_delete_reservation_group(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.DeleteReservationGroupRequest( + name="name_value", + ) + + # Make the request + await client.delete_reservation_group(request=request) + + Args: + request (Optional[Union[google.cloud.bigquery_reservation_v1.types.DeleteReservationGroupRequest, dict]]): + The request object. The request for + [ReservationService.DeleteReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservationGroup]. + name (:class:`str`): + Required. Resource name of the reservation group to + retrieve. E.g., + ``projects/myproject/locations/US/reservationGroups/team1-prod`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + """ + # 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. + flattened_params = [name] + has_flattened_params = ( + len([param for param in flattened_params if param is not None]) > 0 + ) + 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." + ) + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.DeleteReservationGroupRequest): + request = reservation.DeleteReservationGroupRequest(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._client._transport._wrapped_methods[ + self._client._transport.delete_reservation_group + ] + + # 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),)), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + async def list_reservation_groups( + self, + request: Optional[Union[reservation.ListReservationGroupsRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> pagers.ListReservationGroupsAsyncPager: + r"""Lists all the reservation groups for the project in + the specified location. + + .. 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 bigquery_reservation_v1 + + async def sample_list_reservation_groups(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceAsyncClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.ListReservationGroupsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_reservation_groups(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.bigquery_reservation_v1.types.ListReservationGroupsRequest, dict]]): + The request object. The request for + [ReservationService.ListReservationGroups][google.cloud.bigquery.reservation.v1.ReservationService.ListReservationGroups]. + parent (:class:`str`): + Required. The parent resource name containing project + and location, e.g.: ``projects/myproject/locations/US`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListReservationGroupsAsyncPager: + The response for + [ReservationService.ListReservationGroups][google.cloud.bigquery.reservation.v1.ReservationService.ListReservationGroups]. + + 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. + flattened_params = [parent] + has_flattened_params = ( + len([param for param in flattened_params if param is not None]) > 0 + ) + 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." + ) + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.ListReservationGroupsRequest): + request = reservation.ListReservationGroupsRequest(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._client._transport._wrapped_methods[ + self._client._transport.list_reservation_groups + ] + + # 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),)), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # 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.ListReservationGroupsAsyncPager( + method=rpc, + request=request, + response=response, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + async def __aenter__(self) -> "ReservationServiceAsyncClient": return self diff --git a/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/services/reservation_service/client.py b/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/services/reservation_service/client.py index f231c2c3bf50..25b4924c96d9 100644 --- a/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/services/reservation_service/client.py +++ b/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/services/reservation_service/client.py @@ -61,6 +61,8 @@ _LOGGER = std_logging.getLogger(__name__) +from google.iam.v1 import iam_policy_pb2 # type: ignore +from google.iam.v1 import policy_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 @@ -307,6 +309,28 @@ def parse_reservation_path(path: str) -> Dict[str, str]: ) return m.groupdict() if m else {} + @staticmethod + def reservation_group_path( + project: str, + location: str, + reservation_group: str, + ) -> str: + """Returns a fully-qualified reservation_group string.""" + return "projects/{project}/locations/{location}/reservationGroups/{reservation_group}".format( + project=project, + location=location, + reservation_group=reservation_group, + ) + + @staticmethod + def parse_reservation_group_path(path: str) -> Dict[str, str]: + """Parses a reservation_group path into its component segments.""" + m = re.match( + r"^projects/(?P.+?)/locations/(?P.+?)/reservationGroups/(?P.+?)$", + path, + ) + return m.groupdict() if m else {} + @staticmethod def common_billing_account_path( billing_account: str, @@ -3613,6 +3637,826 @@ def sample_update_bi_reservation(): # Done; return the response. return response + def get_iam_policy( + self, + request: Optional[Union[iam_policy_pb2.GetIamPolicyRequest, dict]] = None, + *, + resource: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> policy_pb2.Policy: + r"""Gets the access control policy for a resource. May return: + + - A\ ``NOT_FOUND`` error if the resource doesn't exist or you + don't have the permission to view it. + - An empty policy if the resource exists but doesn't have a set + policy. + + Supported resources are: + + - Reservations + - ReservationAssignments + + To call this method, you must have the following Google IAM + permissions: + + - ``bigqueryreservation.reservations.getIamPolicy`` to get + policies on reservations. + + .. 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 bigquery_reservation_v1 + from google.iam.v1 import iam_policy_pb2 # type: ignore + + def sample_get_iam_policy(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = iam_policy_pb2.GetIamPolicyRequest( + resource="resource_value", + ) + + # Make the request + response = client.get_iam_policy(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]): + The request object. Request message for ``GetIamPolicy`` method. + resource (str): + REQUIRED: The resource for which the + policy is being requested. See the + operation documentation for the + appropriate value for this field. + + This corresponds to the ``resource`` 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.iam.v1.policy_pb2.Policy: + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. + + A Policy is a collection of bindings. A binding binds + one or more members, or principals, to a single role. + Principals can be user accounts, service accounts, + Google groups, and domains (such as G Suite). A role + is a named list of permissions; each role can be an + IAM predefined role or a user-created custom role. + + For some types of Google Cloud resources, a binding + can also specify a condition, which is a logical + expression that allows access to a resource only if + the expression evaluates to true. A condition can add + constraints based on attributes of the request, the + resource, or both. To learn which resources support + conditions in their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + + **JSON example:** + + :literal:`` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }`\ \` + + **YAML example:** + + :literal:`` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3`\ \` + + For a description of IAM and its features, see the + [IAM + documentation](https://cloud.google.com/iam/docs/). + + """ + # 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. + flattened_params = [resource] + has_flattened_params = ( + len([param for param in flattened_params if param is not None]) > 0 + ) + 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." + ) + + if isinstance(request, dict): + # - The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + request = iam_policy_pb2.GetIamPolicyRequest(**request) + elif not request: + # Null request, just make one. + request = iam_policy_pb2.GetIamPolicyRequest() + if resource is not None: + request.resource = resource + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_iam_policy] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("resource", request.resource),)), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def set_iam_policy( + self, + request: Optional[Union[iam_policy_pb2.SetIamPolicyRequest, dict]] = None, + *, + resource: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> policy_pb2.Policy: + r"""Sets an access control policy for a resource. Replaces any + existing policy. + + Supported resources are: + + - Reservations + + To call this method, you must have the following Google IAM + permissions: + + - ``bigqueryreservation.reservations.setIamPolicy`` to set + policies on reservations. + + .. 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 bigquery_reservation_v1 + from google.iam.v1 import iam_policy_pb2 # type: ignore + + def sample_set_iam_policy(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = iam_policy_pb2.SetIamPolicyRequest( + resource="resource_value", + ) + + # Make the request + response = client.set_iam_policy(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]): + The request object. Request message for ``SetIamPolicy`` method. + resource (str): + REQUIRED: The resource for which the + policy is being specified. See the + operation documentation for the + appropriate value for this field. + + This corresponds to the ``resource`` 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.iam.v1.policy_pb2.Policy: + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. + + A Policy is a collection of bindings. A binding binds + one or more members, or principals, to a single role. + Principals can be user accounts, service accounts, + Google groups, and domains (such as G Suite). A role + is a named list of permissions; each role can be an + IAM predefined role or a user-created custom role. + + For some types of Google Cloud resources, a binding + can also specify a condition, which is a logical + expression that allows access to a resource only if + the expression evaluates to true. A condition can add + constraints based on attributes of the request, the + resource, or both. To learn which resources support + conditions in their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + + **JSON example:** + + :literal:`` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }`\ \` + + **YAML example:** + + :literal:`` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3`\ \` + + For a description of IAM and its features, see the + [IAM + documentation](https://cloud.google.com/iam/docs/). + + """ + # 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. + flattened_params = [resource] + has_flattened_params = ( + len([param for param in flattened_params if param is not None]) > 0 + ) + 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." + ) + + if isinstance(request, dict): + # - The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + request = iam_policy_pb2.SetIamPolicyRequest(**request) + elif not request: + # Null request, just make one. + request = iam_policy_pb2.SetIamPolicyRequest() + if resource is not None: + request.resource = resource + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.set_iam_policy] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("resource", request.resource),)), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def test_iam_permissions( + self, + request: Optional[Union[iam_policy_pb2.TestIamPermissionsRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> iam_policy_pb2.TestIamPermissionsResponse: + r"""Gets your permissions on a resource. Returns an empty + set of permissions if the resource doesn't exist. + + Supported resources are: + + - Reservations + + No Google IAM permissions are required to call this + method. + + .. 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 bigquery_reservation_v1 + from google.iam.v1 import iam_policy_pb2 # type: ignore + + def sample_test_iam_permissions(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = iam_policy_pb2.TestIamPermissionsRequest( + resource="resource_value", + permissions=['permissions_value1', 'permissions_value2'], + ) + + # Make the request + response = client.test_iam_permissions(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]): + The request object. Request message for ``TestIamPermissions`` 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse: + Response message for TestIamPermissions method. + """ + # Create or coerce a protobuf request object. + if isinstance(request, dict): + # - The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + request = iam_policy_pb2.TestIamPermissionsRequest(**request) + elif not request: + # Null request, just make one. + request = iam_policy_pb2.TestIamPermissionsRequest() + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.test_iam_permissions] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("resource", request.resource),)), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def create_reservation_group( + self, + request: Optional[ + Union[reservation.CreateReservationGroupRequest, dict] + ] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> reservation.ReservationGroup: + r"""Creates a new reservation group. + + .. 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 bigquery_reservation_v1 + + def sample_create_reservation_group(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.CreateReservationGroupRequest( + parent="parent_value", + reservation_group_id="reservation_group_id_value", + ) + + # Make the request + response = client.create_reservation_group(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.CreateReservationGroupRequest, dict]): + The request object. The request for + [ReservationService.CreateReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.CreateReservationGroup]. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.ReservationGroup: + A reservation group is a container + for reservations. + + """ + # Create or coerce a protobuf request object. + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.CreateReservationGroupRequest): + request = reservation.CreateReservationGroupRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_reservation_group] + + # 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),)), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_reservation_group( + self, + request: Optional[Union[reservation.GetReservationGroupRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> reservation.ReservationGroup: + r"""Returns information about the reservation group. + + .. 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 bigquery_reservation_v1 + + def sample_get_reservation_group(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.GetReservationGroupRequest( + name="name_value", + ) + + # Make the request + response = client.get_reservation_group(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.GetReservationGroupRequest, dict]): + The request object. The request for + [ReservationService.GetReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.GetReservationGroup]. + name (str): + Required. Resource name of the reservation group to + retrieve. E.g., + ``projects/myproject/locations/US/reservationGroups/team1-prod`` + + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.types.ReservationGroup: + A reservation group is a container + for reservations. + + """ + # 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. + flattened_params = [name] + has_flattened_params = ( + len([param for param in flattened_params if param is not None]) > 0 + ) + 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." + ) + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.GetReservationGroupRequest): + request = reservation.GetReservationGroupRequest(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_reservation_group] + + # 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),)), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def delete_reservation_group( + self, + request: Optional[ + Union[reservation.DeleteReservationGroupRequest, dict] + ] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> None: + r"""Deletes a reservation. Returns + ``google.rpc.Code.FAILED_PRECONDITION`` when reservation has + assignments. + + .. 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 bigquery_reservation_v1 + + def sample_delete_reservation_group(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.DeleteReservationGroupRequest( + name="name_value", + ) + + # Make the request + client.delete_reservation_group(request=request) + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.DeleteReservationGroupRequest, dict]): + The request object. The request for + [ReservationService.DeleteReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservationGroup]. + name (str): + Required. Resource name of the reservation group to + retrieve. E.g., + ``projects/myproject/locations/US/reservationGroups/team1-prod`` + + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + """ + # 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. + flattened_params = [name] + has_flattened_params = ( + len([param for param in flattened_params if param is not None]) > 0 + ) + 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." + ) + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.DeleteReservationGroupRequest): + request = reservation.DeleteReservationGroupRequest(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_reservation_group] + + # 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),)), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + def list_reservation_groups( + self, + request: Optional[Union[reservation.ListReservationGroupsRequest, dict]] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> pagers.ListReservationGroupsPager: + r"""Lists all the reservation groups for the project in + the specified location. + + .. 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 bigquery_reservation_v1 + + def sample_list_reservation_groups(): + # Create a client + client = bigquery_reservation_v1.ReservationServiceClient() + + # Initialize request argument(s) + request = bigquery_reservation_v1.ListReservationGroupsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_reservation_groups(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.bigquery_reservation_v1.types.ListReservationGroupsRequest, dict]): + The request object. The request for + [ReservationService.ListReservationGroups][google.cloud.bigquery.reservation.v1.ReservationService.ListReservationGroups]. + parent (str): + Required. The parent resource name containing project + and location, e.g.: ``projects/myproject/locations/US`` + + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListReservationGroupsPager: + The response for + [ReservationService.ListReservationGroups][google.cloud.bigquery.reservation.v1.ReservationService.ListReservationGroups]. + + 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. + flattened_params = [parent] + has_flattened_params = ( + len([param for param in flattened_params if param is not None]) > 0 + ) + 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." + ) + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, reservation.ListReservationGroupsRequest): + request = reservation.ListReservationGroupsRequest(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_reservation_groups] + + # 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),)), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # 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.ListReservationGroupsPager( + method=rpc, + request=request, + response=response, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + def __enter__(self) -> "ReservationServiceClient": return self diff --git a/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/services/reservation_service/pagers.py b/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/services/reservation_service/pagers.py index aee5c7b808d5..8627ddb401f8 100644 --- a/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/services/reservation_service/pagers.py +++ b/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/services/reservation_service/pagers.py @@ -819,3 +819,159 @@ async def async_generator(): def __repr__(self) -> str: return "{0}<{1!r}>".format(self.__class__.__name__, self._response) + + +class ListReservationGroupsPager: + """A pager for iterating through ``list_reservation_groups`` requests. + + This class thinly wraps an initial + :class:`google.cloud.bigquery_reservation_v1.types.ListReservationGroupsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``reservation_groups`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListReservationGroups`` requests and continue to iterate + through the ``reservation_groups`` field on the + corresponding responses. + + All the usual :class:`google.cloud.bigquery_reservation_v1.types.ListReservationGroupsResponse` + 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[..., reservation.ListReservationGroupsResponse], + request: reservation.ListReservationGroupsRequest, + response: reservation.ListReservationGroupsResponse, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = () + ): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.bigquery_reservation_v1.types.ListReservationGroupsRequest): + The initial request object. + response (google.cloud.bigquery_reservation_v1.types.ListReservationGroupsResponse): + The initial response object. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + """ + self._method = method + self._request = reservation.ListReservationGroupsRequest(request) + self._response = response + self._retry = retry + self._timeout = timeout + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[reservation.ListReservationGroupsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method( + self._request, + retry=self._retry, + timeout=self._timeout, + metadata=self._metadata, + ) + yield self._response + + def __iter__(self) -> Iterator[reservation.ReservationGroup]: + for page in self.pages: + yield from page.reservation_groups + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) + + +class ListReservationGroupsAsyncPager: + """A pager for iterating through ``list_reservation_groups`` requests. + + This class thinly wraps an initial + :class:`google.cloud.bigquery_reservation_v1.types.ListReservationGroupsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``reservation_groups`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListReservationGroups`` requests and continue to iterate + through the ``reservation_groups`` field on the + corresponding responses. + + All the usual :class:`google.cloud.bigquery_reservation_v1.types.ListReservationGroupsResponse` + 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[reservation.ListReservationGroupsResponse]], + request: reservation.ListReservationGroupsRequest, + response: reservation.ListReservationGroupsResponse, + *, + retry: OptionalAsyncRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = () + ): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.bigquery_reservation_v1.types.ListReservationGroupsRequest): + The initial request object. + response (google.cloud.bigquery_reservation_v1.types.ListReservationGroupsResponse): + The initial response object. + retry (google.api_core.retry.AsyncRetry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + """ + self._method = method + self._request = reservation.ListReservationGroupsRequest(request) + self._response = response + self._retry = retry + self._timeout = timeout + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[reservation.ListReservationGroupsResponse]: + 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, + retry=self._retry, + timeout=self._timeout, + metadata=self._metadata, + ) + yield self._response + + def __aiter__(self) -> AsyncIterator[reservation.ReservationGroup]: + async def async_generator(): + async for page in self.pages: + for response in page.reservation_groups: + yield response + + return async_generator() + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) diff --git a/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/base.py b/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/base.py index 87d865fa6372..4149670c19de 100644 --- a/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/base.py +++ b/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/base.py @@ -22,6 +22,8 @@ from google.api_core import retry as retries import google.auth # type: ignore from google.auth import credentials as ga_credentials # type: ignore +from google.iam.v1 import iam_policy_pb2 # type: ignore +from google.iam.v1 import policy_pb2 # type: ignore from google.oauth2 import service_account # type: ignore import google.protobuf from google.protobuf import empty_pb2 # type: ignore @@ -347,6 +349,41 @@ def _prep_wrapped_messages(self, client_info): default_timeout=300.0, client_info=client_info, ), + self.get_iam_policy: gapic_v1.method.wrap_method( + self.get_iam_policy, + default_timeout=None, + client_info=client_info, + ), + self.set_iam_policy: gapic_v1.method.wrap_method( + self.set_iam_policy, + default_timeout=None, + client_info=client_info, + ), + self.test_iam_permissions: gapic_v1.method.wrap_method( + self.test_iam_permissions, + default_timeout=None, + client_info=client_info, + ), + self.create_reservation_group: gapic_v1.method.wrap_method( + self.create_reservation_group, + default_timeout=None, + client_info=client_info, + ), + self.get_reservation_group: gapic_v1.method.wrap_method( + self.get_reservation_group, + default_timeout=None, + client_info=client_info, + ), + self.delete_reservation_group: gapic_v1.method.wrap_method( + self.delete_reservation_group, + default_timeout=None, + client_info=client_info, + ), + self.list_reservation_groups: gapic_v1.method.wrap_method( + self.list_reservation_groups, + default_timeout=None, + client_info=client_info, + ), } def close(self): @@ -582,6 +619,75 @@ def update_bi_reservation( ]: raise NotImplementedError() + @property + def get_iam_policy( + self, + ) -> Callable[ + [iam_policy_pb2.GetIamPolicyRequest], + Union[policy_pb2.Policy, Awaitable[policy_pb2.Policy]], + ]: + raise NotImplementedError() + + @property + def set_iam_policy( + self, + ) -> Callable[ + [iam_policy_pb2.SetIamPolicyRequest], + Union[policy_pb2.Policy, Awaitable[policy_pb2.Policy]], + ]: + raise NotImplementedError() + + @property + def test_iam_permissions( + self, + ) -> Callable[ + [iam_policy_pb2.TestIamPermissionsRequest], + Union[ + iam_policy_pb2.TestIamPermissionsResponse, + Awaitable[iam_policy_pb2.TestIamPermissionsResponse], + ], + ]: + raise NotImplementedError() + + @property + def create_reservation_group( + self, + ) -> Callable[ + [reservation.CreateReservationGroupRequest], + Union[reservation.ReservationGroup, Awaitable[reservation.ReservationGroup]], + ]: + raise NotImplementedError() + + @property + def get_reservation_group( + self, + ) -> Callable[ + [reservation.GetReservationGroupRequest], + Union[reservation.ReservationGroup, Awaitable[reservation.ReservationGroup]], + ]: + raise NotImplementedError() + + @property + def delete_reservation_group( + self, + ) -> Callable[ + [reservation.DeleteReservationGroupRequest], + Union[empty_pb2.Empty, Awaitable[empty_pb2.Empty]], + ]: + raise NotImplementedError() + + @property + def list_reservation_groups( + self, + ) -> Callable[ + [reservation.ListReservationGroupsRequest], + Union[ + reservation.ListReservationGroupsResponse, + Awaitable[reservation.ListReservationGroupsResponse], + ], + ]: + raise NotImplementedError() + @property def kind(self) -> str: raise NotImplementedError() diff --git a/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc.py b/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc.py index 901cc5ccbcef..48cefe4365f6 100644 --- a/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc.py +++ b/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc.py @@ -23,6 +23,8 @@ import google.auth # type: ignore from google.auth import credentials as ga_credentials # type: ignore from google.auth.transport.grpc import SslCredentials # type: ignore +from google.iam.v1 import iam_policy_pb2 # type: ignore +from google.iam.v1 import policy_pb2 # type: ignore from google.protobuf import empty_pb2 # type: ignore from google.protobuf.json_format import MessageToJson import google.protobuf.message @@ -1111,6 +1113,236 @@ def update_bi_reservation( ) return self._stubs["update_bi_reservation"] + @property + def get_iam_policy( + self, + ) -> Callable[[iam_policy_pb2.GetIamPolicyRequest], policy_pb2.Policy]: + r"""Return a callable for the get iam policy method over gRPC. + + Gets the access control policy for a resource. May return: + + - A\ ``NOT_FOUND`` error if the resource doesn't exist or you + don't have the permission to view it. + - An empty policy if the resource exists but doesn't have a set + policy. + + Supported resources are: + + - Reservations + - ReservationAssignments + + To call this method, you must have the following Google IAM + permissions: + + - ``bigqueryreservation.reservations.getIamPolicy`` to get + policies on reservations. + + Returns: + Callable[[~.GetIamPolicyRequest], + ~.Policy]: + 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_iam_policy" not in self._stubs: + self._stubs["get_iam_policy"] = self._logged_channel.unary_unary( + "/google.cloud.bigquery.reservation.v1.ReservationService/GetIamPolicy", + request_serializer=iam_policy_pb2.GetIamPolicyRequest.SerializeToString, + response_deserializer=policy_pb2.Policy.FromString, + ) + return self._stubs["get_iam_policy"] + + @property + def set_iam_policy( + self, + ) -> Callable[[iam_policy_pb2.SetIamPolicyRequest], policy_pb2.Policy]: + r"""Return a callable for the set iam policy method over gRPC. + + Sets an access control policy for a resource. Replaces any + existing policy. + + Supported resources are: + + - Reservations + + To call this method, you must have the following Google IAM + permissions: + + - ``bigqueryreservation.reservations.setIamPolicy`` to set + policies on reservations. + + Returns: + Callable[[~.SetIamPolicyRequest], + ~.Policy]: + 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 "set_iam_policy" not in self._stubs: + self._stubs["set_iam_policy"] = self._logged_channel.unary_unary( + "/google.cloud.bigquery.reservation.v1.ReservationService/SetIamPolicy", + request_serializer=iam_policy_pb2.SetIamPolicyRequest.SerializeToString, + response_deserializer=policy_pb2.Policy.FromString, + ) + return self._stubs["set_iam_policy"] + + @property + def test_iam_permissions( + self, + ) -> Callable[ + [iam_policy_pb2.TestIamPermissionsRequest], + iam_policy_pb2.TestIamPermissionsResponse, + ]: + r"""Return a callable for the test iam permissions method over gRPC. + + Gets your permissions on a resource. Returns an empty + set of permissions if the resource doesn't exist. + + Supported resources are: + + - Reservations + + No Google IAM permissions are required to call this + method. + + Returns: + Callable[[~.TestIamPermissionsRequest], + ~.TestIamPermissionsResponse]: + 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 "test_iam_permissions" not in self._stubs: + self._stubs["test_iam_permissions"] = self._logged_channel.unary_unary( + "/google.cloud.bigquery.reservation.v1.ReservationService/TestIamPermissions", + request_serializer=iam_policy_pb2.TestIamPermissionsRequest.SerializeToString, + response_deserializer=iam_policy_pb2.TestIamPermissionsResponse.FromString, + ) + return self._stubs["test_iam_permissions"] + + @property + def create_reservation_group( + self, + ) -> Callable[ + [reservation.CreateReservationGroupRequest], reservation.ReservationGroup + ]: + r"""Return a callable for the create reservation group method over gRPC. + + Creates a new reservation group. + + Returns: + Callable[[~.CreateReservationGroupRequest], + ~.ReservationGroup]: + 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_reservation_group" not in self._stubs: + self._stubs["create_reservation_group"] = self._logged_channel.unary_unary( + "/google.cloud.bigquery.reservation.v1.ReservationService/CreateReservationGroup", + request_serializer=reservation.CreateReservationGroupRequest.serialize, + response_deserializer=reservation.ReservationGroup.deserialize, + ) + return self._stubs["create_reservation_group"] + + @property + def get_reservation_group( + self, + ) -> Callable[ + [reservation.GetReservationGroupRequest], reservation.ReservationGroup + ]: + r"""Return a callable for the get reservation group method over gRPC. + + Returns information about the reservation group. + + Returns: + Callable[[~.GetReservationGroupRequest], + ~.ReservationGroup]: + 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_reservation_group" not in self._stubs: + self._stubs["get_reservation_group"] = self._logged_channel.unary_unary( + "/google.cloud.bigquery.reservation.v1.ReservationService/GetReservationGroup", + request_serializer=reservation.GetReservationGroupRequest.serialize, + response_deserializer=reservation.ReservationGroup.deserialize, + ) + return self._stubs["get_reservation_group"] + + @property + def delete_reservation_group( + self, + ) -> Callable[[reservation.DeleteReservationGroupRequest], empty_pb2.Empty]: + r"""Return a callable for the delete reservation group method over gRPC. + + Deletes a reservation. Returns + ``google.rpc.Code.FAILED_PRECONDITION`` when reservation has + assignments. + + Returns: + Callable[[~.DeleteReservationGroupRequest], + ~.Empty]: + 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_reservation_group" not in self._stubs: + self._stubs["delete_reservation_group"] = self._logged_channel.unary_unary( + "/google.cloud.bigquery.reservation.v1.ReservationService/DeleteReservationGroup", + request_serializer=reservation.DeleteReservationGroupRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs["delete_reservation_group"] + + @property + def list_reservation_groups( + self, + ) -> Callable[ + [reservation.ListReservationGroupsRequest], + reservation.ListReservationGroupsResponse, + ]: + r"""Return a callable for the list reservation groups method over gRPC. + + Lists all the reservation groups for the project in + the specified location. + + Returns: + Callable[[~.ListReservationGroupsRequest], + ~.ListReservationGroupsResponse]: + 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_reservation_groups" not in self._stubs: + self._stubs["list_reservation_groups"] = self._logged_channel.unary_unary( + "/google.cloud.bigquery.reservation.v1.ReservationService/ListReservationGroups", + request_serializer=reservation.ListReservationGroupsRequest.serialize, + response_deserializer=reservation.ListReservationGroupsResponse.deserialize, + ) + return self._stubs["list_reservation_groups"] + def close(self): self._logged_channel.close() diff --git a/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc_asyncio.py b/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc_asyncio.py index f779e288e885..adfda3b912d0 100644 --- a/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/grpc_asyncio.py @@ -25,6 +25,8 @@ from google.api_core import retry_async as retries from google.auth import credentials as ga_credentials # type: ignore from google.auth.transport.grpc import SslCredentials # type: ignore +from google.iam.v1 import iam_policy_pb2 # type: ignore +from google.iam.v1 import policy_pb2 # type: ignore from google.protobuf import empty_pb2 # type: ignore from google.protobuf.json_format import MessageToJson import google.protobuf.message @@ -1144,6 +1146,240 @@ def update_bi_reservation( ) return self._stubs["update_bi_reservation"] + @property + def get_iam_policy( + self, + ) -> Callable[[iam_policy_pb2.GetIamPolicyRequest], Awaitable[policy_pb2.Policy]]: + r"""Return a callable for the get iam policy method over gRPC. + + Gets the access control policy for a resource. May return: + + - A\ ``NOT_FOUND`` error if the resource doesn't exist or you + don't have the permission to view it. + - An empty policy if the resource exists but doesn't have a set + policy. + + Supported resources are: + + - Reservations + - ReservationAssignments + + To call this method, you must have the following Google IAM + permissions: + + - ``bigqueryreservation.reservations.getIamPolicy`` to get + policies on reservations. + + Returns: + Callable[[~.GetIamPolicyRequest], + Awaitable[~.Policy]]: + 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_iam_policy" not in self._stubs: + self._stubs["get_iam_policy"] = self._logged_channel.unary_unary( + "/google.cloud.bigquery.reservation.v1.ReservationService/GetIamPolicy", + request_serializer=iam_policy_pb2.GetIamPolicyRequest.SerializeToString, + response_deserializer=policy_pb2.Policy.FromString, + ) + return self._stubs["get_iam_policy"] + + @property + def set_iam_policy( + self, + ) -> Callable[[iam_policy_pb2.SetIamPolicyRequest], Awaitable[policy_pb2.Policy]]: + r"""Return a callable for the set iam policy method over gRPC. + + Sets an access control policy for a resource. Replaces any + existing policy. + + Supported resources are: + + - Reservations + + To call this method, you must have the following Google IAM + permissions: + + - ``bigqueryreservation.reservations.setIamPolicy`` to set + policies on reservations. + + Returns: + Callable[[~.SetIamPolicyRequest], + Awaitable[~.Policy]]: + 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 "set_iam_policy" not in self._stubs: + self._stubs["set_iam_policy"] = self._logged_channel.unary_unary( + "/google.cloud.bigquery.reservation.v1.ReservationService/SetIamPolicy", + request_serializer=iam_policy_pb2.SetIamPolicyRequest.SerializeToString, + response_deserializer=policy_pb2.Policy.FromString, + ) + return self._stubs["set_iam_policy"] + + @property + def test_iam_permissions( + self, + ) -> Callable[ + [iam_policy_pb2.TestIamPermissionsRequest], + Awaitable[iam_policy_pb2.TestIamPermissionsResponse], + ]: + r"""Return a callable for the test iam permissions method over gRPC. + + Gets your permissions on a resource. Returns an empty + set of permissions if the resource doesn't exist. + + Supported resources are: + + - Reservations + + No Google IAM permissions are required to call this + method. + + Returns: + Callable[[~.TestIamPermissionsRequest], + Awaitable[~.TestIamPermissionsResponse]]: + 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 "test_iam_permissions" not in self._stubs: + self._stubs["test_iam_permissions"] = self._logged_channel.unary_unary( + "/google.cloud.bigquery.reservation.v1.ReservationService/TestIamPermissions", + request_serializer=iam_policy_pb2.TestIamPermissionsRequest.SerializeToString, + response_deserializer=iam_policy_pb2.TestIamPermissionsResponse.FromString, + ) + return self._stubs["test_iam_permissions"] + + @property + def create_reservation_group( + self, + ) -> Callable[ + [reservation.CreateReservationGroupRequest], + Awaitable[reservation.ReservationGroup], + ]: + r"""Return a callable for the create reservation group method over gRPC. + + Creates a new reservation group. + + Returns: + Callable[[~.CreateReservationGroupRequest], + Awaitable[~.ReservationGroup]]: + 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_reservation_group" not in self._stubs: + self._stubs["create_reservation_group"] = self._logged_channel.unary_unary( + "/google.cloud.bigquery.reservation.v1.ReservationService/CreateReservationGroup", + request_serializer=reservation.CreateReservationGroupRequest.serialize, + response_deserializer=reservation.ReservationGroup.deserialize, + ) + return self._stubs["create_reservation_group"] + + @property + def get_reservation_group( + self, + ) -> Callable[ + [reservation.GetReservationGroupRequest], + Awaitable[reservation.ReservationGroup], + ]: + r"""Return a callable for the get reservation group method over gRPC. + + Returns information about the reservation group. + + Returns: + Callable[[~.GetReservationGroupRequest], + Awaitable[~.ReservationGroup]]: + 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_reservation_group" not in self._stubs: + self._stubs["get_reservation_group"] = self._logged_channel.unary_unary( + "/google.cloud.bigquery.reservation.v1.ReservationService/GetReservationGroup", + request_serializer=reservation.GetReservationGroupRequest.serialize, + response_deserializer=reservation.ReservationGroup.deserialize, + ) + return self._stubs["get_reservation_group"] + + @property + def delete_reservation_group( + self, + ) -> Callable[ + [reservation.DeleteReservationGroupRequest], Awaitable[empty_pb2.Empty] + ]: + r"""Return a callable for the delete reservation group method over gRPC. + + Deletes a reservation. Returns + ``google.rpc.Code.FAILED_PRECONDITION`` when reservation has + assignments. + + Returns: + Callable[[~.DeleteReservationGroupRequest], + Awaitable[~.Empty]]: + 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_reservation_group" not in self._stubs: + self._stubs["delete_reservation_group"] = self._logged_channel.unary_unary( + "/google.cloud.bigquery.reservation.v1.ReservationService/DeleteReservationGroup", + request_serializer=reservation.DeleteReservationGroupRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs["delete_reservation_group"] + + @property + def list_reservation_groups( + self, + ) -> Callable[ + [reservation.ListReservationGroupsRequest], + Awaitable[reservation.ListReservationGroupsResponse], + ]: + r"""Return a callable for the list reservation groups method over gRPC. + + Lists all the reservation groups for the project in + the specified location. + + Returns: + Callable[[~.ListReservationGroupsRequest], + Awaitable[~.ListReservationGroupsResponse]]: + 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_reservation_groups" not in self._stubs: + self._stubs["list_reservation_groups"] = self._logged_channel.unary_unary( + "/google.cloud.bigquery.reservation.v1.ReservationService/ListReservationGroups", + request_serializer=reservation.ListReservationGroupsRequest.serialize, + response_deserializer=reservation.ListReservationGroupsResponse.deserialize, + ) + return self._stubs["list_reservation_groups"] + def _prep_wrapped_messages(self, client_info): """Precompute the wrapped methods, overriding the base class method to use async wrappers.""" self._wrapped_methods = { @@ -1357,6 +1593,41 @@ def _prep_wrapped_messages(self, client_info): default_timeout=300.0, client_info=client_info, ), + self.get_iam_policy: self._wrap_method( + self.get_iam_policy, + default_timeout=None, + client_info=client_info, + ), + self.set_iam_policy: self._wrap_method( + self.set_iam_policy, + default_timeout=None, + client_info=client_info, + ), + self.test_iam_permissions: self._wrap_method( + self.test_iam_permissions, + default_timeout=None, + client_info=client_info, + ), + self.create_reservation_group: self._wrap_method( + self.create_reservation_group, + default_timeout=None, + client_info=client_info, + ), + self.get_reservation_group: self._wrap_method( + self.get_reservation_group, + default_timeout=None, + client_info=client_info, + ), + self.delete_reservation_group: self._wrap_method( + self.delete_reservation_group, + default_timeout=None, + client_info=client_info, + ), + self.list_reservation_groups: self._wrap_method( + self.list_reservation_groups, + default_timeout=None, + client_info=client_info, + ), } def _wrap_method(self, func, *args, **kwargs): diff --git a/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/rest.py b/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/rest.py index 132d7126b60e..3a17ba8ef4b7 100644 --- a/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/rest.py +++ b/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/rest.py @@ -24,6 +24,8 @@ from google.api_core import retry as retries from google.auth import credentials as ga_credentials # type: ignore from google.auth.transport.requests import AuthorizedSession # type: ignore +from google.iam.v1 import iam_policy_pb2 # type: ignore +from google.iam.v1 import policy_pb2 # type: ignore import google.protobuf from google.protobuf import empty_pb2 # type: ignore from google.protobuf import json_format @@ -98,6 +100,14 @@ def post_create_reservation(self, response): logging.log(f"Received response: {response}") return response + def pre_create_reservation_group(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_reservation_group(self, response): + logging.log(f"Received response: {response}") + return response + def pre_delete_assignment(self, request, metadata): logging.log(f"Received request: {request}") return request, metadata @@ -110,6 +120,10 @@ def pre_delete_reservation(self, request, metadata): logging.log(f"Received request: {request}") return request, metadata + def pre_delete_reservation_group(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + def pre_failover_reservation(self, request, metadata): logging.log(f"Received request: {request}") return request, metadata @@ -134,6 +148,14 @@ def post_get_capacity_commitment(self, response): logging.log(f"Received response: {response}") return response + def pre_get_iam_policy(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_iam_policy(self, response): + logging.log(f"Received response: {response}") + return response + def pre_get_reservation(self, request, metadata): logging.log(f"Received request: {request}") return request, metadata @@ -142,6 +164,14 @@ def post_get_reservation(self, response): logging.log(f"Received response: {response}") return response + def pre_get_reservation_group(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_reservation_group(self, response): + logging.log(f"Received response: {response}") + return response + def pre_list_assignments(self, request, metadata): logging.log(f"Received request: {request}") return request, metadata @@ -158,6 +188,14 @@ def post_list_capacity_commitments(self, response): logging.log(f"Received response: {response}") return response + def pre_list_reservation_groups(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_reservation_groups(self, response): + logging.log(f"Received response: {response}") + return response + def pre_list_reservations(self, request, metadata): logging.log(f"Received request: {request}") return request, metadata @@ -198,6 +236,14 @@ def post_search_assignments(self, response): logging.log(f"Received response: {response}") return response + def pre_set_iam_policy(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_set_iam_policy(self, response): + logging.log(f"Received response: {response}") + return response + def pre_split_capacity_commitment(self, request, metadata): logging.log(f"Received request: {request}") return request, metadata @@ -206,6 +252,14 @@ def post_split_capacity_commitment(self, response): logging.log(f"Received response: {response}") return response + def pre_test_iam_permissions(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_test_iam_permissions(self, response): + logging.log(f"Received response: {response}") + return response + def pre_update_assignment(self, request, metadata): logging.log(f"Received request: {request}") return request, metadata @@ -390,6 +444,55 @@ def post_create_reservation_with_metadata( """ return response, metadata + def pre_create_reservation_group( + self, + request: reservation.CreateReservationGroupRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + reservation.CreateReservationGroupRequest, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Pre-rpc interceptor for create_reservation_group + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def post_create_reservation_group( + self, response: reservation.ReservationGroup + ) -> reservation.ReservationGroup: + """Post-rpc interceptor for create_reservation_group + + DEPRECATED. Please use the `post_create_reservation_group_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ReservationService server but before + it is returned to user code. This `post_create_reservation_group` interceptor runs + before the `post_create_reservation_group_with_metadata` interceptor. + """ + return response + + def post_create_reservation_group_with_metadata( + self, + response: reservation.ReservationGroup, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[reservation.ReservationGroup, Sequence[Tuple[str, Union[str, bytes]]]]: + """Post-rpc interceptor for create_reservation_group + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ReservationService server but before it is returned to user code. + + We recommend only using this `post_create_reservation_group_with_metadata` + interceptor in new development instead of the `post_create_reservation_group` interceptor. + When both interceptors are used, this `post_create_reservation_group_with_metadata` interceptor runs after the + `post_create_reservation_group` interceptor. The (possibly modified) response returned by + `post_create_reservation_group` will be passed to + `post_create_reservation_group_with_metadata`. + """ + return response, metadata + def pre_delete_assignment( self, request: reservation.DeleteAssignmentRequest, @@ -433,6 +536,21 @@ def pre_delete_reservation( """ return request, metadata + def pre_delete_reservation_group( + self, + request: reservation.DeleteReservationGroupRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + reservation.DeleteReservationGroupRequest, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Pre-rpc interceptor for delete_reservation_group + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + def pre_failover_reservation( self, request: reservation.FailoverReservationRequest, @@ -578,6 +696,52 @@ def post_get_capacity_commitment_with_metadata( """ return response, metadata + def pre_get_iam_policy( + self, + request: iam_policy_pb2.GetIamPolicyRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + iam_policy_pb2.GetIamPolicyRequest, Sequence[Tuple[str, Union[str, bytes]]] + ]: + """Pre-rpc interceptor for get_iam_policy + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def post_get_iam_policy(self, response: policy_pb2.Policy) -> policy_pb2.Policy: + """Post-rpc interceptor for get_iam_policy + + DEPRECATED. Please use the `post_get_iam_policy_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ReservationService server but before + it is returned to user code. This `post_get_iam_policy` interceptor runs + before the `post_get_iam_policy_with_metadata` interceptor. + """ + return response + + def post_get_iam_policy_with_metadata( + self, + response: policy_pb2.Policy, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[policy_pb2.Policy, Sequence[Tuple[str, Union[str, bytes]]]]: + """Post-rpc interceptor for get_iam_policy + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ReservationService server but before it is returned to user code. + + We recommend only using this `post_get_iam_policy_with_metadata` + interceptor in new development instead of the `post_get_iam_policy` interceptor. + When both interceptors are used, this `post_get_iam_policy_with_metadata` interceptor runs after the + `post_get_iam_policy` interceptor. The (possibly modified) response returned by + `post_get_iam_policy` will be passed to + `post_get_iam_policy_with_metadata`. + """ + return response, metadata + def pre_get_reservation( self, request: reservation.GetReservationRequest, @@ -626,6 +790,54 @@ def post_get_reservation_with_metadata( """ return response, metadata + def pre_get_reservation_group( + self, + request: reservation.GetReservationGroupRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + reservation.GetReservationGroupRequest, Sequence[Tuple[str, Union[str, bytes]]] + ]: + """Pre-rpc interceptor for get_reservation_group + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def post_get_reservation_group( + self, response: reservation.ReservationGroup + ) -> reservation.ReservationGroup: + """Post-rpc interceptor for get_reservation_group + + DEPRECATED. Please use the `post_get_reservation_group_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ReservationService server but before + it is returned to user code. This `post_get_reservation_group` interceptor runs + before the `post_get_reservation_group_with_metadata` interceptor. + """ + return response + + def post_get_reservation_group_with_metadata( + self, + response: reservation.ReservationGroup, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[reservation.ReservationGroup, Sequence[Tuple[str, Union[str, bytes]]]]: + """Post-rpc interceptor for get_reservation_group + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ReservationService server but before it is returned to user code. + + We recommend only using this `post_get_reservation_group_with_metadata` + interceptor in new development instead of the `post_get_reservation_group` interceptor. + When both interceptors are used, this `post_get_reservation_group_with_metadata` interceptor runs after the + `post_get_reservation_group` interceptor. The (possibly modified) response returned by + `post_get_reservation_group` will be passed to + `post_get_reservation_group_with_metadata`. + """ + return response, metadata + def pre_list_assignments( self, request: reservation.ListAssignmentsRequest, @@ -728,6 +940,58 @@ def post_list_capacity_commitments_with_metadata( """ return response, metadata + def pre_list_reservation_groups( + self, + request: reservation.ListReservationGroupsRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + reservation.ListReservationGroupsRequest, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Pre-rpc interceptor for list_reservation_groups + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def post_list_reservation_groups( + self, response: reservation.ListReservationGroupsResponse + ) -> reservation.ListReservationGroupsResponse: + """Post-rpc interceptor for list_reservation_groups + + DEPRECATED. Please use the `post_list_reservation_groups_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ReservationService server but before + it is returned to user code. This `post_list_reservation_groups` interceptor runs + before the `post_list_reservation_groups_with_metadata` interceptor. + """ + return response + + def post_list_reservation_groups_with_metadata( + self, + response: reservation.ListReservationGroupsResponse, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + reservation.ListReservationGroupsResponse, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Post-rpc interceptor for list_reservation_groups + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ReservationService server but before it is returned to user code. + + We recommend only using this `post_list_reservation_groups_with_metadata` + interceptor in new development instead of the `post_list_reservation_groups` interceptor. + When both interceptors are used, this `post_list_reservation_groups_with_metadata` interceptor runs after the + `post_list_reservation_groups` interceptor. The (possibly modified) response returned by + `post_list_reservation_groups` will be passed to + `post_list_reservation_groups_with_metadata`. + """ + return response, metadata + def pre_list_reservations( self, request: reservation.ListReservationsRequest, @@ -976,6 +1240,52 @@ def post_search_assignments_with_metadata( """ return response, metadata + def pre_set_iam_policy( + self, + request: iam_policy_pb2.SetIamPolicyRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + iam_policy_pb2.SetIamPolicyRequest, Sequence[Tuple[str, Union[str, bytes]]] + ]: + """Pre-rpc interceptor for set_iam_policy + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def post_set_iam_policy(self, response: policy_pb2.Policy) -> policy_pb2.Policy: + """Post-rpc interceptor for set_iam_policy + + DEPRECATED. Please use the `post_set_iam_policy_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ReservationService server but before + it is returned to user code. This `post_set_iam_policy` interceptor runs + before the `post_set_iam_policy_with_metadata` interceptor. + """ + return response + + def post_set_iam_policy_with_metadata( + self, + response: policy_pb2.Policy, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[policy_pb2.Policy, Sequence[Tuple[str, Union[str, bytes]]]]: + """Post-rpc interceptor for set_iam_policy + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ReservationService server but before it is returned to user code. + + We recommend only using this `post_set_iam_policy_with_metadata` + interceptor in new development instead of the `post_set_iam_policy` interceptor. + When both interceptors are used, this `post_set_iam_policy_with_metadata` interceptor runs after the + `post_set_iam_policy` interceptor. The (possibly modified) response returned by + `post_set_iam_policy` will be passed to + `post_set_iam_policy_with_metadata`. + """ + return response, metadata + def pre_split_capacity_commitment( self, request: reservation.SplitCapacityCommitmentRequest, @@ -1028,6 +1338,58 @@ def post_split_capacity_commitment_with_metadata( """ return response, metadata + def pre_test_iam_permissions( + self, + request: iam_policy_pb2.TestIamPermissionsRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + iam_policy_pb2.TestIamPermissionsRequest, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Pre-rpc interceptor for test_iam_permissions + + Override in a subclass to manipulate the request or metadata + before they are sent to the ReservationService server. + """ + return request, metadata + + def post_test_iam_permissions( + self, response: iam_policy_pb2.TestIamPermissionsResponse + ) -> iam_policy_pb2.TestIamPermissionsResponse: + """Post-rpc interceptor for test_iam_permissions + + DEPRECATED. Please use the `post_test_iam_permissions_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the ReservationService server but before + it is returned to user code. This `post_test_iam_permissions` interceptor runs + before the `post_test_iam_permissions_with_metadata` interceptor. + """ + return response + + def post_test_iam_permissions_with_metadata( + self, + response: iam_policy_pb2.TestIamPermissionsResponse, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + iam_policy_pb2.TestIamPermissionsResponse, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Post-rpc interceptor for test_iam_permissions + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the ReservationService server but before it is returned to user code. + + We recommend only using this `post_test_iam_permissions_with_metadata` + interceptor in new development instead of the `post_test_iam_permissions` interceptor. + When both interceptors are used, this `post_test_iam_permissions_with_metadata` interceptor runs after the + `post_test_iam_permissions` interceptor. The (possibly modified) response returned by + `post_test_iam_permissions` will be passed to + `post_test_iam_permissions_with_metadata`. + """ + return response, metadata + def pre_update_assignment( self, request: reservation.UpdateAssignmentRequest, @@ -1810,12 +2172,12 @@ def __call__( ) return resp - class _DeleteAssignment( - _BaseReservationServiceRestTransport._BaseDeleteAssignment, + class _CreateReservationGroup( + _BaseReservationServiceRestTransport._BaseCreateReservationGroup, ReservationServiceRestStub, ): def __hash__(self): - return hash("ReservationServiceRestTransport.DeleteAssignment") + return hash("ReservationServiceRestTransport.CreateReservationGroup") @staticmethod def _get_response( @@ -1836,25 +2198,24 @@ def _get_response( timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, ) return response def __call__( self, - request: reservation.DeleteAssignmentRequest, + request: reservation.CreateReservationGroupRequest, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ): - r"""Call the delete assignment method over HTTP. + ) -> reservation.ReservationGroup: + r"""Call the create reservation group method over HTTP. Args: - request (~.reservation.DeleteAssignmentRequest): + request (~.reservation.CreateReservationGroupRequest): The request object. The request for - [ReservationService.DeleteAssignment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteAssignment]. - Note: "bigquery.reservationAssignments.delete" - permission is required on the related assignee. + [ReservationService.CreateReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.CreateReservationGroup]. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -1862,21 +2223,31 @@ def __call__( sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. + + Returns: + ~.reservation.ReservationGroup: + A reservation group is a container + for reservations. + """ http_options = ( - _BaseReservationServiceRestTransport._BaseDeleteAssignment._get_http_options() + _BaseReservationServiceRestTransport._BaseCreateReservationGroup._get_http_options() ) - request, metadata = self._interceptor.pre_delete_assignment( + request, metadata = self._interceptor.pre_create_reservation_group( request, metadata ) - transcoded_request = _BaseReservationServiceRestTransport._BaseDeleteAssignment._get_transcoded_request( + transcoded_request = _BaseReservationServiceRestTransport._BaseCreateReservationGroup._get_transcoded_request( http_options, request ) + body = _BaseReservationServiceRestTransport._BaseCreateReservationGroup._get_request_body_json( + transcoded_request + ) + # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseDeleteAssignment._get_query_params_json( + query_params = _BaseReservationServiceRestTransport._BaseCreateReservationGroup._get_query_params_json( transcoded_request ) @@ -1888,7 +2259,7 @@ def __call__( ) method = transcoded_request["method"] try: - request_payload = json_format.MessageToJson(request) + request_payload = type(request).to_json(request) except: request_payload = None http_request = { @@ -1898,26 +2269,175 @@ def __call__( "headers": dict(metadata), } _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.DeleteAssignment", + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.CreateReservationGroup", extra={ "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "DeleteAssignment", + "rpcName": "CreateReservationGroup", "httpRequest": http_request, "metadata": http_request["headers"], }, ) # Send the request - response = ReservationServiceRestTransport._DeleteAssignment._get_response( - self._host, - metadata, - query_params, - self._session, - timeout, - transcoded_request, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + response = ( + ReservationServiceRestTransport._CreateReservationGroup._get_response( + self._host, + metadata, + query_params, + self._session, + timeout, + transcoded_request, + 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 = reservation.ReservationGroup() + pb_resp = reservation.ReservationGroup.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_create_reservation_group(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_create_reservation_group_with_metadata( + resp, response_metadata + ) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = reservation.ReservationGroup.to_json(response) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.create_reservation_group", + extra={ + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "CreateReservationGroup", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _DeleteAssignment( + _BaseReservationServiceRestTransport._BaseDeleteAssignment, + ReservationServiceRestStub, + ): + def __hash__(self): + return hash("ReservationServiceRestTransport.DeleteAssignment") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None, + ): + uri = transcoded_request["uri"] + method = transcoded_request["method"] + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + return response + + def __call__( + self, + request: reservation.DeleteAssignmentRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ): + r"""Call the delete assignment method over HTTP. + + Args: + request (~.reservation.DeleteAssignmentRequest): + The request object. The request for + [ReservationService.DeleteAssignment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteAssignment]. + Note: "bigquery.reservationAssignments.delete" + permission is required on the related assignee. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + """ + + http_options = ( + _BaseReservationServiceRestTransport._BaseDeleteAssignment._get_http_options() + ) + + request, metadata = self._interceptor.pre_delete_assignment( + request, metadata + ) + transcoded_request = _BaseReservationServiceRestTransport._BaseDeleteAssignment._get_transcoded_request( + http_options, request + ) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseDeleteAssignment._get_query_params_json( + transcoded_request + ) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + request_url = "{host}{uri}".format( + host=self._host, uri=transcoded_request["uri"] + ) + method = transcoded_request["method"] + try: + request_payload = json_format.MessageToJson(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.DeleteAssignment", + extra={ + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "DeleteAssignment", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ReservationServiceRestTransport._DeleteAssignment._get_response( + self._host, + metadata, + query_params, + self._session, + timeout, + transcoded_request, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception # subclass. if response.status_code >= 400: raise core_exceptions.from_http_response(response) @@ -2145,6 +2665,118 @@ def __call__( if response.status_code >= 400: raise core_exceptions.from_http_response(response) + class _DeleteReservationGroup( + _BaseReservationServiceRestTransport._BaseDeleteReservationGroup, + ReservationServiceRestStub, + ): + def __hash__(self): + return hash("ReservationServiceRestTransport.DeleteReservationGroup") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None, + ): + uri = transcoded_request["uri"] + method = transcoded_request["method"] + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + return response + + def __call__( + self, + request: reservation.DeleteReservationGroupRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ): + r"""Call the delete reservation group method over HTTP. + + Args: + request (~.reservation.DeleteReservationGroupRequest): + The request object. The request for + [ReservationService.DeleteReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservationGroup]. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + """ + + http_options = ( + _BaseReservationServiceRestTransport._BaseDeleteReservationGroup._get_http_options() + ) + + request, metadata = self._interceptor.pre_delete_reservation_group( + request, metadata + ) + transcoded_request = _BaseReservationServiceRestTransport._BaseDeleteReservationGroup._get_transcoded_request( + http_options, request + ) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseDeleteReservationGroup._get_query_params_json( + transcoded_request + ) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + request_url = "{host}{uri}".format( + host=self._host, uri=transcoded_request["uri"] + ) + method = transcoded_request["method"] + try: + request_payload = json_format.MessageToJson(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.DeleteReservationGroup", + extra={ + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "DeleteReservationGroup", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ( + ReservationServiceRestTransport._DeleteReservationGroup._get_response( + self._host, + metadata, + query_params, + self._session, + timeout, + transcoded_request, + ) + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + class _FailoverReservation( _BaseReservationServiceRestTransport._BaseFailoverReservation, ReservationServiceRestStub, @@ -2615,12 +3247,12 @@ def __call__( ) return resp - class _GetReservation( - _BaseReservationServiceRestTransport._BaseGetReservation, + class _GetIamPolicy( + _BaseReservationServiceRestTransport._BaseGetIamPolicy, ReservationServiceRestStub, ): def __hash__(self): - return hash("ReservationServiceRestTransport.GetReservation") + return hash("ReservationServiceRestTransport.GetIamPolicy") @staticmethod def _get_response( @@ -2646,18 +3278,17 @@ def _get_response( def __call__( self, - request: reservation.GetReservationRequest, + request: iam_policy_pb2.GetIamPolicyRequest, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> reservation.Reservation: - r"""Call the get reservation method over HTTP. + ) -> policy_pb2.Policy: + r"""Call the get iam policy method over HTTP. Args: - request (~.reservation.GetReservationRequest): - The request object. The request for - [ReservationService.GetReservation][google.cloud.bigquery.reservation.v1.ReservationService.GetReservation]. + request (~.iam_policy_pb2.GetIamPolicyRequest): + The request object. Request message for ``GetIamPolicy`` method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -2667,23 +3298,96 @@ def __call__( be of type `bytes`. Returns: - ~.reservation.Reservation: - A reservation is a mechanism used to - guarantee slots to users. + ~.policy_pb2.Policy: + An Identity and Access Management (IAM) policy, which + specifies access controls for Google Cloud resources. + + A ``Policy`` is a collection of ``bindings``. A + ``binding`` binds one or more ``members``, or + principals, to a single ``role``. Principals can be user + accounts, service accounts, Google groups, and domains + (such as G Suite). A ``role`` is a named list of + permissions; each ``role`` can be an IAM predefined role + or a user-created custom role. + + For some types of Google Cloud resources, a ``binding`` + can also specify a ``condition``, which is a logical + expression that allows access to a resource only if the + expression evaluates to ``true``. A condition can add + constraints based on attributes of the request, the + resource, or both. To learn which resources support + conditions in their IAM policies, see the `IAM + documentation `__. + + **JSON example:** + + :: + + { + "bindings": [ + { + "role": "roles/resourcemanager.organizationAdmin", + "members": [ + "user:mike@example.com", + "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" + ] + }, + { + "role": "roles/resourcemanager.organizationViewer", + "members": [ + "user:eve@example.com" + ], + "condition": { + "title": "expirable access", + "description": "Does not grant access after Sep 2020", + "expression": "request.time < + timestamp('2020-10-01T00:00:00.000Z')", + } + } + ], + "etag": "BwWWja0YfJA=", + "version": 3 + } + + **YAML example:** + + :: + + bindings: + - members: + - user:mike@example.com + - group:admins@example.com + - domain:google.com + - serviceAccount:my-project-id@appspot.gserviceaccount.com + role: roles/resourcemanager.organizationAdmin + - members: + - user:eve@example.com + role: roles/resourcemanager.organizationViewer + condition: + title: expirable access + description: Does not grant access after Sep 2020 + expression: request.time < timestamp('2020-10-01T00:00:00.000Z') + etag: BwWWja0YfJA= + version: 3 + + For a description of IAM and its features, see the `IAM + documentation `__. """ http_options = ( - _BaseReservationServiceRestTransport._BaseGetReservation._get_http_options() + _BaseReservationServiceRestTransport._BaseGetIamPolicy._get_http_options() ) - request, metadata = self._interceptor.pre_get_reservation(request, metadata) - transcoded_request = _BaseReservationServiceRestTransport._BaseGetReservation._get_transcoded_request( + request, metadata = self._interceptor.pre_get_iam_policy(request, metadata) + transcoded_request = _BaseReservationServiceRestTransport._BaseGetIamPolicy._get_transcoded_request( http_options, request ) # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseGetReservation._get_query_params_json( + query_params = _BaseReservationServiceRestTransport._BaseGetIamPolicy._get_query_params_json( transcoded_request ) @@ -2695,7 +3399,7 @@ def __call__( ) method = transcoded_request["method"] try: - request_payload = type(request).to_json(request) + request_payload = json_format.MessageToJson(request) except: request_payload = None http_request = { @@ -2705,17 +3409,17 @@ def __call__( "headers": dict(metadata), } _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.GetReservation", + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.GetIamPolicy", extra={ "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "GetReservation", + "rpcName": "GetIamPolicy", "httpRequest": http_request, "metadata": http_request["headers"], }, ) # Send the request - response = ReservationServiceRestTransport._GetReservation._get_response( + response = ReservationServiceRestTransport._GetIamPolicy._get_response( self._host, metadata, query_params, @@ -2730,21 +3434,21 @@ def __call__( raise core_exceptions.from_http_response(response) # Return the response - resp = reservation.Reservation() - pb_resp = reservation.Reservation.pb(resp) + resp = policy_pb2.Policy() + pb_resp = resp json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_get_reservation(resp) + resp = self._interceptor.post_get_iam_policy(resp) response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_get_reservation_with_metadata( + resp, _ = self._interceptor.post_get_iam_policy_with_metadata( resp, response_metadata ) if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( logging.DEBUG ): # pragma: NO COVER try: - response_payload = reservation.Reservation.to_json(response) + response_payload = json_format.MessageToJson(resp) except: response_payload = None http_response = { @@ -2753,22 +3457,22 @@ def __call__( "status": response.status_code, } _LOGGER.debug( - "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.get_reservation", + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.get_iam_policy", extra={ "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "GetReservation", + "rpcName": "GetIamPolicy", "metadata": http_response["headers"], "httpResponse": http_response, }, ) return resp - class _ListAssignments( - _BaseReservationServiceRestTransport._BaseListAssignments, + class _GetReservation( + _BaseReservationServiceRestTransport._BaseGetReservation, ReservationServiceRestStub, ): def __hash__(self): - return hash("ReservationServiceRestTransport.ListAssignments") + return hash("ReservationServiceRestTransport.GetReservation") @staticmethod def _get_response( @@ -2794,18 +3498,18 @@ def _get_response( def __call__( self, - request: reservation.ListAssignmentsRequest, + request: reservation.GetReservationRequest, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> reservation.ListAssignmentsResponse: - r"""Call the list assignments method over HTTP. + ) -> reservation.Reservation: + r"""Call the get reservation method over HTTP. Args: - request (~.reservation.ListAssignmentsRequest): + request (~.reservation.GetReservationRequest): The request object. The request for - [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments]. + [ReservationService.GetReservation][google.cloud.bigquery.reservation.v1.ReservationService.GetReservation]. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -2815,25 +3519,23 @@ def __call__( be of type `bytes`. Returns: - ~.reservation.ListAssignmentsResponse: - The response for - [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments]. + ~.reservation.Reservation: + A reservation is a mechanism used to + guarantee slots to users. """ http_options = ( - _BaseReservationServiceRestTransport._BaseListAssignments._get_http_options() + _BaseReservationServiceRestTransport._BaseGetReservation._get_http_options() ) - request, metadata = self._interceptor.pre_list_assignments( - request, metadata - ) - transcoded_request = _BaseReservationServiceRestTransport._BaseListAssignments._get_transcoded_request( + request, metadata = self._interceptor.pre_get_reservation(request, metadata) + transcoded_request = _BaseReservationServiceRestTransport._BaseGetReservation._get_transcoded_request( http_options, request ) # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseListAssignments._get_query_params_json( + query_params = _BaseReservationServiceRestTransport._BaseGetReservation._get_query_params_json( transcoded_request ) @@ -2855,17 +3557,17 @@ def __call__( "headers": dict(metadata), } _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.ListAssignments", + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.GetReservation", extra={ "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "ListAssignments", + "rpcName": "GetReservation", "httpRequest": http_request, "metadata": http_request["headers"], }, ) # Send the request - response = ReservationServiceRestTransport._ListAssignments._get_response( + response = ReservationServiceRestTransport._GetReservation._get_response( self._host, metadata, query_params, @@ -2880,23 +3582,21 @@ def __call__( raise core_exceptions.from_http_response(response) # Return the response - resp = reservation.ListAssignmentsResponse() - pb_resp = reservation.ListAssignmentsResponse.pb(resp) + resp = reservation.Reservation() + pb_resp = reservation.Reservation.pb(resp) json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_list_assignments(resp) + resp = self._interceptor.post_get_reservation(resp) response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_list_assignments_with_metadata( + resp, _ = self._interceptor.post_get_reservation_with_metadata( resp, response_metadata ) if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( logging.DEBUG ): # pragma: NO COVER try: - response_payload = reservation.ListAssignmentsResponse.to_json( - response - ) + response_payload = reservation.Reservation.to_json(response) except: response_payload = None http_response = { @@ -2905,22 +3605,22 @@ def __call__( "status": response.status_code, } _LOGGER.debug( - "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.list_assignments", + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.get_reservation", extra={ "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "ListAssignments", + "rpcName": "GetReservation", "metadata": http_response["headers"], "httpResponse": http_response, }, ) return resp - class _ListCapacityCommitments( - _BaseReservationServiceRestTransport._BaseListCapacityCommitments, + class _GetReservationGroup( + _BaseReservationServiceRestTransport._BaseGetReservationGroup, ReservationServiceRestStub, ): def __hash__(self): - return hash("ReservationServiceRestTransport.ListCapacityCommitments") + return hash("ReservationServiceRestTransport.GetReservationGroup") @staticmethod def _get_response( @@ -2946,18 +3646,18 @@ def _get_response( def __call__( self, - request: reservation.ListCapacityCommitmentsRequest, + request: reservation.GetReservationGroupRequest, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> reservation.ListCapacityCommitmentsResponse: - r"""Call the list capacity commitments method over HTTP. + ) -> reservation.ReservationGroup: + r"""Call the get reservation group method over HTTP. Args: - request (~.reservation.ListCapacityCommitmentsRequest): + request (~.reservation.GetReservationGroupRequest): The request object. The request for - [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments]. + [ReservationService.GetReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.GetReservationGroup]. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -2967,25 +3667,25 @@ def __call__( be of type `bytes`. Returns: - ~.reservation.ListCapacityCommitmentsResponse: - The response for - [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments]. + ~.reservation.ReservationGroup: + A reservation group is a container + for reservations. """ http_options = ( - _BaseReservationServiceRestTransport._BaseListCapacityCommitments._get_http_options() + _BaseReservationServiceRestTransport._BaseGetReservationGroup._get_http_options() ) - request, metadata = self._interceptor.pre_list_capacity_commitments( + request, metadata = self._interceptor.pre_get_reservation_group( request, metadata ) - transcoded_request = _BaseReservationServiceRestTransport._BaseListCapacityCommitments._get_transcoded_request( + transcoded_request = _BaseReservationServiceRestTransport._BaseGetReservationGroup._get_transcoded_request( http_options, request ) # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseListCapacityCommitments._get_query_params_json( + query_params = _BaseReservationServiceRestTransport._BaseGetReservationGroup._get_query_params_json( transcoded_request ) @@ -3007,10 +3707,10 @@ def __call__( "headers": dict(metadata), } _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.ListCapacityCommitments", + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.GetReservationGroup", extra={ "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "ListCapacityCommitments", + "rpcName": "GetReservationGroup", "httpRequest": http_request, "metadata": http_request["headers"], }, @@ -3018,7 +3718,7 @@ def __call__( # Send the request response = ( - ReservationServiceRestTransport._ListCapacityCommitments._get_response( + ReservationServiceRestTransport._GetReservationGroup._get_response( self._host, metadata, query_params, @@ -3034,23 +3734,21 @@ def __call__( raise core_exceptions.from_http_response(response) # Return the response - resp = reservation.ListCapacityCommitmentsResponse() - pb_resp = reservation.ListCapacityCommitmentsResponse.pb(resp) + resp = reservation.ReservationGroup() + pb_resp = reservation.ReservationGroup.pb(resp) json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_list_capacity_commitments(resp) + resp = self._interceptor.post_get_reservation_group(resp) response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_list_capacity_commitments_with_metadata( + resp, _ = self._interceptor.post_get_reservation_group_with_metadata( resp, response_metadata ) if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( logging.DEBUG ): # pragma: NO COVER try: - response_payload = ( - reservation.ListCapacityCommitmentsResponse.to_json(response) - ) + response_payload = reservation.ReservationGroup.to_json(response) except: response_payload = None http_response = { @@ -3059,22 +3757,22 @@ def __call__( "status": response.status_code, } _LOGGER.debug( - "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.list_capacity_commitments", + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.get_reservation_group", extra={ "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "ListCapacityCommitments", + "rpcName": "GetReservationGroup", "metadata": http_response["headers"], "httpResponse": http_response, }, ) return resp - class _ListReservations( - _BaseReservationServiceRestTransport._BaseListReservations, + class _ListAssignments( + _BaseReservationServiceRestTransport._BaseListAssignments, ReservationServiceRestStub, ): def __hash__(self): - return hash("ReservationServiceRestTransport.ListReservations") + return hash("ReservationServiceRestTransport.ListAssignments") @staticmethod def _get_response( @@ -3100,18 +3798,18 @@ def _get_response( def __call__( self, - request: reservation.ListReservationsRequest, + request: reservation.ListAssignmentsRequest, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> reservation.ListReservationsResponse: - r"""Call the list reservations method over HTTP. + ) -> reservation.ListAssignmentsResponse: + r"""Call the list assignments method over HTTP. Args: - request (~.reservation.ListReservationsRequest): + request (~.reservation.ListAssignmentsRequest): The request object. The request for - [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations]. + [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments]. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -3121,25 +3819,25 @@ def __call__( be of type `bytes`. Returns: - ~.reservation.ListReservationsResponse: + ~.reservation.ListAssignmentsResponse: The response for - [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations]. + [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments]. """ http_options = ( - _BaseReservationServiceRestTransport._BaseListReservations._get_http_options() + _BaseReservationServiceRestTransport._BaseListAssignments._get_http_options() ) - request, metadata = self._interceptor.pre_list_reservations( + request, metadata = self._interceptor.pre_list_assignments( request, metadata ) - transcoded_request = _BaseReservationServiceRestTransport._BaseListReservations._get_transcoded_request( + transcoded_request = _BaseReservationServiceRestTransport._BaseListAssignments._get_transcoded_request( http_options, request ) # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseListReservations._get_query_params_json( + query_params = _BaseReservationServiceRestTransport._BaseListAssignments._get_query_params_json( transcoded_request ) @@ -3161,17 +3859,17 @@ def __call__( "headers": dict(metadata), } _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.ListReservations", + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.ListAssignments", extra={ "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "ListReservations", + "rpcName": "ListAssignments", "httpRequest": http_request, "metadata": http_request["headers"], }, ) # Send the request - response = ReservationServiceRestTransport._ListReservations._get_response( + response = ReservationServiceRestTransport._ListAssignments._get_response( self._host, metadata, query_params, @@ -3186,21 +3884,21 @@ def __call__( raise core_exceptions.from_http_response(response) # Return the response - resp = reservation.ListReservationsResponse() - pb_resp = reservation.ListReservationsResponse.pb(resp) + resp = reservation.ListAssignmentsResponse() + pb_resp = reservation.ListAssignmentsResponse.pb(resp) json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_list_reservations(resp) + resp = self._interceptor.post_list_assignments(resp) response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_list_reservations_with_metadata( + resp, _ = self._interceptor.post_list_assignments_with_metadata( resp, response_metadata ) if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( logging.DEBUG ): # pragma: NO COVER try: - response_payload = reservation.ListReservationsResponse.to_json( + response_payload = reservation.ListAssignmentsResponse.to_json( response ) except: @@ -3211,22 +3909,22 @@ def __call__( "status": response.status_code, } _LOGGER.debug( - "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.list_reservations", + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.list_assignments", extra={ "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "ListReservations", + "rpcName": "ListAssignments", "metadata": http_response["headers"], "httpResponse": http_response, }, ) return resp - class _MergeCapacityCommitments( - _BaseReservationServiceRestTransport._BaseMergeCapacityCommitments, + class _ListCapacityCommitments( + _BaseReservationServiceRestTransport._BaseListCapacityCommitments, ReservationServiceRestStub, ): def __hash__(self): - return hash("ReservationServiceRestTransport.MergeCapacityCommitments") + return hash("ReservationServiceRestTransport.ListCapacityCommitments") @staticmethod def _get_response( @@ -3247,69 +3945,51 @@ def _get_response( timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, ) return response def __call__( self, - request: reservation.MergeCapacityCommitmentsRequest, + request: reservation.ListCapacityCommitmentsRequest, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> reservation.CapacityCommitment: - r"""Call the merge capacity - commitments method over HTTP. - - Args: - request (~.reservation.MergeCapacityCommitmentsRequest): - The request object. The request for - [ReservationService.MergeCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.MergeCapacityCommitments]. - 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, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - ~.reservation.CapacityCommitment: - Capacity commitment is a way to - purchase compute capacity for BigQuery - jobs (in the form of slots) with some - committed period of usage. Annual - commitments renew by default. - Commitments can be removed after their - commitment end time passes. + ) -> reservation.ListCapacityCommitmentsResponse: + r"""Call the list capacity commitments method over HTTP. - In order to remove annual commitment, - its plan needs to be changed to monthly - or flex first. + Args: + request (~.reservation.ListCapacityCommitmentsRequest): + The request object. The request for + [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments]. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. - A capacity commitment resource exists as - a child resource of the admin project. + Returns: + ~.reservation.ListCapacityCommitmentsResponse: + The response for + [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments]. """ http_options = ( - _BaseReservationServiceRestTransport._BaseMergeCapacityCommitments._get_http_options() + _BaseReservationServiceRestTransport._BaseListCapacityCommitments._get_http_options() ) - request, metadata = self._interceptor.pre_merge_capacity_commitments( + request, metadata = self._interceptor.pre_list_capacity_commitments( request, metadata ) - transcoded_request = _BaseReservationServiceRestTransport._BaseMergeCapacityCommitments._get_transcoded_request( + transcoded_request = _BaseReservationServiceRestTransport._BaseListCapacityCommitments._get_transcoded_request( http_options, request ) - body = _BaseReservationServiceRestTransport._BaseMergeCapacityCommitments._get_request_body_json( - transcoded_request - ) - # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseMergeCapacityCommitments._get_query_params_json( + query_params = _BaseReservationServiceRestTransport._BaseListCapacityCommitments._get_query_params_json( transcoded_request ) @@ -3331,10 +4011,10 @@ def __call__( "headers": dict(metadata), } _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.MergeCapacityCommitments", + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.ListCapacityCommitments", extra={ "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "MergeCapacityCommitments", + "rpcName": "ListCapacityCommitments", "httpRequest": http_request, "metadata": http_request["headers"], }, @@ -3342,14 +4022,13 @@ def __call__( # Send the request response = ( - ReservationServiceRestTransport._MergeCapacityCommitments._get_response( + ReservationServiceRestTransport._ListCapacityCommitments._get_response( self._host, metadata, query_params, self._session, timeout, transcoded_request, - body, ) ) @@ -3359,21 +4038,23 @@ def __call__( raise core_exceptions.from_http_response(response) # Return the response - resp = reservation.CapacityCommitment() - pb_resp = reservation.CapacityCommitment.pb(resp) + resp = reservation.ListCapacityCommitmentsResponse() + pb_resp = reservation.ListCapacityCommitmentsResponse.pb(resp) json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_merge_capacity_commitments(resp) + resp = self._interceptor.post_list_capacity_commitments(resp) response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_merge_capacity_commitments_with_metadata( + resp, _ = self._interceptor.post_list_capacity_commitments_with_metadata( resp, response_metadata ) if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( logging.DEBUG ): # pragma: NO COVER try: - response_payload = reservation.CapacityCommitment.to_json(response) + response_payload = ( + reservation.ListCapacityCommitmentsResponse.to_json(response) + ) except: response_payload = None http_response = { @@ -3382,22 +4063,22 @@ def __call__( "status": response.status_code, } _LOGGER.debug( - "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.merge_capacity_commitments", + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.list_capacity_commitments", extra={ "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "MergeCapacityCommitments", + "rpcName": "ListCapacityCommitments", "metadata": http_response["headers"], "httpResponse": http_response, }, ) return resp - class _MoveAssignment( - _BaseReservationServiceRestTransport._BaseMoveAssignment, + class _ListReservationGroups( + _BaseReservationServiceRestTransport._BaseListReservationGroups, ReservationServiceRestStub, ): def __hash__(self): - return hash("ReservationServiceRestTransport.MoveAssignment") + return hash("ReservationServiceRestTransport.ListReservationGroups") @staticmethod def _get_response( @@ -3418,31 +4099,820 @@ def _get_response( timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, ) return response def __call__( self, - request: reservation.MoveAssignmentRequest, + request: reservation.ListReservationGroupsRequest, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> reservation.Assignment: - r"""Call the move assignment method over HTTP. + ) -> reservation.ListReservationGroupsResponse: + r"""Call the list reservation groups method over HTTP. Args: - request (~.reservation.MoveAssignmentRequest): + request (~.reservation.ListReservationGroupsRequest): The request object. The request for - [ReservationService.MoveAssignment][google.cloud.bigquery.reservation.v1.ReservationService.MoveAssignment]. - - **Note**: "bigquery.reservationAssignments.create" - permission is required on the destination_id. + [ReservationService.ListReservationGroups][google.cloud.bigquery.reservation.v1.ReservationService.ListReservationGroups]. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.reservation.ListReservationGroupsResponse: + The response for + [ReservationService.ListReservationGroups][google.cloud.bigquery.reservation.v1.ReservationService.ListReservationGroups]. + + """ + + http_options = ( + _BaseReservationServiceRestTransport._BaseListReservationGroups._get_http_options() + ) + + request, metadata = self._interceptor.pre_list_reservation_groups( + request, metadata + ) + transcoded_request = _BaseReservationServiceRestTransport._BaseListReservationGroups._get_transcoded_request( + http_options, request + ) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseListReservationGroups._get_query_params_json( + transcoded_request + ) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + request_url = "{host}{uri}".format( + host=self._host, uri=transcoded_request["uri"] + ) + method = transcoded_request["method"] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.ListReservationGroups", + extra={ + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "ListReservationGroups", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ( + ReservationServiceRestTransport._ListReservationGroups._get_response( + self._host, + metadata, + query_params, + self._session, + timeout, + transcoded_request, + ) + ) + + # 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 = reservation.ListReservationGroupsResponse() + pb_resp = reservation.ListReservationGroupsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_list_reservation_groups(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_list_reservation_groups_with_metadata( + resp, response_metadata + ) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = ( + reservation.ListReservationGroupsResponse.to_json(response) + ) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.list_reservation_groups", + extra={ + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "ListReservationGroups", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _ListReservations( + _BaseReservationServiceRestTransport._BaseListReservations, + ReservationServiceRestStub, + ): + def __hash__(self): + return hash("ReservationServiceRestTransport.ListReservations") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None, + ): + uri = transcoded_request["uri"] + method = transcoded_request["method"] + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + return response + + def __call__( + self, + request: reservation.ListReservationsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> reservation.ListReservationsResponse: + r"""Call the list reservations method over HTTP. + + Args: + request (~.reservation.ListReservationsRequest): + The request object. The request for + [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations]. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.reservation.ListReservationsResponse: + The response for + [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations]. + + """ + + http_options = ( + _BaseReservationServiceRestTransport._BaseListReservations._get_http_options() + ) + + request, metadata = self._interceptor.pre_list_reservations( + request, metadata + ) + transcoded_request = _BaseReservationServiceRestTransport._BaseListReservations._get_transcoded_request( + http_options, request + ) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseListReservations._get_query_params_json( + transcoded_request + ) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + request_url = "{host}{uri}".format( + host=self._host, uri=transcoded_request["uri"] + ) + method = transcoded_request["method"] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.ListReservations", + extra={ + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "ListReservations", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ReservationServiceRestTransport._ListReservations._get_response( + self._host, + metadata, + query_params, + self._session, + timeout, + transcoded_request, + ) + + # 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 = reservation.ListReservationsResponse() + pb_resp = reservation.ListReservationsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_list_reservations(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_list_reservations_with_metadata( + resp, response_metadata + ) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = reservation.ListReservationsResponse.to_json( + response + ) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.list_reservations", + extra={ + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "ListReservations", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _MergeCapacityCommitments( + _BaseReservationServiceRestTransport._BaseMergeCapacityCommitments, + ReservationServiceRestStub, + ): + def __hash__(self): + return hash("ReservationServiceRestTransport.MergeCapacityCommitments") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None, + ): + uri = transcoded_request["uri"] + method = transcoded_request["method"] + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + return response + + def __call__( + self, + request: reservation.MergeCapacityCommitmentsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> reservation.CapacityCommitment: + r"""Call the merge capacity + commitments method over HTTP. + + Args: + request (~.reservation.MergeCapacityCommitmentsRequest): + The request object. The request for + [ReservationService.MergeCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.MergeCapacityCommitments]. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.reservation.CapacityCommitment: + Capacity commitment is a way to + purchase compute capacity for BigQuery + jobs (in the form of slots) with some + committed period of usage. Annual + commitments renew by default. + Commitments can be removed after their + commitment end time passes. + + In order to remove annual commitment, + its plan needs to be changed to monthly + or flex first. + + A capacity commitment resource exists as + a child resource of the admin project. + + """ + + http_options = ( + _BaseReservationServiceRestTransport._BaseMergeCapacityCommitments._get_http_options() + ) + + request, metadata = self._interceptor.pre_merge_capacity_commitments( + request, metadata + ) + transcoded_request = _BaseReservationServiceRestTransport._BaseMergeCapacityCommitments._get_transcoded_request( + http_options, request + ) + + body = _BaseReservationServiceRestTransport._BaseMergeCapacityCommitments._get_request_body_json( + transcoded_request + ) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseMergeCapacityCommitments._get_query_params_json( + transcoded_request + ) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + request_url = "{host}{uri}".format( + host=self._host, uri=transcoded_request["uri"] + ) + method = transcoded_request["method"] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.MergeCapacityCommitments", + extra={ + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "MergeCapacityCommitments", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ( + ReservationServiceRestTransport._MergeCapacityCommitments._get_response( + self._host, + metadata, + query_params, + self._session, + timeout, + transcoded_request, + 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 = reservation.CapacityCommitment() + pb_resp = reservation.CapacityCommitment.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_merge_capacity_commitments(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_merge_capacity_commitments_with_metadata( + resp, response_metadata + ) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = reservation.CapacityCommitment.to_json(response) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.merge_capacity_commitments", + extra={ + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "MergeCapacityCommitments", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _MoveAssignment( + _BaseReservationServiceRestTransport._BaseMoveAssignment, + ReservationServiceRestStub, + ): + def __hash__(self): + return hash("ReservationServiceRestTransport.MoveAssignment") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None, + ): + uri = transcoded_request["uri"] + method = transcoded_request["method"] + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + return response + + def __call__( + self, + request: reservation.MoveAssignmentRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> reservation.Assignment: + r"""Call the move assignment method over HTTP. + + Args: + request (~.reservation.MoveAssignmentRequest): + The request object. The request for + [ReservationService.MoveAssignment][google.cloud.bigquery.reservation.v1.ReservationService.MoveAssignment]. + + **Note**: "bigquery.reservationAssignments.create" + permission is required on the destination_id. + + **Note**: "bigquery.reservationAssignments.create" and + "bigquery.reservationAssignments.delete" permission are + required on the related assignee. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.reservation.Assignment: + An assignment allows a project to + submit jobs of a certain type using + slots from the specified reservation. + + """ + + http_options = ( + _BaseReservationServiceRestTransport._BaseMoveAssignment._get_http_options() + ) + + request, metadata = self._interceptor.pre_move_assignment(request, metadata) + transcoded_request = _BaseReservationServiceRestTransport._BaseMoveAssignment._get_transcoded_request( + http_options, request + ) + + body = _BaseReservationServiceRestTransport._BaseMoveAssignment._get_request_body_json( + transcoded_request + ) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseMoveAssignment._get_query_params_json( + transcoded_request + ) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + request_url = "{host}{uri}".format( + host=self._host, uri=transcoded_request["uri"] + ) + method = transcoded_request["method"] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.MoveAssignment", + extra={ + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "MoveAssignment", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ReservationServiceRestTransport._MoveAssignment._get_response( + self._host, + metadata, + query_params, + self._session, + timeout, + transcoded_request, + 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 = reservation.Assignment() + pb_resp = reservation.Assignment.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_move_assignment(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_move_assignment_with_metadata( + resp, response_metadata + ) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = reservation.Assignment.to_json(response) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.move_assignment", + extra={ + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "MoveAssignment", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _SearchAllAssignments( + _BaseReservationServiceRestTransport._BaseSearchAllAssignments, + ReservationServiceRestStub, + ): + def __hash__(self): + return hash("ReservationServiceRestTransport.SearchAllAssignments") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None, + ): + uri = transcoded_request["uri"] + method = transcoded_request["method"] + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + return response + + def __call__( + self, + request: reservation.SearchAllAssignmentsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> reservation.SearchAllAssignmentsResponse: + r"""Call the search all assignments method over HTTP. + + Args: + request (~.reservation.SearchAllAssignmentsRequest): + The request object. The request for + [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. + Note: "bigquery.reservationAssignments.search" + permission is required on the related assignee. + 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, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.reservation.SearchAllAssignmentsResponse: + The response for + [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. + + """ + + http_options = ( + _BaseReservationServiceRestTransport._BaseSearchAllAssignments._get_http_options() + ) + + request, metadata = self._interceptor.pre_search_all_assignments( + request, metadata + ) + transcoded_request = _BaseReservationServiceRestTransport._BaseSearchAllAssignments._get_transcoded_request( + http_options, request + ) + + # Jsonify the query params + query_params = _BaseReservationServiceRestTransport._BaseSearchAllAssignments._get_query_params_json( + transcoded_request + ) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + request_url = "{host}{uri}".format( + host=self._host, uri=transcoded_request["uri"] + ) + method = transcoded_request["method"] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.SearchAllAssignments", + extra={ + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "SearchAllAssignments", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ( + ReservationServiceRestTransport._SearchAllAssignments._get_response( + self._host, + metadata, + query_params, + self._session, + timeout, + transcoded_request, + ) + ) + + # 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 = reservation.SearchAllAssignmentsResponse() + pb_resp = reservation.SearchAllAssignmentsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_search_all_assignments(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_search_all_assignments_with_metadata( + resp, response_metadata + ) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = reservation.SearchAllAssignmentsResponse.to_json( + response + ) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.search_all_assignments", + extra={ + "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", + "rpcName": "SearchAllAssignments", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _SearchAssignments( + _BaseReservationServiceRestTransport._BaseSearchAssignments, + ReservationServiceRestStub, + ): + def __hash__(self): + return hash("ReservationServiceRestTransport.SearchAssignments") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None, + ): + uri = transcoded_request["uri"] + method = transcoded_request["method"] + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + return response + + def __call__( + self, + request: reservation.SearchAssignmentsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> reservation.SearchAssignmentsResponse: + r"""Call the search assignments method over HTTP. - **Note**: "bigquery.reservationAssignments.create" and - "bigquery.reservationAssignments.delete" permission are - required on the related assignee. + Args: + request (~.reservation.SearchAssignmentsRequest): + The request object. The request for + [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. + Note: "bigquery.reservationAssignments.search" + permission is required on the related assignee. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -3452,28 +4922,25 @@ def __call__( be of type `bytes`. Returns: - ~.reservation.Assignment: - An assignment allows a project to - submit jobs of a certain type using - slots from the specified reservation. + ~.reservation.SearchAssignmentsResponse: + The response for + [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. """ http_options = ( - _BaseReservationServiceRestTransport._BaseMoveAssignment._get_http_options() + _BaseReservationServiceRestTransport._BaseSearchAssignments._get_http_options() ) - request, metadata = self._interceptor.pre_move_assignment(request, metadata) - transcoded_request = _BaseReservationServiceRestTransport._BaseMoveAssignment._get_transcoded_request( - http_options, request + request, metadata = self._interceptor.pre_search_assignments( + request, metadata ) - - body = _BaseReservationServiceRestTransport._BaseMoveAssignment._get_request_body_json( - transcoded_request + transcoded_request = _BaseReservationServiceRestTransport._BaseSearchAssignments._get_transcoded_request( + http_options, request ) # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseMoveAssignment._get_query_params_json( + query_params = _BaseReservationServiceRestTransport._BaseSearchAssignments._get_query_params_json( transcoded_request ) @@ -3495,24 +4962,23 @@ def __call__( "headers": dict(metadata), } _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.MoveAssignment", + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.SearchAssignments", extra={ "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "MoveAssignment", + "rpcName": "SearchAssignments", "httpRequest": http_request, "metadata": http_request["headers"], }, ) # Send the request - response = ReservationServiceRestTransport._MoveAssignment._get_response( + response = ReservationServiceRestTransport._SearchAssignments._get_response( self._host, metadata, query_params, self._session, timeout, transcoded_request, - body, ) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception @@ -3521,21 +4987,23 @@ def __call__( raise core_exceptions.from_http_response(response) # Return the response - resp = reservation.Assignment() - pb_resp = reservation.Assignment.pb(resp) + resp = reservation.SearchAssignmentsResponse() + pb_resp = reservation.SearchAssignmentsResponse.pb(resp) json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_move_assignment(resp) + resp = self._interceptor.post_search_assignments(resp) response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_move_assignment_with_metadata( + resp, _ = self._interceptor.post_search_assignments_with_metadata( resp, response_metadata ) if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( logging.DEBUG ): # pragma: NO COVER try: - response_payload = reservation.Assignment.to_json(response) + response_payload = reservation.SearchAssignmentsResponse.to_json( + response + ) except: response_payload = None http_response = { @@ -3544,22 +5012,22 @@ def __call__( "status": response.status_code, } _LOGGER.debug( - "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.move_assignment", + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.search_assignments", extra={ "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "MoveAssignment", + "rpcName": "SearchAssignments", "metadata": http_response["headers"], "httpResponse": http_response, }, ) return resp - class _SearchAllAssignments( - _BaseReservationServiceRestTransport._BaseSearchAllAssignments, + class _SetIamPolicy( + _BaseReservationServiceRestTransport._BaseSetIamPolicy, ReservationServiceRestStub, ): def __hash__(self): - return hash("ReservationServiceRestTransport.SearchAllAssignments") + return hash("ReservationServiceRestTransport.SetIamPolicy") @staticmethod def _get_response( @@ -3580,25 +5048,23 @@ def _get_response( timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, ) return response def __call__( self, - request: reservation.SearchAllAssignmentsRequest, + request: iam_policy_pb2.SetIamPolicyRequest, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> reservation.SearchAllAssignmentsResponse: - r"""Call the search all assignments method over HTTP. + ) -> policy_pb2.Policy: + r"""Call the set iam policy method over HTTP. Args: - request (~.reservation.SearchAllAssignmentsRequest): - The request object. The request for - [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. - Note: "bigquery.reservationAssignments.search" - permission is required on the related assignee. + request (~.iam_policy_pb2.SetIamPolicyRequest): + The request object. Request message for ``SetIamPolicy`` method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -3608,25 +5074,100 @@ def __call__( be of type `bytes`. Returns: - ~.reservation.SearchAllAssignmentsResponse: - The response for - [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. + ~.policy_pb2.Policy: + An Identity and Access Management (IAM) policy, which + specifies access controls for Google Cloud resources. + + A ``Policy`` is a collection of ``bindings``. A + ``binding`` binds one or more ``members``, or + principals, to a single ``role``. Principals can be user + accounts, service accounts, Google groups, and domains + (such as G Suite). A ``role`` is a named list of + permissions; each ``role`` can be an IAM predefined role + or a user-created custom role. + + For some types of Google Cloud resources, a ``binding`` + can also specify a ``condition``, which is a logical + expression that allows access to a resource only if the + expression evaluates to ``true``. A condition can add + constraints based on attributes of the request, the + resource, or both. To learn which resources support + conditions in their IAM policies, see the `IAM + documentation `__. + + **JSON example:** + + :: + + { + "bindings": [ + { + "role": "roles/resourcemanager.organizationAdmin", + "members": [ + "user:mike@example.com", + "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" + ] + }, + { + "role": "roles/resourcemanager.organizationViewer", + "members": [ + "user:eve@example.com" + ], + "condition": { + "title": "expirable access", + "description": "Does not grant access after Sep 2020", + "expression": "request.time < + timestamp('2020-10-01T00:00:00.000Z')", + } + } + ], + "etag": "BwWWja0YfJA=", + "version": 3 + } + + **YAML example:** + + :: + + bindings: + - members: + - user:mike@example.com + - group:admins@example.com + - domain:google.com + - serviceAccount:my-project-id@appspot.gserviceaccount.com + role: roles/resourcemanager.organizationAdmin + - members: + - user:eve@example.com + role: roles/resourcemanager.organizationViewer + condition: + title: expirable access + description: Does not grant access after Sep 2020 + expression: request.time < timestamp('2020-10-01T00:00:00.000Z') + etag: BwWWja0YfJA= + version: 3 + + For a description of IAM and its features, see the `IAM + documentation `__. """ http_options = ( - _BaseReservationServiceRestTransport._BaseSearchAllAssignments._get_http_options() + _BaseReservationServiceRestTransport._BaseSetIamPolicy._get_http_options() ) - request, metadata = self._interceptor.pre_search_all_assignments( - request, metadata - ) - transcoded_request = _BaseReservationServiceRestTransport._BaseSearchAllAssignments._get_transcoded_request( + request, metadata = self._interceptor.pre_set_iam_policy(request, metadata) + transcoded_request = _BaseReservationServiceRestTransport._BaseSetIamPolicy._get_transcoded_request( http_options, request ) + body = _BaseReservationServiceRestTransport._BaseSetIamPolicy._get_request_body_json( + transcoded_request + ) + # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseSearchAllAssignments._get_query_params_json( + query_params = _BaseReservationServiceRestTransport._BaseSetIamPolicy._get_query_params_json( transcoded_request ) @@ -3638,7 +5179,7 @@ def __call__( ) method = transcoded_request["method"] try: - request_payload = type(request).to_json(request) + request_payload = json_format.MessageToJson(request) except: request_payload = None http_request = { @@ -3648,25 +5189,24 @@ def __call__( "headers": dict(metadata), } _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.SearchAllAssignments", + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.SetIamPolicy", extra={ "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "SearchAllAssignments", + "rpcName": "SetIamPolicy", "httpRequest": http_request, "metadata": http_request["headers"], }, ) # Send the request - response = ( - ReservationServiceRestTransport._SearchAllAssignments._get_response( - self._host, - metadata, - query_params, - self._session, - timeout, - transcoded_request, - ) + response = ReservationServiceRestTransport._SetIamPolicy._get_response( + self._host, + metadata, + query_params, + self._session, + timeout, + transcoded_request, + body, ) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception @@ -3675,23 +5215,21 @@ def __call__( raise core_exceptions.from_http_response(response) # Return the response - resp = reservation.SearchAllAssignmentsResponse() - pb_resp = reservation.SearchAllAssignmentsResponse.pb(resp) + resp = policy_pb2.Policy() + pb_resp = resp json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_search_all_assignments(resp) + resp = self._interceptor.post_set_iam_policy(resp) response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_search_all_assignments_with_metadata( + resp, _ = self._interceptor.post_set_iam_policy_with_metadata( resp, response_metadata ) if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( logging.DEBUG ): # pragma: NO COVER try: - response_payload = reservation.SearchAllAssignmentsResponse.to_json( - response - ) + response_payload = json_format.MessageToJson(resp) except: response_payload = None http_response = { @@ -3700,22 +5238,22 @@ def __call__( "status": response.status_code, } _LOGGER.debug( - "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.search_all_assignments", + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.set_iam_policy", extra={ "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "SearchAllAssignments", + "rpcName": "SetIamPolicy", "metadata": http_response["headers"], "httpResponse": http_response, }, ) return resp - class _SearchAssignments( - _BaseReservationServiceRestTransport._BaseSearchAssignments, + class _SplitCapacityCommitment( + _BaseReservationServiceRestTransport._BaseSplitCapacityCommitment, ReservationServiceRestStub, ): def __hash__(self): - return hash("ReservationServiceRestTransport.SearchAssignments") + return hash("ReservationServiceRestTransport.SplitCapacityCommitment") @staticmethod def _get_response( @@ -3736,25 +5274,24 @@ def _get_response( timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, ) return response def __call__( self, - request: reservation.SearchAssignmentsRequest, + request: reservation.SplitCapacityCommitmentRequest, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> reservation.SearchAssignmentsResponse: - r"""Call the search assignments method over HTTP. + ) -> reservation.SplitCapacityCommitmentResponse: + r"""Call the split capacity commitment method over HTTP. Args: - request (~.reservation.SearchAssignmentsRequest): + request (~.reservation.SplitCapacityCommitmentRequest): The request object. The request for - [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. - Note: "bigquery.reservationAssignments.search" - permission is required on the related assignee. + [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment]. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -3764,25 +5301,29 @@ def __call__( be of type `bytes`. Returns: - ~.reservation.SearchAssignmentsResponse: + ~.reservation.SplitCapacityCommitmentResponse: The response for - [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. + [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment]. """ http_options = ( - _BaseReservationServiceRestTransport._BaseSearchAssignments._get_http_options() + _BaseReservationServiceRestTransport._BaseSplitCapacityCommitment._get_http_options() ) - request, metadata = self._interceptor.pre_search_assignments( + request, metadata = self._interceptor.pre_split_capacity_commitment( request, metadata ) - transcoded_request = _BaseReservationServiceRestTransport._BaseSearchAssignments._get_transcoded_request( + transcoded_request = _BaseReservationServiceRestTransport._BaseSplitCapacityCommitment._get_transcoded_request( http_options, request ) + body = _BaseReservationServiceRestTransport._BaseSplitCapacityCommitment._get_request_body_json( + transcoded_request + ) + # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseSearchAssignments._get_query_params_json( + query_params = _BaseReservationServiceRestTransport._BaseSplitCapacityCommitment._get_query_params_json( transcoded_request ) @@ -3804,23 +5345,26 @@ def __call__( "headers": dict(metadata), } _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.SearchAssignments", + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.SplitCapacityCommitment", extra={ "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "SearchAssignments", + "rpcName": "SplitCapacityCommitment", "httpRequest": http_request, "metadata": http_request["headers"], }, ) # Send the request - response = ReservationServiceRestTransport._SearchAssignments._get_response( - self._host, - metadata, - query_params, - self._session, - timeout, - transcoded_request, + response = ( + ReservationServiceRestTransport._SplitCapacityCommitment._get_response( + self._host, + metadata, + query_params, + self._session, + timeout, + transcoded_request, + body, + ) ) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception @@ -3829,22 +5373,22 @@ def __call__( raise core_exceptions.from_http_response(response) # Return the response - resp = reservation.SearchAssignmentsResponse() - pb_resp = reservation.SearchAssignmentsResponse.pb(resp) + resp = reservation.SplitCapacityCommitmentResponse() + pb_resp = reservation.SplitCapacityCommitmentResponse.pb(resp) json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_search_assignments(resp) + resp = self._interceptor.post_split_capacity_commitment(resp) response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_search_assignments_with_metadata( + resp, _ = self._interceptor.post_split_capacity_commitment_with_metadata( resp, response_metadata ) if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( logging.DEBUG ): # pragma: NO COVER try: - response_payload = reservation.SearchAssignmentsResponse.to_json( - response + response_payload = ( + reservation.SplitCapacityCommitmentResponse.to_json(response) ) except: response_payload = None @@ -3854,22 +5398,22 @@ def __call__( "status": response.status_code, } _LOGGER.debug( - "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.search_assignments", + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.split_capacity_commitment", extra={ "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "SearchAssignments", + "rpcName": "SplitCapacityCommitment", "metadata": http_response["headers"], "httpResponse": http_response, }, ) return resp - class _SplitCapacityCommitment( - _BaseReservationServiceRestTransport._BaseSplitCapacityCommitment, + class _TestIamPermissions( + _BaseReservationServiceRestTransport._BaseTestIamPermissions, ReservationServiceRestStub, ): def __hash__(self): - return hash("ReservationServiceRestTransport.SplitCapacityCommitment") + return hash("ReservationServiceRestTransport.TestIamPermissions") @staticmethod def _get_response( @@ -3896,18 +5440,17 @@ def _get_response( def __call__( self, - request: reservation.SplitCapacityCommitmentRequest, + request: iam_policy_pb2.TestIamPermissionsRequest, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> reservation.SplitCapacityCommitmentResponse: - r"""Call the split capacity commitment method over HTTP. + ) -> iam_policy_pb2.TestIamPermissionsResponse: + r"""Call the test iam permissions method over HTTP. Args: - request (~.reservation.SplitCapacityCommitmentRequest): - The request object. The request for - [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment]. + request (~.iam_policy_pb2.TestIamPermissionsRequest): + The request object. Request message for ``TestIamPermissions`` method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -3917,29 +5460,27 @@ def __call__( be of type `bytes`. Returns: - ~.reservation.SplitCapacityCommitmentResponse: - The response for - [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment]. - + ~.iam_policy_pb2.TestIamPermissionsResponse: + Response message for ``TestIamPermissions`` method. """ http_options = ( - _BaseReservationServiceRestTransport._BaseSplitCapacityCommitment._get_http_options() + _BaseReservationServiceRestTransport._BaseTestIamPermissions._get_http_options() ) - request, metadata = self._interceptor.pre_split_capacity_commitment( + request, metadata = self._interceptor.pre_test_iam_permissions( request, metadata ) - transcoded_request = _BaseReservationServiceRestTransport._BaseSplitCapacityCommitment._get_transcoded_request( + transcoded_request = _BaseReservationServiceRestTransport._BaseTestIamPermissions._get_transcoded_request( http_options, request ) - body = _BaseReservationServiceRestTransport._BaseSplitCapacityCommitment._get_request_body_json( + body = _BaseReservationServiceRestTransport._BaseTestIamPermissions._get_request_body_json( transcoded_request ) # Jsonify the query params - query_params = _BaseReservationServiceRestTransport._BaseSplitCapacityCommitment._get_query_params_json( + query_params = _BaseReservationServiceRestTransport._BaseTestIamPermissions._get_query_params_json( transcoded_request ) @@ -3951,7 +5492,7 @@ def __call__( ) method = transcoded_request["method"] try: - request_payload = type(request).to_json(request) + request_payload = json_format.MessageToJson(request) except: request_payload = None http_request = { @@ -3961,10 +5502,10 @@ def __call__( "headers": dict(metadata), } _LOGGER.debug( - f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.SplitCapacityCommitment", + f"Sending request for google.cloud.bigquery.reservation_v1.ReservationServiceClient.TestIamPermissions", extra={ "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "SplitCapacityCommitment", + "rpcName": "TestIamPermissions", "httpRequest": http_request, "metadata": http_request["headers"], }, @@ -3972,7 +5513,7 @@ def __call__( # Send the request response = ( - ReservationServiceRestTransport._SplitCapacityCommitment._get_response( + ReservationServiceRestTransport._TestIamPermissions._get_response( self._host, metadata, query_params, @@ -3989,23 +5530,21 @@ def __call__( raise core_exceptions.from_http_response(response) # Return the response - resp = reservation.SplitCapacityCommitmentResponse() - pb_resp = reservation.SplitCapacityCommitmentResponse.pb(resp) + resp = iam_policy_pb2.TestIamPermissionsResponse() + pb_resp = resp json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_split_capacity_commitment(resp) + resp = self._interceptor.post_test_iam_permissions(resp) response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_split_capacity_commitment_with_metadata( + resp, _ = self._interceptor.post_test_iam_permissions_with_metadata( resp, response_metadata ) if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( logging.DEBUG ): # pragma: NO COVER try: - response_payload = ( - reservation.SplitCapacityCommitmentResponse.to_json(response) - ) + response_payload = json_format.MessageToJson(resp) except: response_payload = None http_response = { @@ -4014,10 +5553,10 @@ def __call__( "status": response.status_code, } _LOGGER.debug( - "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.split_capacity_commitment", + "Received response for google.cloud.bigquery.reservation_v1.ReservationServiceClient.test_iam_permissions", extra={ "serviceName": "google.cloud.bigquery.reservation.v1.ReservationService", - "rpcName": "SplitCapacityCommitment", + "rpcName": "TestIamPermissions", "metadata": http_response["headers"], "httpResponse": http_response, }, @@ -4691,6 +6230,16 @@ def create_reservation( # In C++ this would require a dynamic_cast return self._CreateReservation(self._session, self._host, self._interceptor) # type: ignore + @property + def create_reservation_group( + self, + ) -> Callable[ + [reservation.CreateReservationGroupRequest], reservation.ReservationGroup + ]: + # 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._CreateReservationGroup(self._session, self._host, self._interceptor) # type: ignore + @property def delete_assignment( self, @@ -4715,6 +6264,14 @@ def delete_reservation( # In C++ this would require a dynamic_cast return self._DeleteReservation(self._session, self._host, self._interceptor) # type: ignore + @property + def delete_reservation_group( + self, + ) -> Callable[[reservation.DeleteReservationGroupRequest], empty_pb2.Empty]: + # 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._DeleteReservationGroup(self._session, self._host, self._interceptor) # type: ignore + @property def failover_reservation( self, @@ -4741,6 +6298,14 @@ def get_capacity_commitment( # In C++ this would require a dynamic_cast return self._GetCapacityCommitment(self._session, self._host, self._interceptor) # type: ignore + @property + def get_iam_policy( + self, + ) -> Callable[[iam_policy_pb2.GetIamPolicyRequest], policy_pb2.Policy]: + # 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._GetIamPolicy(self._session, self._host, self._interceptor) # type: ignore + @property def get_reservation( self, @@ -4749,6 +6314,16 @@ def get_reservation( # In C++ this would require a dynamic_cast return self._GetReservation(self._session, self._host, self._interceptor) # type: ignore + @property + def get_reservation_group( + self, + ) -> Callable[ + [reservation.GetReservationGroupRequest], reservation.ReservationGroup + ]: + # 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._GetReservationGroup(self._session, self._host, self._interceptor) # type: ignore + @property def list_assignments( self, @@ -4770,6 +6345,17 @@ def list_capacity_commitments( # In C++ this would require a dynamic_cast return self._ListCapacityCommitments(self._session, self._host, self._interceptor) # type: ignore + @property + def list_reservation_groups( + self, + ) -> Callable[ + [reservation.ListReservationGroupsRequest], + reservation.ListReservationGroupsResponse, + ]: + # 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._ListReservationGroups(self._session, self._host, self._interceptor) # type: ignore + @property def list_reservations( self, @@ -4819,6 +6405,14 @@ def search_assignments( # In C++ this would require a dynamic_cast return self._SearchAssignments(self._session, self._host, self._interceptor) # type: ignore + @property + def set_iam_policy( + self, + ) -> Callable[[iam_policy_pb2.SetIamPolicyRequest], policy_pb2.Policy]: + # 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._SetIamPolicy(self._session, self._host, self._interceptor) # type: ignore + @property def split_capacity_commitment( self, @@ -4830,6 +6424,17 @@ def split_capacity_commitment( # In C++ this would require a dynamic_cast return self._SplitCapacityCommitment(self._session, self._host, self._interceptor) # type: ignore + @property + def test_iam_permissions( + self, + ) -> Callable[ + [iam_policy_pb2.TestIamPermissionsRequest], + iam_policy_pb2.TestIamPermissionsResponse, + ]: + # 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._TestIamPermissions(self._session, self._host, self._interceptor) # type: ignore + @property def update_assignment( self, diff --git a/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/rest_base.py b/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/rest_base.py index 2975a9f9f769..05dc1f45f992 100644 --- a/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/rest_base.py +++ b/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/services/reservation_service/transports/rest_base.py @@ -18,6 +18,8 @@ from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union from google.api_core import gapic_v1, path_template +from google.iam.v1 import iam_policy_pb2 # type: ignore +from google.iam.v1 import policy_pb2 # type: ignore from google.protobuf import empty_pb2 # type: ignore from google.protobuf import json_format @@ -260,6 +262,65 @@ def _get_query_params_json(transcoded_request): query_params["$alt"] = "json;enum-encoding=int" return query_params + class _BaseCreateReservationGroup: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "reservationGroupId": "", + } + + @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 + } + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1/{parent=projects/*/locations/*}/reservationGroups", + "body": "reservation_group", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = reservation.CreateReservationGroupRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_request_body_json(transcoded_request): + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], use_integers_for_enums=True + ) + return body + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + use_integers_for_enums=True, + ) + ) + query_params.update( + _BaseReservationServiceRestTransport._BaseCreateReservationGroup._get_unset_required_fields( + query_params + ) + ) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + class _BaseDeleteAssignment: def __hash__(self): # pragma: NO COVER return NotImplementedError("__hash__ must be implemented.") @@ -401,6 +462,53 @@ def _get_query_params_json(transcoded_request): query_params["$alt"] = "json;enum-encoding=int" return query_params + class _BaseDeleteReservationGroup: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __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 + } + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [ + { + "method": "delete", + "uri": "/v1/{name=projects/*/locations/*/reservationGroups/*}", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = reservation.DeleteReservationGroupRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + use_integers_for_enums=True, + ) + ) + query_params.update( + _BaseReservationServiceRestTransport._BaseDeleteReservationGroup._get_unset_required_fields( + query_params + ) + ) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + class _BaseFailoverReservation: def __hash__(self): # pragma: NO COVER return NotImplementedError("__hash__ must be implemented.") @@ -552,6 +660,57 @@ def _get_query_params_json(transcoded_request): query_params["$alt"] = "json;enum-encoding=int" return query_params + class _BaseGetIamPolicy: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __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 + } + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1/{resource=projects/*/locations/*/reservations/*}:getIamPolicy", + }, + { + "method": "get", + "uri": "/v1/{resource=projects/*/locations/*/reservations/*/assignments/*}:getIamPolicy", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = request + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + use_integers_for_enums=True, + ) + ) + query_params.update( + _BaseReservationServiceRestTransport._BaseGetIamPolicy._get_unset_required_fields( + query_params + ) + ) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + class _BaseGetReservation: def __hash__(self): # pragma: NO COVER return NotImplementedError("__hash__ must be implemented.") @@ -599,6 +758,53 @@ def _get_query_params_json(transcoded_request): query_params["$alt"] = "json;enum-encoding=int" return query_params + class _BaseGetReservationGroup: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __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 + } + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1/{name=projects/*/locations/*/reservationGroups/*}", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = reservation.GetReservationGroupRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + use_integers_for_enums=True, + ) + ) + query_params.update( + _BaseReservationServiceRestTransport._BaseGetReservationGroup._get_unset_required_fields( + query_params + ) + ) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + class _BaseListAssignments: def __hash__(self): # pragma: NO COVER return NotImplementedError("__hash__ must be implemented.") @@ -693,6 +899,53 @@ def _get_query_params_json(transcoded_request): query_params["$alt"] = "json;enum-encoding=int" return query_params + class _BaseListReservationGroups: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __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 + } + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1/{parent=projects/*/locations/*}/reservationGroups", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = reservation.ListReservationGroupsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + use_integers_for_enums=True, + ) + ) + query_params.update( + _BaseReservationServiceRestTransport._BaseListReservationGroups._get_unset_required_fields( + query_params + ) + ) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + class _BaseListReservations: def __hash__(self): # pragma: NO COVER return NotImplementedError("__hash__ must be implemented.") @@ -933,6 +1186,68 @@ def _get_query_params_json(transcoded_request): query_params["$alt"] = "json;enum-encoding=int" return query_params + class _BaseSetIamPolicy: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __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 + } + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1/{resource=projects/*/locations/*/reservations/*}:setIamPolicy", + "body": "*", + }, + { + "method": "post", + "uri": "/v1/{resource=projects/*/locations/*/reservations/*/assignments/*}:setIamPolicy", + "body": "*", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = request + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_request_body_json(transcoded_request): + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], use_integers_for_enums=True + ) + return body + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + use_integers_for_enums=True, + ) + ) + query_params.update( + _BaseReservationServiceRestTransport._BaseSetIamPolicy._get_unset_required_fields( + query_params + ) + ) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + class _BaseSplitCapacityCommitment: def __hash__(self): # pragma: NO COVER return NotImplementedError("__hash__ must be implemented.") @@ -990,6 +1305,68 @@ def _get_query_params_json(transcoded_request): query_params["$alt"] = "json;enum-encoding=int" return query_params + class _BaseTestIamPermissions: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __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 + } + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1/{resource=projects/*/locations/*/reservations/*}:testIamPermissions", + "body": "*", + }, + { + "method": "post", + "uri": "/v1/{resource=projects/*/locations/*/reservations/*/assignments/*}:testIamPermissions", + "body": "*", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = request + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_request_body_json(transcoded_request): + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], use_integers_for_enums=True + ) + return body + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + use_integers_for_enums=True, + ) + ) + query_params.update( + _BaseReservationServiceRestTransport._BaseTestIamPermissions._get_unset_required_fields( + query_params + ) + ) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + class _BaseUpdateAssignment: def __hash__(self): # pragma: NO COVER return NotImplementedError("__hash__ must be implemented.") diff --git a/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/types/__init__.py b/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/types/__init__.py index 74bde8d86142..5b351a4b3896 100644 --- a/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/types/__init__.py +++ b/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/types/__init__.py @@ -19,25 +19,32 @@ CapacityCommitment, CreateAssignmentRequest, CreateCapacityCommitmentRequest, + CreateReservationGroupRequest, CreateReservationRequest, DeleteAssignmentRequest, DeleteCapacityCommitmentRequest, + DeleteReservationGroupRequest, DeleteReservationRequest, Edition, FailoverMode, FailoverReservationRequest, GetBiReservationRequest, GetCapacityCommitmentRequest, + GetReservationGroupRequest, GetReservationRequest, ListAssignmentsRequest, ListAssignmentsResponse, ListCapacityCommitmentsRequest, ListCapacityCommitmentsResponse, + ListReservationGroupsRequest, + ListReservationGroupsResponse, ListReservationsRequest, ListReservationsResponse, MergeCapacityCommitmentsRequest, MoveAssignmentRequest, Reservation, + ReservationGroup, + SchedulingPolicy, SearchAllAssignmentsRequest, SearchAllAssignmentsResponse, SearchAssignmentsRequest, @@ -57,23 +64,30 @@ "CapacityCommitment", "CreateAssignmentRequest", "CreateCapacityCommitmentRequest", + "CreateReservationGroupRequest", "CreateReservationRequest", "DeleteAssignmentRequest", "DeleteCapacityCommitmentRequest", + "DeleteReservationGroupRequest", "DeleteReservationRequest", "FailoverReservationRequest", "GetBiReservationRequest", "GetCapacityCommitmentRequest", + "GetReservationGroupRequest", "GetReservationRequest", "ListAssignmentsRequest", "ListAssignmentsResponse", "ListCapacityCommitmentsRequest", "ListCapacityCommitmentsResponse", + "ListReservationGroupsRequest", + "ListReservationGroupsResponse", "ListReservationsRequest", "ListReservationsResponse", "MergeCapacityCommitmentsRequest", "MoveAssignmentRequest", "Reservation", + "ReservationGroup", + "SchedulingPolicy", "SearchAllAssignmentsRequest", "SearchAllAssignmentsResponse", "SearchAssignmentsRequest", diff --git a/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/types/reservation.py b/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/types/reservation.py index ffe1ad24e092..96d5cd21d988 100644 --- a/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/types/reservation.py +++ b/packages/google-cloud-bigquery-reservation/google/cloud/bigquery_reservation_v1/types/reservation.py @@ -28,6 +28,8 @@ "Edition", "FailoverMode", "Reservation", + "SchedulingPolicy", + "ReservationGroup", "CapacityCommitment", "CreateReservationRequest", "ListReservationsRequest", @@ -36,6 +38,11 @@ "DeleteReservationRequest", "UpdateReservationRequest", "FailoverReservationRequest", + "CreateReservationGroupRequest", + "GetReservationGroupRequest", + "ListReservationGroupsRequest", + "ListReservationGroupsResponse", + "DeleteReservationGroupRequest", "CreateCapacityCommitmentRequest", "ListCapacityCommitmentsRequest", "ListCapacityCommitmentsResponse", @@ -89,7 +96,7 @@ class Edition(proto.Enum): class FailoverMode(proto.Enum): r"""The failover mode when a user initiates a failover on a - reservation determines how writes that arepending replication + reservation determines how writes that are pending replication are handled after the failover is initiated. Values: @@ -121,15 +128,15 @@ class Reservation(proto.Message): Attributes: name (str): - The resource name of the reservation, e.g., + Identifier. The resource name of the reservation, e.g., ``projects/*/locations/*/reservations/team1-prod``. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters. slot_capacity (int): - Baseline slots available to this reservation. A slot is a - unit of computational power in BigQuery, and serves as the - unit of parallelism. + Optional. Baseline slots available to this reservation. A + slot is a unit of computational power in BigQuery, and + serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false, or autoscaling @@ -145,26 +152,25 @@ class Reservation(proto.Message): baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes. ignore_idle_slots (bool): - If false, any query or pipeline job using this reservation - will use idle slots from other reservations within the same - admin project. If true, a query or pipeline job using this - reservation will execute with the slot capacity specified in - the slot_capacity field at most. + Optional. If false, any query or pipeline job using this + reservation will use idle slots from other reservations + within the same admin project. If true, a query or pipeline + job using this reservation will execute with the slot + capacity specified in the slot_capacity field at most. autoscale (google.cloud.bigquery_reservation_v1.types.Reservation.Autoscale): - The configuration parameters for the auto - scaling feature. + Optional. The configuration parameters for + the auto scaling feature. concurrency (int): - Job concurrency target which sets a soft - upper bound on the number of jobs that can run - concurrently in this reservation. This is a soft - target due to asynchronous nature of the system - and various optimizations for small queries. - Default value is 0 which means that concurrency - target will be automatically computed by the - system. - NOTE: this field is exposed as target job - concurrency in the Information Schema, DDL and - BigQuery CLI. + Optional. Job concurrency target which sets a + soft upper bound on the number of jobs that can + run concurrently in this reservation. This is a + soft target due to asynchronous nature of the + system and various optimizations for small + queries. Default value is 0 which means that + concurrency target will be automatically + computed by the system. NOTE: this field is + exposed as target job concurrency in the + Information Schema, DDL and BigQuery CLI. creation_time (google.protobuf.timestamp_pb2.Timestamp): Output only. Creation time of the reservation. @@ -185,7 +191,7 @@ class Reservation(proto.Message): NOTE: this is a preview feature. Project must be allow-listed in order to set this field. edition (google.cloud.bigquery_reservation_v1.types.Edition): - Edition of the reservation. + Optional. Edition of the reservation. primary_location (str): Output only. The current location of the reservation's primary replica. This field is @@ -219,16 +225,19 @@ class Reservation(proto.Message): - baseline. This field must be set together with the scaling_mode enum - value. + value, otherwise the request will be rejected with error + code ``google.rpc.Code.INVALID_ARGUMENT``. If the max_slots and scaling_mode are set, the autoscale or - autoscale.max_slots field must be unset. However, the - autoscale field may still be in the output. The - autopscale.max_slots will always show as 0 and the - autoscaler.current_slots will represent the current slots - from autoscaler excluding idle slots. For example, if the - max_slots is 1000 and scaling_mode is AUTOSCALE_ONLY, then - in the output, the autoscaler.max_slots will be 0 and the + autoscale.max_slots field must be unset. Otherwise the + request will be rejected with error code + ``google.rpc.Code.INVALID_ARGUMENT``. However, the autoscale + field may still be in the output. The autopscale.max_slots + will always show as 0 and the autoscaler.current_slots will + represent the current slots from autoscaler excluding idle + slots. For example, if the max_slots is 1000 and + scaling_mode is AUTOSCALE_ONLY, then in the output, the + autoscaler.max_slots will be 0 and the autoscaler.current_slots may be any value between 0 and 1000. @@ -243,13 +252,15 @@ class Reservation(proto.Message): If the max_slots and scaling_mode are set, then the ignore_idle_slots field must be aligned with the scaling_mode enum value.(See details in ScalingMode - comments). + comments). Otherwise the request will be rejected with error + code ``google.rpc.Code.INVALID_ARGUMENT``. Please note, the max_slots is for user to manage the part of slots greater than the baseline. Therefore, we don't allow users to set max_slots smaller or equal to the baseline as it will not be meaningful. If the field is present and - slot_capacity>=max_slots. + slot_capacity>=max_slots, requests will be rejected with + error code ``google.rpc.Code.INVALID_ARGUMENT``. Please note that if max_slots is set to 0, we will treat it as unset. Customers can set max_slots to 0 and set @@ -259,7 +270,22 @@ class Reservation(proto.Message): This field is a member of `oneof`_ ``_max_slots``. scaling_mode (google.cloud.bigquery_reservation_v1.types.Reservation.ScalingMode): Optional. The scaling mode for the reservation. If the field - is present but max_slots is not present. + is present but max_slots is not present, requests will be + rejected with error code + ``google.rpc.Code.INVALID_ARGUMENT``. + labels (MutableMapping[str, str]): + Optional. The labels associated with this + reservation. You can use these to organize and + group your reservations. You can set this + property when you create or update a + reservation. + reservation_group (str): + Optional. The reservation group that this reservation + belongs to. You can set this property when you create or + update a reservation. Reservations do not need to belong to + a reservation group. Format: + projects/{project}/locations/{location}/reservationGroups/{reservation_group} + or just {reservation_group} replication_status (google.cloud.bigquery_reservation_v1.types.Reservation.ReplicationStatus): Output only. The Disaster Recovery(DR) replication status of the reservation. This is @@ -273,6 +299,13 @@ class Reservation(proto.Message): reservation or the reservation is a DR secondary or that any replication operations on the reservation have succeeded. + scheduling_policy (google.cloud.bigquery_reservation_v1.types.SchedulingPolicy): + Optional. The scheduling policy to use for + jobs and queries running under this reservation. + The scheduling policy controls how the + reservation's resources are distributed. + + This feature is not yet generally available. """ class ScalingMode(proto.Enum): @@ -292,7 +325,8 @@ class ScalingMode(proto.Enum): up to 800 slots and no idle slots will be used. Please note, in this mode, the ignore_idle_slots field must - be set to true. + be set to true. Otherwise the request will be rejected with + error code ``google.rpc.Code.INVALID_ARGUMENT``. IDLE_SLOTS_ONLY (2): The reservation will scale up using only idle slots contributed by other reservations or from unassigned @@ -314,7 +348,8 @@ class ScalingMode(proto.Enum): to max_slots. Please note, in this mode, the ignore_idle_slots field must - be set to false. + be set to false. Otherwise the request will be rejected with + error code ``google.rpc.Code.INVALID_ARGUMENT``. ALL_SLOTS (3): The reservation will scale up using all slots available to it. It will use idle slots contributed by other reservations @@ -335,7 +370,8 @@ class ScalingMode(proto.Enum): baseline and 800 autoscaling slots. Please note, in this mode, the ignore_idle_slots field must - be set to false. + be set to false. Otherwise the request will be rejected with + error code ``google.rpc.Code.INVALID_ARGUMENT``. """ SCALING_MODE_UNSPECIFIED = 0 AUTOSCALE_ONLY = 1 @@ -354,7 +390,8 @@ class Autoscale(proto.Message): the original value and could be larger than max_slots for that brief period (less than one minute) max_slots (int): - Number of slots to be scaled when needed. + Optional. Number of slots to be scaled when + needed. """ current_slots: int = proto.Field( @@ -478,11 +515,85 @@ class ReplicationStatus(proto.Message): number=22, enum=ScalingMode, ) + labels: MutableMapping[str, str] = proto.MapField( + proto.STRING, + proto.STRING, + number=23, + ) + reservation_group: str = proto.Field( + proto.STRING, + number=25, + ) replication_status: ReplicationStatus = proto.Field( proto.MESSAGE, number=24, message=ReplicationStatus, ) + scheduling_policy: "SchedulingPolicy" = proto.Field( + proto.MESSAGE, + number=27, + message="SchedulingPolicy", + ) + + +class SchedulingPolicy(proto.Message): + r"""The scheduling policy controls how a reservation's resources + are distributed. + + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + concurrency (int): + Optional. If present and > 0, the reservation + will attempt to limit the concurrency of jobs + running for any particular project within it to + the given value. + + This feature is not yet generally available. + + This field is a member of `oneof`_ ``_concurrency``. + max_slots (int): + Optional. If present and > 0, the reservation + will attempt to limit the slot consumption of + queries running for any particular project + within it to the given value. + + This feature is not yet generally available. + + This field is a member of `oneof`_ ``_max_slots``. + """ + + concurrency: int = proto.Field( + proto.INT64, + number=1, + optional=True, + ) + max_slots: int = proto.Field( + proto.INT64, + number=2, + optional=True, + ) + + +class ReservationGroup(proto.Message): + r"""A reservation group is a container for reservations. + + Attributes: + name (str): + Identifier. The resource name of the reservation group, + e.g., + ``projects/*/locations/*/reservationGroups/team1-prod``. The + reservation_group_id must only contain lower case + alphanumeric characters or dashes. It must start with a + letter and must not end with a dash. Its maximum length is + 64 characters. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) class CapacityCommitment(proto.Message): @@ -506,9 +617,10 @@ class CapacityCommitment(proto.Message): characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters. slot_count (int): - Number of slots in this commitment. + Optional. Number of slots in this commitment. plan (google.cloud.bigquery_reservation_v1.types.CapacityCommitment.CommitmentPlan): - Capacity commitment commitment plan. + Optional. Capacity commitment commitment + plan. state (google.cloud.bigquery_reservation_v1.types.CapacityCommitment.State): Output only. State of the commitment. commitment_start_time (google.protobuf.timestamp_pb2.Timestamp): @@ -521,15 +633,15 @@ class CapacityCommitment(proto.Message): Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments. Note after renewal, commitment_end_time is the time the renewed - commitment expires. So it would be at a time after + commitment expires. So itwould be at a time after commitment_start_time + committed period, because we don't change commitment_start_time , failure_status (google.rpc.status_pb2.Status): Output only. For FAILED commitment plan, provides the reason of failure. renewal_plan (google.cloud.bigquery_reservation_v1.types.CapacityCommitment.CommitmentPlan): - The plan this capacity commitment is converted to after - commitment_end_time passes. Once the plan is changed, + Optional. The plan this capacity commitment is converted to + after commitment_end_time passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for ANNUAL and TRIAL commitments. multi_region_auxiliary (bool): @@ -546,7 +658,7 @@ class CapacityCommitment(proto.Message): NOTE: this is a preview feature. Project must be allow-listed in order to set this field. edition (google.cloud.bigquery_reservation_v1.types.Edition): - Edition of the capacity commitment. + Optional. Edition of the capacity commitment. is_flat_rate (bool): Output only. If true, the commitment is a flat-rate commitment, otherwise, it's an edition @@ -867,6 +979,131 @@ class FailoverReservationRequest(proto.Message): ) +class CreateReservationGroupRequest(proto.Message): + r"""The request for + [ReservationService.CreateReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.CreateReservationGroup]. + + Attributes: + parent (str): + Required. Project, location. E.g., + ``projects/myproject/locations/US`` + reservation_group_id (str): + Required. The reservation group ID. It must + only contain lower case alphanumeric characters + or dashes. It must start with a letter and must + not end with a dash. Its maximum length is 64 + characters. + reservation_group (google.cloud.bigquery_reservation_v1.types.ReservationGroup): + Required. New Reservation Group to create. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + reservation_group_id: str = proto.Field( + proto.STRING, + number=2, + ) + reservation_group: "ReservationGroup" = proto.Field( + proto.MESSAGE, + number=3, + message="ReservationGroup", + ) + + +class GetReservationGroupRequest(proto.Message): + r"""The request for + [ReservationService.GetReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.GetReservationGroup]. + + Attributes: + name (str): + Required. Resource name of the reservation group to + retrieve. E.g., + ``projects/myproject/locations/US/reservationGroups/team1-prod`` + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class ListReservationGroupsRequest(proto.Message): + r"""The request for + [ReservationService.ListReservationGroups][google.cloud.bigquery.reservation.v1.ReservationService.ListReservationGroups]. + + Attributes: + parent (str): + Required. The parent resource name containing project and + location, e.g.: ``projects/myproject/locations/US`` + page_size (int): + The maximum number of items to return per + page. + 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 ListReservationGroupsResponse(proto.Message): + r"""The response for + [ReservationService.ListReservationGroups][google.cloud.bigquery.reservation.v1.ReservationService.ListReservationGroups]. + + Attributes: + reservation_groups (MutableSequence[google.cloud.bigquery_reservation_v1.types.ReservationGroup]): + List of reservations visible to the user. + next_page_token (str): + Token to retrieve the next page of results, + or empty if there are no more results in the + list. + """ + + @property + def raw_page(self): + return self + + reservation_groups: MutableSequence["ReservationGroup"] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message="ReservationGroup", + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class DeleteReservationGroupRequest(proto.Message): + r"""The request for + [ReservationService.DeleteReservationGroup][google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservationGroup]. + + Attributes: + name (str): + Required. Resource name of the reservation group to + retrieve. E.g., + ``projects/myproject/locations/US/reservationGroups/team1-prod`` + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + class CreateCapacityCommitmentRequest(proto.Message): r"""The request for [ReservationService.CreateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.CreateCapacityCommitment]. @@ -1098,6 +1335,14 @@ class MergeCapacityCommitmentsRequest(proto.Message): ID is the last portion of capacity commitment name e.g., 'abc' for projects/myproject/locations/US/capacityCommitments/abc + capacity_commitment_id (str): + Optional. The optional resulting capacity + commitment ID. Capacity commitment name will be + generated automatically if this field is empty. + This field must only contain lower case + alphanumeric characters or dashes. The first and + last character cannot be a dash. Max length is + 64 characters. """ parent: str = proto.Field( @@ -1108,6 +1353,10 @@ class MergeCapacityCommitmentsRequest(proto.Message): proto.STRING, number=2, ) + capacity_commitment_id: str = proto.Field( + proto.STRING, + number=3, + ) class Assignment(proto.Message): @@ -1121,11 +1370,12 @@ class Assignment(proto.Message): The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. assignee (str): - The resource which will use the reservation. E.g. + Optional. The resource which will use the reservation. E.g. ``projects/myproject``, ``folders/123``, or ``organizations/456``. job_type (google.cloud.bigquery_reservation_v1.types.Assignment.JobType): - Which type of jobs will use the reservation. + Optional. Which type of jobs will use the + reservation. state (google.cloud.bigquery_reservation_v1.types.Assignment.State): Output only. State of the assignment. enable_gemini_in_bigquery (bool): @@ -1138,6 +1388,15 @@ class Assignment(proto.Message): parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to "Gemini in BigQuery" features. + scheduling_policy (google.cloud.bigquery_reservation_v1.types.SchedulingPolicy): + Optional. The scheduling policy to use for + jobs and queries of this assignee when running + under the associated reservation. The scheduling + policy controls how the reservation's resources + are distributed. This overrides the default + scheduling policy specified on the reservation. + + This feature is not yet generally available. """ class JobType(proto.Enum): @@ -1166,6 +1425,25 @@ class JobType(proto.Enum): reservation. Reservations with continuous assignments cannot be mixed with non-continuous assignments. + BACKGROUND_CHANGE_DATA_CAPTURE (7): + Finer granularity background jobs for + capturing changes in a source database and + streaming them into BigQuery. Reservations with + this job type take priority over a default + BACKGROUND reservation assignment (if it + exists). + BACKGROUND_COLUMN_METADATA_INDEX (8): + Finer granularity background jobs for + refreshing cached metadata for BigQuery tables. + Reservations with this job type take priority + over a default BACKGROUND reservation assignment + (if it exists). + BACKGROUND_SEARCH_INDEX_REFRESH (9): + Finer granularity background jobs for + refreshing search indexes upon BigQuery table + columns. Reservations with this job type take + priority over a default BACKGROUND reservation + assignment (if it exists). """ JOB_TYPE_UNSPECIFIED = 0 PIPELINE = 1 @@ -1173,6 +1451,9 @@ class JobType(proto.Enum): ML_EXTERNAL = 3 BACKGROUND = 4 CONTINUOUS = 6 + BACKGROUND_CHANGE_DATA_CAPTURE = 7 + BACKGROUND_COLUMN_METADATA_INDEX = 8 + BACKGROUND_SEARCH_INDEX_REFRESH = 9 class State(proto.Enum): r"""Assignment will remain in PENDING state if no active capacity @@ -1214,6 +1495,11 @@ class State(proto.Enum): proto.BOOL, number=10, ) + scheduling_policy: "SchedulingPolicy" = proto.Field( + proto.MESSAGE, + number=11, + message="SchedulingPolicy", + ) class CreateAssignmentRequest(proto.Message): @@ -1549,11 +1835,14 @@ class TableReference(proto.Message): Attributes: project_id (str): - The assigned project ID of the project. + Optional. The assigned project ID of the + project. dataset_id (str): - The ID of the dataset in the above project. + Optional. The ID of the dataset in the above + project. table_id (str): - The ID of the table in the above dataset. + Optional. The ID of the table in the above + dataset. """ project_id: str = proto.Field( @@ -1575,16 +1864,17 @@ class BiReservation(proto.Message): Attributes: name (str): - The resource name of the singleton BI reservation. - Reservation names have the form + Identifier. The resource name of the singleton BI + reservation. Reservation names have the form ``projects/{project_id}/locations/{location_id}/biReservation``. update_time (google.protobuf.timestamp_pb2.Timestamp): Output only. The last update timestamp of a reservation. size (int): - Size of a reservation, in bytes. + Optional. Size of a reservation, in bytes. preferred_tables (MutableSequence[google.cloud.bigquery_reservation_v1.types.TableReference]): - Preferred tables to use BI capacity for. + Optional. Preferred tables to use BI capacity + for. """ name: str = proto.Field( diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_reservation_group_async.py b/packages/google-cloud-bigquery-reservation/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_reservation_group_async.py similarity index 100% rename from owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_reservation_group_async.py rename to packages/google-cloud-bigquery-reservation/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_reservation_group_async.py diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_reservation_group_sync.py b/packages/google-cloud-bigquery-reservation/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_reservation_group_sync.py similarity index 100% rename from owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_reservation_group_sync.py rename to packages/google-cloud-bigquery-reservation/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_create_reservation_group_sync.py diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_reservation_group_async.py b/packages/google-cloud-bigquery-reservation/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_reservation_group_async.py similarity index 100% rename from owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_reservation_group_async.py rename to packages/google-cloud-bigquery-reservation/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_reservation_group_async.py diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_reservation_group_sync.py b/packages/google-cloud-bigquery-reservation/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_reservation_group_sync.py similarity index 100% rename from owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_reservation_group_sync.py rename to packages/google-cloud-bigquery-reservation/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_delete_reservation_group_sync.py diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_iam_policy_async.py b/packages/google-cloud-bigquery-reservation/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_iam_policy_async.py similarity index 100% rename from owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_iam_policy_async.py rename to packages/google-cloud-bigquery-reservation/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_iam_policy_async.py diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_iam_policy_sync.py b/packages/google-cloud-bigquery-reservation/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_iam_policy_sync.py similarity index 100% rename from owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_iam_policy_sync.py rename to packages/google-cloud-bigquery-reservation/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_iam_policy_sync.py diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_reservation_group_async.py b/packages/google-cloud-bigquery-reservation/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_reservation_group_async.py similarity index 100% rename from owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_reservation_group_async.py rename to packages/google-cloud-bigquery-reservation/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_reservation_group_async.py diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_reservation_group_sync.py b/packages/google-cloud-bigquery-reservation/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_reservation_group_sync.py similarity index 100% rename from owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_reservation_group_sync.py rename to packages/google-cloud-bigquery-reservation/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_get_reservation_group_sync.py diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_reservation_groups_async.py b/packages/google-cloud-bigquery-reservation/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_reservation_groups_async.py similarity index 100% rename from owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_reservation_groups_async.py rename to packages/google-cloud-bigquery-reservation/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_reservation_groups_async.py diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_reservation_groups_sync.py b/packages/google-cloud-bigquery-reservation/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_reservation_groups_sync.py similarity index 100% rename from owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_reservation_groups_sync.py rename to packages/google-cloud-bigquery-reservation/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_list_reservation_groups_sync.py diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_set_iam_policy_async.py b/packages/google-cloud-bigquery-reservation/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_set_iam_policy_async.py similarity index 100% rename from owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_set_iam_policy_async.py rename to packages/google-cloud-bigquery-reservation/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_set_iam_policy_async.py diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_set_iam_policy_sync.py b/packages/google-cloud-bigquery-reservation/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_set_iam_policy_sync.py similarity index 100% rename from owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_set_iam_policy_sync.py rename to packages/google-cloud-bigquery-reservation/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_set_iam_policy_sync.py diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_test_iam_permissions_async.py b/packages/google-cloud-bigquery-reservation/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_test_iam_permissions_async.py similarity index 100% rename from owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_test_iam_permissions_async.py rename to packages/google-cloud-bigquery-reservation/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_test_iam_permissions_async.py diff --git a/owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_test_iam_permissions_sync.py b/packages/google-cloud-bigquery-reservation/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_test_iam_permissions_sync.py similarity index 100% rename from owl-bot-staging/google-cloud-bigquery-reservation/v1/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_test_iam_permissions_sync.py rename to packages/google-cloud-bigquery-reservation/samples/generated_samples/bigqueryreservation_v1_generated_reservation_service_test_iam_permissions_sync.py diff --git a/packages/google-cloud-bigquery-reservation/samples/generated_samples/snippet_metadata_google.cloud.bigquery.reservation.v1.json b/packages/google-cloud-bigquery-reservation/samples/generated_samples/snippet_metadata_google.cloud.bigquery.reservation.v1.json index a2bccf0fed7b..6c2537553261 100644 --- a/packages/google-cloud-bigquery-reservation/samples/generated_samples/snippet_metadata_google.cloud.bigquery.reservation.v1.json +++ b/packages/google-cloud-bigquery-reservation/samples/generated_samples/snippet_metadata_google.cloud.bigquery.reservation.v1.json @@ -8,7 +8,7 @@ ], "language": "PYTHON", "name": "google-cloud-bigquery-reservation", - "version": "1.19.0" + "version": "0.1.0" }, "snippets": [ { @@ -349,6 +349,159 @@ ], "title": "bigqueryreservation_v1_generated_reservation_service_create_capacity_commitment_sync.py" }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.create_reservation_group", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.CreateReservationGroup", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "CreateReservationGroup" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.CreateReservationGroupRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.ReservationGroup", + "shortName": "create_reservation_group" + }, + "description": "Sample for CreateReservationGroup", + "file": "bigqueryreservation_v1_generated_reservation_service_create_reservation_group_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_CreateReservationGroup_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "bigqueryreservation_v1_generated_reservation_service_create_reservation_group_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.create_reservation_group", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.CreateReservationGroup", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "CreateReservationGroup" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.CreateReservationGroupRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.ReservationGroup", + "shortName": "create_reservation_group" + }, + "description": "Sample for CreateReservationGroup", + "file": "bigqueryreservation_v1_generated_reservation_service_create_reservation_group_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_CreateReservationGroup_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "bigqueryreservation_v1_generated_reservation_service_create_reservation_group_sync.py" + }, { "canonical": true, "clientMethod": { @@ -844,19 +997,19 @@ "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", "shortName": "ReservationServiceAsyncClient" }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.delete_reservation", + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.delete_reservation_group", "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservation", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservationGroup", "service": { "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", "shortName": "ReservationService" }, - "shortName": "DeleteReservation" + "shortName": "DeleteReservationGroup" }, "parameters": [ { "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.DeleteReservationRequest" + "type": "google.cloud.bigquery_reservation_v1.types.DeleteReservationGroupRequest" }, { "name": "name", @@ -875,13 +1028,13 @@ "type": "Sequence[Tuple[str, Union[str, bytes]]]" } ], - "shortName": "delete_reservation" + "shortName": "delete_reservation_group" }, - "description": "Sample for DeleteReservation", - "file": "bigqueryreservation_v1_generated_reservation_service_delete_reservation_async.py", + "description": "Sample for DeleteReservationGroup", + "file": "bigqueryreservation_v1_generated_reservation_service_delete_reservation_group_async.py", "language": "PYTHON", "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_DeleteReservation_async", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_DeleteReservationGroup_async", "segments": [ { "end": 49, @@ -912,7 +1065,7 @@ "type": "RESPONSE_HANDLING" } ], - "title": "bigqueryreservation_v1_generated_reservation_service_delete_reservation_async.py" + "title": "bigqueryreservation_v1_generated_reservation_service_delete_reservation_group_async.py" }, { "canonical": true, @@ -921,19 +1074,19 @@ "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", "shortName": "ReservationServiceClient" }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.delete_reservation", + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.delete_reservation_group", "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservation", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservationGroup", "service": { "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", "shortName": "ReservationService" }, - "shortName": "DeleteReservation" + "shortName": "DeleteReservationGroup" }, "parameters": [ { "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.DeleteReservationRequest" + "type": "google.cloud.bigquery_reservation_v1.types.DeleteReservationGroupRequest" }, { "name": "name", @@ -952,13 +1105,13 @@ "type": "Sequence[Tuple[str, Union[str, bytes]]]" } ], - "shortName": "delete_reservation" + "shortName": "delete_reservation_group" }, - "description": "Sample for DeleteReservation", - "file": "bigqueryreservation_v1_generated_reservation_service_delete_reservation_sync.py", + "description": "Sample for DeleteReservationGroup", + "file": "bigqueryreservation_v1_generated_reservation_service_delete_reservation_group_sync.py", "language": "PYTHON", "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_DeleteReservation_sync", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_DeleteReservationGroup_sync", "segments": [ { "end": 49, @@ -989,7 +1142,7 @@ "type": "RESPONSE_HANDLING" } ], - "title": "bigqueryreservation_v1_generated_reservation_service_delete_reservation_sync.py" + "title": "bigqueryreservation_v1_generated_reservation_service_delete_reservation_group_sync.py" }, { "canonical": true, @@ -999,19 +1152,23 @@ "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", "shortName": "ReservationServiceAsyncClient" }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.failover_reservation", + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.delete_reservation", "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.FailoverReservation", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservation", "service": { "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", "shortName": "ReservationService" }, - "shortName": "FailoverReservation" + "shortName": "DeleteReservation" }, "parameters": [ { "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.FailoverReservationRequest" + "type": "google.cloud.bigquery_reservation_v1.types.DeleteReservationRequest" + }, + { + "name": "name", + "type": "str" }, { "name": "retry", @@ -1026,22 +1183,21 @@ "type": "Sequence[Tuple[str, Union[str, bytes]]]" } ], - "resultType": "google.cloud.bigquery_reservation_v1.types.Reservation", - "shortName": "failover_reservation" + "shortName": "delete_reservation" }, - "description": "Sample for FailoverReservation", - "file": "bigqueryreservation_v1_generated_reservation_service_failover_reservation_async.py", + "description": "Sample for DeleteReservation", + "file": "bigqueryreservation_v1_generated_reservation_service_delete_reservation_async.py", "language": "PYTHON", "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_FailoverReservation_async", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_DeleteReservation_async", "segments": [ { - "end": 51, + "end": 49, "start": 27, "type": "FULL" }, { - "end": 51, + "end": 49, "start": 27, "type": "SHORT" }, @@ -1056,17 +1212,15 @@ "type": "REQUEST_INITIALIZATION" }, { - "end": 48, "start": 46, "type": "REQUEST_EXECUTION" }, { - "end": 52, - "start": 49, + "end": 50, "type": "RESPONSE_HANDLING" } ], - "title": "bigqueryreservation_v1_generated_reservation_service_failover_reservation_async.py" + "title": "bigqueryreservation_v1_generated_reservation_service_delete_reservation_async.py" }, { "canonical": true, @@ -1075,19 +1229,23 @@ "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", "shortName": "ReservationServiceClient" }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.failover_reservation", + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.delete_reservation", "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.FailoverReservation", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservation", "service": { "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", "shortName": "ReservationService" }, - "shortName": "FailoverReservation" + "shortName": "DeleteReservation" }, "parameters": [ { "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.FailoverReservationRequest" + "type": "google.cloud.bigquery_reservation_v1.types.DeleteReservationRequest" + }, + { + "name": "name", + "type": "str" }, { "name": "retry", @@ -1102,22 +1260,21 @@ "type": "Sequence[Tuple[str, Union[str, bytes]]]" } ], - "resultType": "google.cloud.bigquery_reservation_v1.types.Reservation", - "shortName": "failover_reservation" + "shortName": "delete_reservation" }, - "description": "Sample for FailoverReservation", - "file": "bigqueryreservation_v1_generated_reservation_service_failover_reservation_sync.py", + "description": "Sample for DeleteReservation", + "file": "bigqueryreservation_v1_generated_reservation_service_delete_reservation_sync.py", "language": "PYTHON", "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_FailoverReservation_sync", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_DeleteReservation_sync", "segments": [ { - "end": 51, + "end": 49, "start": 27, "type": "FULL" }, { - "end": 51, + "end": 49, "start": 27, "type": "SHORT" }, @@ -1132,17 +1289,15 @@ "type": "REQUEST_INITIALIZATION" }, { - "end": 48, "start": 46, "type": "REQUEST_EXECUTION" }, { - "end": 52, - "start": 49, + "end": 50, "type": "RESPONSE_HANDLING" } ], - "title": "bigqueryreservation_v1_generated_reservation_service_failover_reservation_sync.py" + "title": "bigqueryreservation_v1_generated_reservation_service_delete_reservation_sync.py" }, { "canonical": true, @@ -1152,23 +1307,19 @@ "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", "shortName": "ReservationServiceAsyncClient" }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.get_bi_reservation", + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.failover_reservation", "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetBiReservation", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.FailoverReservation", "service": { "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", "shortName": "ReservationService" }, - "shortName": "GetBiReservation" + "shortName": "FailoverReservation" }, "parameters": [ { "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.GetBiReservationRequest" - }, - { - "name": "name", - "type": "str" + "type": "google.cloud.bigquery_reservation_v1.types.FailoverReservationRequest" }, { "name": "retry", @@ -1183,14 +1334,14 @@ "type": "Sequence[Tuple[str, Union[str, bytes]]]" } ], - "resultType": "google.cloud.bigquery_reservation_v1.types.BiReservation", - "shortName": "get_bi_reservation" + "resultType": "google.cloud.bigquery_reservation_v1.types.Reservation", + "shortName": "failover_reservation" }, - "description": "Sample for GetBiReservation", - "file": "bigqueryreservation_v1_generated_reservation_service_get_bi_reservation_async.py", + "description": "Sample for FailoverReservation", + "file": "bigqueryreservation_v1_generated_reservation_service_failover_reservation_async.py", "language": "PYTHON", "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetBiReservation_async", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_FailoverReservation_async", "segments": [ { "end": 51, @@ -1223,7 +1374,7 @@ "type": "RESPONSE_HANDLING" } ], - "title": "bigqueryreservation_v1_generated_reservation_service_get_bi_reservation_async.py" + "title": "bigqueryreservation_v1_generated_reservation_service_failover_reservation_async.py" }, { "canonical": true, @@ -1232,23 +1383,19 @@ "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", "shortName": "ReservationServiceClient" }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.get_bi_reservation", + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.failover_reservation", "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetBiReservation", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.FailoverReservation", "service": { "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", "shortName": "ReservationService" }, - "shortName": "GetBiReservation" + "shortName": "FailoverReservation" }, "parameters": [ { "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.GetBiReservationRequest" - }, - { - "name": "name", - "type": "str" + "type": "google.cloud.bigquery_reservation_v1.types.FailoverReservationRequest" }, { "name": "retry", @@ -1263,14 +1410,14 @@ "type": "Sequence[Tuple[str, Union[str, bytes]]]" } ], - "resultType": "google.cloud.bigquery_reservation_v1.types.BiReservation", - "shortName": "get_bi_reservation" + "resultType": "google.cloud.bigquery_reservation_v1.types.Reservation", + "shortName": "failover_reservation" }, - "description": "Sample for GetBiReservation", - "file": "bigqueryreservation_v1_generated_reservation_service_get_bi_reservation_sync.py", + "description": "Sample for FailoverReservation", + "file": "bigqueryreservation_v1_generated_reservation_service_failover_reservation_sync.py", "language": "PYTHON", "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetBiReservation_sync", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_FailoverReservation_sync", "segments": [ { "end": 51, @@ -1303,7 +1450,7 @@ "type": "RESPONSE_HANDLING" } ], - "title": "bigqueryreservation_v1_generated_reservation_service_get_bi_reservation_sync.py" + "title": "bigqueryreservation_v1_generated_reservation_service_failover_reservation_sync.py" }, { "canonical": true, @@ -1313,19 +1460,502 @@ "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", "shortName": "ReservationServiceAsyncClient" }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.get_capacity_commitment", + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.get_bi_reservation", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetBiReservation", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "GetBiReservation" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.GetBiReservationRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.BiReservation", + "shortName": "get_bi_reservation" + }, + "description": "Sample for GetBiReservation", + "file": "bigqueryreservation_v1_generated_reservation_service_get_bi_reservation_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetBiReservation_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": "bigqueryreservation_v1_generated_reservation_service_get_bi_reservation_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.get_bi_reservation", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetBiReservation", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "GetBiReservation" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.GetBiReservationRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.BiReservation", + "shortName": "get_bi_reservation" + }, + "description": "Sample for GetBiReservation", + "file": "bigqueryreservation_v1_generated_reservation_service_get_bi_reservation_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetBiReservation_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": "bigqueryreservation_v1_generated_reservation_service_get_bi_reservation_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.get_capacity_commitment", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitment", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "GetCapacityCommitment" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.GetCapacityCommitmentRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.CapacityCommitment", + "shortName": "get_capacity_commitment" + }, + "description": "Sample for GetCapacityCommitment", + "file": "bigqueryreservation_v1_generated_reservation_service_get_capacity_commitment_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetCapacityCommitment_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": "bigqueryreservation_v1_generated_reservation_service_get_capacity_commitment_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.get_capacity_commitment", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitment", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "GetCapacityCommitment" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.GetCapacityCommitmentRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.types.CapacityCommitment", + "shortName": "get_capacity_commitment" + }, + "description": "Sample for GetCapacityCommitment", + "file": "bigqueryreservation_v1_generated_reservation_service_get_capacity_commitment_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetCapacityCommitment_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": "bigqueryreservation_v1_generated_reservation_service_get_capacity_commitment_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.get_iam_policy", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetIamPolicy", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "GetIamPolicy" + }, + "parameters": [ + { + "name": "request", + "type": "google.iam.v1.iam_policy_pb2.GetIamPolicyRequest" + }, + { + "name": "resource", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.iam.v1.policy_pb2.Policy", + "shortName": "get_iam_policy" + }, + "description": "Sample for GetIamPolicy", + "file": "bigqueryreservation_v1_generated_reservation_service_get_iam_policy_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetIamPolicy_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 41, + "start": 39, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 42, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "bigqueryreservation_v1_generated_reservation_service_get_iam_policy_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.get_iam_policy", "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitment", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetIamPolicy", "service": { "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", "shortName": "ReservationService" }, - "shortName": "GetCapacityCommitment" + "shortName": "GetIamPolicy" }, "parameters": [ { "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.GetCapacityCommitmentRequest" + "type": "google.iam.v1.iam_policy_pb2.GetIamPolicyRequest" + }, + { + "name": "resource", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.iam.v1.policy_pb2.Policy", + "shortName": "get_iam_policy" + }, + "description": "Sample for GetIamPolicy", + "file": "bigqueryreservation_v1_generated_reservation_service_get_iam_policy_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetIamPolicy_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 41, + "start": 39, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 42, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "bigqueryreservation_v1_generated_reservation_service_get_iam_policy_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.get_reservation_group", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetReservationGroup", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "GetReservationGroup" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.GetReservationGroupRequest" }, { "name": "name", @@ -1344,14 +1974,14 @@ "type": "Sequence[Tuple[str, Union[str, bytes]]]" } ], - "resultType": "google.cloud.bigquery_reservation_v1.types.CapacityCommitment", - "shortName": "get_capacity_commitment" + "resultType": "google.cloud.bigquery_reservation_v1.types.ReservationGroup", + "shortName": "get_reservation_group" }, - "description": "Sample for GetCapacityCommitment", - "file": "bigqueryreservation_v1_generated_reservation_service_get_capacity_commitment_async.py", + "description": "Sample for GetReservationGroup", + "file": "bigqueryreservation_v1_generated_reservation_service_get_reservation_group_async.py", "language": "PYTHON", "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetCapacityCommitment_async", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetReservationGroup_async", "segments": [ { "end": 51, @@ -1384,7 +2014,7 @@ "type": "RESPONSE_HANDLING" } ], - "title": "bigqueryreservation_v1_generated_reservation_service_get_capacity_commitment_async.py" + "title": "bigqueryreservation_v1_generated_reservation_service_get_reservation_group_async.py" }, { "canonical": true, @@ -1393,19 +2023,19 @@ "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", "shortName": "ReservationServiceClient" }, - "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.get_capacity_commitment", + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.get_reservation_group", "method": { - "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitment", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetReservationGroup", "service": { "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", "shortName": "ReservationService" }, - "shortName": "GetCapacityCommitment" + "shortName": "GetReservationGroup" }, "parameters": [ { "name": "request", - "type": "google.cloud.bigquery_reservation_v1.types.GetCapacityCommitmentRequest" + "type": "google.cloud.bigquery_reservation_v1.types.GetReservationGroupRequest" }, { "name": "name", @@ -1424,14 +2054,14 @@ "type": "Sequence[Tuple[str, Union[str, bytes]]]" } ], - "resultType": "google.cloud.bigquery_reservation_v1.types.CapacityCommitment", - "shortName": "get_capacity_commitment" + "resultType": "google.cloud.bigquery_reservation_v1.types.ReservationGroup", + "shortName": "get_reservation_group" }, - "description": "Sample for GetCapacityCommitment", - "file": "bigqueryreservation_v1_generated_reservation_service_get_capacity_commitment_sync.py", + "description": "Sample for GetReservationGroup", + "file": "bigqueryreservation_v1_generated_reservation_service_get_reservation_group_sync.py", "language": "PYTHON", "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetCapacityCommitment_sync", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetReservationGroup_sync", "segments": [ { "end": 51, @@ -1464,7 +2094,7 @@ "type": "RESPONSE_HANDLING" } ], - "title": "bigqueryreservation_v1_generated_reservation_service_get_capacity_commitment_sync.py" + "title": "bigqueryreservation_v1_generated_reservation_service_get_reservation_group_sync.py" }, { "canonical": true, @@ -1907,14 +2537,175 @@ "type": "Sequence[Tuple[str, Union[str, bytes]]]" } ], - "resultType": "google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListCapacityCommitmentsPager", - "shortName": "list_capacity_commitments" + "resultType": "google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListCapacityCommitmentsPager", + "shortName": "list_capacity_commitments" + }, + "description": "Sample for ListCapacityCommitments", + "file": "bigqueryreservation_v1_generated_reservation_service_list_capacity_commitments_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_ListCapacityCommitments_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": "bigqueryreservation_v1_generated_reservation_service_list_capacity_commitments_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.list_reservation_groups", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.ListReservationGroups", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "ListReservationGroups" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.ListReservationGroupsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListReservationGroupsAsyncPager", + "shortName": "list_reservation_groups" + }, + "description": "Sample for ListReservationGroups", + "file": "bigqueryreservation_v1_generated_reservation_service_list_reservation_groups_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_ListReservationGroups_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": "bigqueryreservation_v1_generated_reservation_service_list_reservation_groups_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.list_reservation_groups", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.ListReservationGroups", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "ListReservationGroups" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.bigquery_reservation_v1.types.ListReservationGroupsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.bigquery_reservation_v1.services.reservation_service.pagers.ListReservationGroupsPager", + "shortName": "list_reservation_groups" }, - "description": "Sample for ListCapacityCommitments", - "file": "bigqueryreservation_v1_generated_reservation_service_list_capacity_commitments_sync.py", + "description": "Sample for ListReservationGroups", + "file": "bigqueryreservation_v1_generated_reservation_service_list_reservation_groups_sync.py", "language": "PYTHON", "origin": "API_DEFINITION", - "regionTag": "bigqueryreservation_v1_generated_ReservationService_ListCapacityCommitments_sync", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_ListReservationGroups_sync", "segments": [ { "end": 52, @@ -1947,7 +2738,7 @@ "type": "RESPONSE_HANDLING" } ], - "title": "bigqueryreservation_v1_generated_reservation_service_list_capacity_commitments_sync.py" + "title": "bigqueryreservation_v1_generated_reservation_service_list_reservation_groups_sync.py" }, { "canonical": true, @@ -2786,6 +3577,167 @@ ], "title": "bigqueryreservation_v1_generated_reservation_service_search_assignments_sync.py" }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.set_iam_policy", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.SetIamPolicy", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "SetIamPolicy" + }, + "parameters": [ + { + "name": "request", + "type": "google.iam.v1.iam_policy_pb2.SetIamPolicyRequest" + }, + { + "name": "resource", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.iam.v1.policy_pb2.Policy", + "shortName": "set_iam_policy" + }, + "description": "Sample for SetIamPolicy", + "file": "bigqueryreservation_v1_generated_reservation_service_set_iam_policy_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_SetIamPolicy_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 41, + "start": 39, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 42, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "bigqueryreservation_v1_generated_reservation_service_set_iam_policy_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.set_iam_policy", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.SetIamPolicy", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "SetIamPolicy" + }, + "parameters": [ + { + "name": "request", + "type": "google.iam.v1.iam_policy_pb2.SetIamPolicyRequest" + }, + { + "name": "resource", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.iam.v1.policy_pb2.Policy", + "shortName": "set_iam_policy" + }, + "description": "Sample for SetIamPolicy", + "file": "bigqueryreservation_v1_generated_reservation_service_set_iam_policy_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_SetIamPolicy_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 41, + "start": 39, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 42, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "bigqueryreservation_v1_generated_reservation_service_set_iam_policy_sync.py" + }, { "canonical": true, "clientMethod": { @@ -2955,6 +3907,159 @@ ], "title": "bigqueryreservation_v1_generated_reservation_service_split_capacity_commitment_sync.py" }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient", + "shortName": "ReservationServiceAsyncClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceAsyncClient.test_iam_permissions", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.TestIamPermissions", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "TestIamPermissions" + }, + "parameters": [ + { + "name": "request", + "type": "google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse", + "shortName": "test_iam_permissions" + }, + "description": "Sample for TestIamPermissions", + "file": "bigqueryreservation_v1_generated_reservation_service_test_iam_permissions_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_TestIamPermissions_async", + "segments": [ + { + "end": 53, + "start": 27, + "type": "FULL" + }, + { + "end": 53, + "start": 27, + "type": "SHORT" + }, + { + "end": 41, + "start": 39, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 47, + "start": 42, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 50, + "start": 48, + "type": "REQUEST_EXECUTION" + }, + { + "end": 54, + "start": 51, + "type": "RESPONSE_HANDLING" + } + ], + "title": "bigqueryreservation_v1_generated_reservation_service_test_iam_permissions_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient", + "shortName": "ReservationServiceClient" + }, + "fullName": "google.cloud.bigquery_reservation_v1.ReservationServiceClient.test_iam_permissions", + "method": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.TestIamPermissions", + "service": { + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService", + "shortName": "ReservationService" + }, + "shortName": "TestIamPermissions" + }, + "parameters": [ + { + "name": "request", + "type": "google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse", + "shortName": "test_iam_permissions" + }, + "description": "Sample for TestIamPermissions", + "file": "bigqueryreservation_v1_generated_reservation_service_test_iam_permissions_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "bigqueryreservation_v1_generated_ReservationService_TestIamPermissions_sync", + "segments": [ + { + "end": 53, + "start": 27, + "type": "FULL" + }, + { + "end": 53, + "start": 27, + "type": "SHORT" + }, + { + "end": 41, + "start": 39, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 47, + "start": 42, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 50, + "start": 48, + "type": "REQUEST_EXECUTION" + }, + { + "end": 54, + "start": 51, + "type": "RESPONSE_HANDLING" + } + ], + "title": "bigqueryreservation_v1_generated_reservation_service_test_iam_permissions_sync.py" + }, { "canonical": true, "clientMethod": { diff --git a/packages/google-cloud-bigquery-reservation/scripts/fixup_bigquery_reservation_v1_keywords.py b/packages/google-cloud-bigquery-reservation/scripts/fixup_bigquery_reservation_v1_keywords.py index c97f0fa331cf..1bcaf6d5ab34 100644 --- a/packages/google-cloud-bigquery-reservation/scripts/fixup_bigquery_reservation_v1_keywords.py +++ b/packages/google-cloud-bigquery-reservation/scripts/fixup_bigquery_reservation_v1_keywords.py @@ -42,21 +42,28 @@ class bigquery_reservationCallTransformer(cst.CSTTransformer): 'create_assignment': ('parent', 'assignment', 'assignment_id', ), 'create_capacity_commitment': ('parent', 'capacity_commitment', 'enforce_single_admin_project_per_org', 'capacity_commitment_id', ), 'create_reservation': ('parent', 'reservation_id', 'reservation', ), + 'create_reservation_group': ('parent', 'reservation_group_id', 'reservation_group', ), 'delete_assignment': ('name', ), 'delete_capacity_commitment': ('name', 'force', ), 'delete_reservation': ('name', ), + 'delete_reservation_group': ('name', ), 'failover_reservation': ('name', 'failover_mode', ), 'get_bi_reservation': ('name', ), 'get_capacity_commitment': ('name', ), + 'get_iam_policy': ('resource', 'options', ), 'get_reservation': ('name', ), + 'get_reservation_group': ('name', ), 'list_assignments': ('parent', 'page_size', 'page_token', ), 'list_capacity_commitments': ('parent', 'page_size', 'page_token', ), + 'list_reservation_groups': ('parent', 'page_size', 'page_token', ), 'list_reservations': ('parent', 'page_size', 'page_token', ), - 'merge_capacity_commitments': ('parent', 'capacity_commitment_ids', ), + 'merge_capacity_commitments': ('parent', 'capacity_commitment_ids', 'capacity_commitment_id', ), 'move_assignment': ('name', 'destination_id', 'assignment_id', ), 'search_all_assignments': ('parent', 'query', 'page_size', 'page_token', ), 'search_assignments': ('parent', 'query', 'page_size', 'page_token', ), + 'set_iam_policy': ('resource', 'policy', 'update_mask', ), 'split_capacity_commitment': ('name', 'slot_count', ), + 'test_iam_permissions': ('resource', 'permissions', ), 'update_assignment': ('assignment', 'update_mask', ), 'update_bi_reservation': ('bi_reservation', 'update_mask', ), 'update_capacity_commitment': ('capacity_commitment', 'update_mask', ), diff --git a/packages/google-cloud-bigquery-reservation/setup.py b/packages/google-cloud-bigquery-reservation/setup.py index a245620cdae0..254bae4e9084 100644 --- a/packages/google-cloud-bigquery-reservation/setup.py +++ b/packages/google-cloud-bigquery-reservation/setup.py @@ -48,6 +48,7 @@ "proto-plus >= 1.22.3, <2.0.0", "proto-plus >= 1.25.0, <2.0.0; python_version >= '3.13'", "protobuf>=3.20.2,<7.0.0,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", + "grpc-google-iam-v1 >= 0.14.0, <1.0.0", ] extras = {} url = "https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-bigquery-reservation" diff --git a/packages/google-cloud-bigquery-reservation/testing/constraints-3.10.txt b/packages/google-cloud-bigquery-reservation/testing/constraints-3.10.txt index ed7f9aed2559..ad3f0fa58e2d 100644 --- a/packages/google-cloud-bigquery-reservation/testing/constraints-3.10.txt +++ b/packages/google-cloud-bigquery-reservation/testing/constraints-3.10.txt @@ -4,3 +4,4 @@ google-api-core proto-plus protobuf +grpc-google-iam-v1 diff --git a/packages/google-cloud-bigquery-reservation/testing/constraints-3.11.txt b/packages/google-cloud-bigquery-reservation/testing/constraints-3.11.txt index ed7f9aed2559..ad3f0fa58e2d 100644 --- a/packages/google-cloud-bigquery-reservation/testing/constraints-3.11.txt +++ b/packages/google-cloud-bigquery-reservation/testing/constraints-3.11.txt @@ -4,3 +4,4 @@ google-api-core proto-plus protobuf +grpc-google-iam-v1 diff --git a/packages/google-cloud-bigquery-reservation/testing/constraints-3.12.txt b/packages/google-cloud-bigquery-reservation/testing/constraints-3.12.txt index ed7f9aed2559..ad3f0fa58e2d 100644 --- a/packages/google-cloud-bigquery-reservation/testing/constraints-3.12.txt +++ b/packages/google-cloud-bigquery-reservation/testing/constraints-3.12.txt @@ -4,3 +4,4 @@ google-api-core proto-plus protobuf +grpc-google-iam-v1 diff --git a/packages/google-cloud-bigquery-reservation/testing/constraints-3.13.txt b/packages/google-cloud-bigquery-reservation/testing/constraints-3.13.txt index c20a77817caa..2010e549cceb 100644 --- a/packages/google-cloud-bigquery-reservation/testing/constraints-3.13.txt +++ b/packages/google-cloud-bigquery-reservation/testing/constraints-3.13.txt @@ -9,3 +9,4 @@ google-api-core>=2 google-auth>=2 proto-plus>=1 protobuf>=6 +grpc-google-iam-v1>=0 diff --git a/packages/google-cloud-bigquery-reservation/testing/constraints-3.7.txt b/packages/google-cloud-bigquery-reservation/testing/constraints-3.7.txt index a77f12bc13e4..56affbd9bd75 100644 --- a/packages/google-cloud-bigquery-reservation/testing/constraints-3.7.txt +++ b/packages/google-cloud-bigquery-reservation/testing/constraints-3.7.txt @@ -8,3 +8,4 @@ google-api-core==1.34.1 google-auth==2.14.1 proto-plus==1.22.3 protobuf==3.20.2 +grpc-google-iam-v1==0.14.0 diff --git a/packages/google-cloud-bigquery-reservation/testing/constraints-3.8.txt b/packages/google-cloud-bigquery-reservation/testing/constraints-3.8.txt index ed7f9aed2559..ad3f0fa58e2d 100644 --- a/packages/google-cloud-bigquery-reservation/testing/constraints-3.8.txt +++ b/packages/google-cloud-bigquery-reservation/testing/constraints-3.8.txt @@ -4,3 +4,4 @@ google-api-core proto-plus protobuf +grpc-google-iam-v1 diff --git a/packages/google-cloud-bigquery-reservation/testing/constraints-3.9.txt b/packages/google-cloud-bigquery-reservation/testing/constraints-3.9.txt index ed7f9aed2559..ad3f0fa58e2d 100644 --- a/packages/google-cloud-bigquery-reservation/testing/constraints-3.9.txt +++ b/packages/google-cloud-bigquery-reservation/testing/constraints-3.9.txt @@ -4,3 +4,4 @@ google-api-core proto-plus protobuf +grpc-google-iam-v1 diff --git a/packages/google-cloud-bigquery-reservation/tests/unit/gapic/bigquery_reservation_v1/test_reservation_service.py b/packages/google-cloud-bigquery-reservation/tests/unit/gapic/bigquery_reservation_v1/test_reservation_service.py index b6079f81b9e9..aab1b11237bc 100644 --- a/packages/google-cloud-bigquery-reservation/tests/unit/gapic/bigquery_reservation_v1/test_reservation_service.py +++ b/packages/google-cloud-bigquery-reservation/tests/unit/gapic/bigquery_reservation_v1/test_reservation_service.py @@ -50,11 +50,15 @@ import google.auth from google.auth import credentials as ga_credentials from google.auth.exceptions import MutualTLSChannelError +from google.iam.v1 import iam_policy_pb2 # type: ignore +from google.iam.v1 import options_pb2 # type: ignore +from google.iam.v1 import policy_pb2 # type: ignore from google.oauth2 import service_account from google.protobuf import any_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 expr_pb2 # type: ignore from google.cloud.bigquery_reservation_v1.services.reservation_service import ( ReservationServiceAsyncClient, @@ -1194,6 +1198,7 @@ def test_create_reservation(request_type, transport: str = "grpc"): original_primary_location="original_primary_location_value", max_slots=986, scaling_mode=gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + reservation_group="reservation_group_value", ) response = client.create_reservation(request) @@ -1218,6 +1223,7 @@ def test_create_reservation(request_type, transport: str = "grpc"): assert ( response.scaling_mode == gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY ) + assert response.reservation_group == "reservation_group_value" def test_create_reservation_non_empty_request_with_auto_populated_field(): @@ -1365,6 +1371,7 @@ async def test_create_reservation_async( original_primary_location="original_primary_location_value", max_slots=986, scaling_mode=gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + reservation_group="reservation_group_value", ) ) response = await client.create_reservation(request) @@ -1390,6 +1397,7 @@ async def test_create_reservation_async( assert ( response.scaling_mode == gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY ) + assert response.reservation_group == "reservation_group_value" @pytest.mark.asyncio @@ -2143,6 +2151,7 @@ def test_get_reservation(request_type, transport: str = "grpc"): original_primary_location="original_primary_location_value", max_slots=986, scaling_mode=reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + reservation_group="reservation_group_value", ) response = client.get_reservation(request) @@ -2165,6 +2174,7 @@ def test_get_reservation(request_type, transport: str = "grpc"): assert response.original_primary_location == "original_primary_location_value" assert response.max_slots == 986 assert response.scaling_mode == reservation.Reservation.ScalingMode.AUTOSCALE_ONLY + assert response.reservation_group == "reservation_group_value" def test_get_reservation_non_empty_request_with_auto_populated_field(): @@ -2301,6 +2311,7 @@ async def test_get_reservation_async( original_primary_location="original_primary_location_value", max_slots=986, scaling_mode=reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + reservation_group="reservation_group_value", ) ) response = await client.get_reservation(request) @@ -2324,6 +2335,7 @@ async def test_get_reservation_async( assert response.original_primary_location == "original_primary_location_value" assert response.max_slots == 986 assert response.scaling_mode == reservation.Reservation.ScalingMode.AUTOSCALE_ONLY + assert response.reservation_group == "reservation_group_value" @pytest.mark.asyncio @@ -2837,6 +2849,7 @@ def test_update_reservation(request_type, transport: str = "grpc"): original_primary_location="original_primary_location_value", max_slots=986, scaling_mode=gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + reservation_group="reservation_group_value", ) response = client.update_reservation(request) @@ -2861,6 +2874,7 @@ def test_update_reservation(request_type, transport: str = "grpc"): assert ( response.scaling_mode == gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY ) + assert response.reservation_group == "reservation_group_value" def test_update_reservation_non_empty_request_with_auto_populated_field(): @@ -3002,6 +3016,7 @@ async def test_update_reservation_async( original_primary_location="original_primary_location_value", max_slots=986, scaling_mode=gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + reservation_group="reservation_group_value", ) ) response = await client.update_reservation(request) @@ -3027,6 +3042,7 @@ async def test_update_reservation_async( assert ( response.scaling_mode == gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY ) + assert response.reservation_group == "reservation_group_value" @pytest.mark.asyncio @@ -3229,6 +3245,7 @@ def test_failover_reservation(request_type, transport: str = "grpc"): original_primary_location="original_primary_location_value", max_slots=986, scaling_mode=reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + reservation_group="reservation_group_value", ) response = client.failover_reservation(request) @@ -3251,6 +3268,7 @@ def test_failover_reservation(request_type, transport: str = "grpc"): assert response.original_primary_location == "original_primary_location_value" assert response.max_slots == 986 assert response.scaling_mode == reservation.Reservation.ScalingMode.AUTOSCALE_ONLY + assert response.reservation_group == "reservation_group_value" def test_failover_reservation_non_empty_request_with_auto_populated_field(): @@ -3395,6 +3413,7 @@ async def test_failover_reservation_async( original_primary_location="original_primary_location_value", max_slots=986, scaling_mode=reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + reservation_group="reservation_group_value", ) ) response = await client.failover_reservation(request) @@ -3418,6 +3437,7 @@ async def test_failover_reservation_async( assert response.original_primary_location == "original_primary_location_value" assert response.max_slots == 986 assert response.scaling_mode == reservation.Reservation.ScalingMode.AUTOSCALE_ONLY + assert response.reservation_group == "reservation_group_value" @pytest.mark.asyncio @@ -5913,6 +5933,7 @@ def test_merge_capacity_commitments_non_empty_request_with_auto_populated_field( # if they meet the requirements of AIP 4235. request = reservation.MergeCapacityCommitmentsRequest( parent="parent_value", + capacity_commitment_id="capacity_commitment_id_value", ) # Mock the actual call within the gRPC stub, and fake the request. @@ -5927,6 +5948,7 @@ def test_merge_capacity_commitments_non_empty_request_with_auto_populated_field( _, args, _ = call.mock_calls[0] assert args[0] == reservation.MergeCapacityCommitmentsRequest( parent="parent_value", + capacity_commitment_id="capacity_commitment_id_value", ) @@ -9971,13 +9993,79 @@ async def test_update_bi_reservation_flattened_error_async(): ) -def test_create_reservation_rest_use_cached_wrapped_rpc(): +@pytest.mark.parametrize( + "request_type", + [ + iam_policy_pb2.GetIamPolicyRequest, + dict, + ], +) +def test_get_iam_policy(request_type, transport: str = "grpc"): + client = ReservationServiceClient( + 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_iam_policy), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = policy_pb2.Policy( + version=774, + etag=b"etag_blob", + ) + response = client.get_iam_policy(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = iam_policy_pb2.GetIamPolicyRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, policy_pb2.Policy) + assert response.version == 774 + assert response.etag == b"etag_blob" + + +def test_get_iam_policy_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = iam_policy_pb2.GetIamPolicyRequest( + resource="resource_value", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_iam_policy), "__call__") as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.get_iam_policy(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == iam_policy_pb2.GetIamPolicyRequest( + resource="resource_value", + ) + + +def test_get_iam_policy_use_cached_wrapped_rpc(): # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, # instead of constructing them on each call with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), - transport="rest", + transport="grpc", ) # Should wrap all calls on client creation @@ -9985,188 +10073,339 @@ def test_create_reservation_rest_use_cached_wrapped_rpc(): wrapper_fn.reset_mock() # Ensure method has been cached - assert ( - client._transport.create_reservation in client._transport._wrapped_methods - ) + assert client._transport.get_iam_policy in client._transport._wrapped_methods # Replace cached wrapped function with mock mock_rpc = mock.Mock() mock_rpc.return_value.name = ( "foo" # operation_request.operation in compute client(s) expect a string. ) - client._transport._wrapped_methods[ - client._transport.create_reservation - ] = mock_rpc - + client._transport._wrapped_methods[client._transport.get_iam_policy] = mock_rpc request = {} - client.create_reservation(request) + client.get_iam_policy(request) # Establish that the underlying gRPC stub method was called. assert mock_rpc.call_count == 1 - client.create_reservation(request) + client.get_iam_policy(request) # Establish that a new wrapper was not created for this call assert wrapper_fn.call_count == 0 assert mock_rpc.call_count == 2 -def test_create_reservation_rest_required_fields( - request_type=gcbr_reservation.CreateReservationRequest, +@pytest.mark.asyncio +async def test_get_iam_policy_async_use_cached_wrapped_rpc( + transport: str = "grpc_asyncio", ): - transport_class = transports.ReservationServiceRestTransport + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) - 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, use_integers_for_enums=False) - ) + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() - # verify fields with default values are dropped + # Ensure method has been cached + assert ( + client._client._transport.get_iam_policy + in client._client._transport._wrapped_methods + ) - unset_fields = transport_class( - credentials=ga_credentials.AnonymousCredentials() - ).create_reservation._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[ + client._client._transport.get_iam_policy + ] = mock_rpc - # verify required fields with default values are now present + request = {} + await client.get_iam_policy(request) - jsonified_request["parent"] = "parent_value" + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 - unset_fields = transport_class( - credentials=ga_credentials.AnonymousCredentials() - ).create_reservation._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("reservation_id",)) - jsonified_request.update(unset_fields) + await client.get_iam_policy(request) - # verify required fields with non-default values are left alone - assert "parent" in jsonified_request - assert jsonified_request["parent"] == "parent_value" + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", + +@pytest.mark.asyncio +async def test_get_iam_policy_async( + transport: str = "grpc_asyncio", request_type=iam_policy_pb2.GetIamPolicyRequest +): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, ) - request = request_type(**request_init) - # Designate an appropriate value for the returned response. - return_value = gcbr_reservation.Reservation() - # 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 + # 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() - response_value = Response() - response_value.status_code = 200 + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_iam_policy), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + policy_pb2.Policy( + version=774, + etag=b"etag_blob", + ) + ) + response = await client.get_iam_policy(request) - # Convert return value to protobuf type - return_value = gcbr_reservation.Reservation.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = iam_policy_pb2.GetIamPolicyRequest() + assert args[0] == request - response_value._content = json_return_value.encode("UTF-8") - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + # Establish that the response is the type that we expect. + assert isinstance(response, policy_pb2.Policy) + assert response.version == 774 + assert response.etag == b"etag_blob" - response = client.create_reservation(request) - expected_params = [("$alt", "json;enum-encoding=int")] - actual_params = req.call_args.kwargs["params"] - assert expected_params == actual_params +@pytest.mark.asyncio +async def test_get_iam_policy_async_from_dict(): + await test_get_iam_policy_async(request_type=dict) -def test_create_reservation_rest_unset_required_fields(): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials +def test_get_iam_policy_field_headers(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), ) - unset_fields = transport.create_reservation._get_unset_required_fields({}) - assert set(unset_fields) == (set(("reservationId",)) & set(("parent",))) + # 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 = iam_policy_pb2.GetIamPolicyRequest() + request.resource = "resource_value" -def test_create_reservation_rest_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_iam_policy), "__call__") as call: + call.return_value = policy_pb2.Policy() + client.get_iam_policy(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", + "resource=resource_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_get_iam_policy_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), ) - # 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 = gcbr_reservation.Reservation() + # 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 = iam_policy_pb2.GetIamPolicyRequest() - # get arguments that satisfy an http rule for this method - sample_request = {"parent": "projects/sample1/locations/sample2"} + request.resource = "resource_value" - # get truthy value for each flattened field - mock_args = dict( - parent="parent_value", - reservation=gcbr_reservation.Reservation(name="name_value"), - reservation_id="reservation_id_value", - ) - mock_args.update(sample_request) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_iam_policy), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy()) + await client.get_iam_policy(request) - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = gcbr_reservation.Reservation.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode("UTF-8") - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request - client.create_reservation(**mock_args) + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "resource=resource_value", + ) in kw["metadata"] - # 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/v1/{parent=projects/*/locations/*}/reservations" - % client.transport._host, - args[1], + +def test_get_iam_policy_from_dict_foreign(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_iam_policy), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = policy_pb2.Policy() + response = client.get_iam_policy( + request={ + "resource": "resource_value", + "options": options_pb2.GetPolicyOptions(requested_policy_version=2598), + } ) + call.assert_called() -def test_create_reservation_rest_flattened_error(transport: str = "rest"): +def test_get_iam_policy_flattened(): client = ReservationServiceClient( 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_reservation( - gcbr_reservation.CreateReservationRequest(), - parent="parent_value", - reservation=gcbr_reservation.Reservation(name="name_value"), - reservation_id="reservation_id_value", + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_iam_policy), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = policy_pb2.Policy() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_iam_policy( + resource="resource_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].resource + mock_val = "resource_value" + assert arg == mock_val -def test_list_reservations_rest_use_cached_wrapped_rpc(): + +def test_get_iam_policy_flattened_error(): + client = ReservationServiceClient( + 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_iam_policy( + iam_policy_pb2.GetIamPolicyRequest(), + resource="resource_value", + ) + + +@pytest.mark.asyncio +async def test_get_iam_policy_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_iam_policy), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = policy_pb2.Policy() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_iam_policy( + resource="resource_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].resource + mock_val = "resource_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_get_iam_policy_flattened_error_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_iam_policy( + iam_policy_pb2.GetIamPolicyRequest(), + resource="resource_value", + ) + + +@pytest.mark.parametrize( + "request_type", + [ + iam_policy_pb2.SetIamPolicyRequest, + dict, + ], +) +def test_set_iam_policy(request_type, transport: str = "grpc"): + client = ReservationServiceClient( + 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.set_iam_policy), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = policy_pb2.Policy( + version=774, + etag=b"etag_blob", + ) + response = client.set_iam_policy(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = iam_policy_pb2.SetIamPolicyRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, policy_pb2.Policy) + assert response.version == 774 + assert response.etag == b"etag_blob" + + +def test_set_iam_policy_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = iam_policy_pb2.SetIamPolicyRequest( + resource="resource_value", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.set_iam_policy), "__call__") as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.set_iam_policy(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == iam_policy_pb2.SetIamPolicyRequest( + resource="resource_value", + ) + + +def test_set_iam_policy_use_cached_wrapped_rpc(): # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, # instead of constructing them on each call with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), - transport="rest", + transport="grpc", ) # Should wrap all calls on client creation @@ -10174,257 +10413,342 @@ def test_list_reservations_rest_use_cached_wrapped_rpc(): wrapper_fn.reset_mock() # Ensure method has been cached - assert client._transport.list_reservations in client._transport._wrapped_methods + assert client._transport.set_iam_policy in client._transport._wrapped_methods # Replace cached wrapped function with mock mock_rpc = mock.Mock() mock_rpc.return_value.name = ( "foo" # operation_request.operation in compute client(s) expect a string. ) - client._transport._wrapped_methods[ - client._transport.list_reservations - ] = mock_rpc - + client._transport._wrapped_methods[client._transport.set_iam_policy] = mock_rpc request = {} - client.list_reservations(request) + client.set_iam_policy(request) # Establish that the underlying gRPC stub method was called. assert mock_rpc.call_count == 1 - client.list_reservations(request) + client.set_iam_policy(request) # Establish that a new wrapper was not created for this call assert wrapper_fn.call_count == 0 assert mock_rpc.call_count == 2 -def test_list_reservations_rest_required_fields( - request_type=reservation.ListReservationsRequest, +@pytest.mark.asyncio +async def test_set_iam_policy_async_use_cached_wrapped_rpc( + transport: str = "grpc_asyncio", ): - transport_class = transports.ReservationServiceRestTransport - - 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, use_integers_for_enums=False) - ) - - # verify fields with default values are dropped + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) - unset_fields = transport_class( - credentials=ga_credentials.AnonymousCredentials() - ).list_reservations._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() - # verify required fields with default values are now present + # Ensure method has been cached + assert ( + client._client._transport.set_iam_policy + in client._client._transport._wrapped_methods + ) - jsonified_request["parent"] = "parent_value" + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[ + client._client._transport.set_iam_policy + ] = mock_rpc - unset_fields = transport_class( - credentials=ga_credentials.AnonymousCredentials() - ).list_reservations._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) + request = {} + await client.set_iam_policy(request) - # verify required fields with non-default values are left alone - assert "parent" in jsonified_request - assert jsonified_request["parent"] == "parent_value" + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - request = request_type(**request_init) + await client.set_iam_policy(request) - # Designate an appropriate value for the returned response. - return_value = reservation.ListReservationsResponse() - # 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 + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = reservation.ListReservationsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) +@pytest.mark.asyncio +async def test_set_iam_policy_async( + transport: str = "grpc_asyncio", request_type=iam_policy_pb2.SetIamPolicyRequest +): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) - response_value._content = json_return_value.encode("UTF-8") - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + # 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() - response = client.list_reservations(request) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.set_iam_policy), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + policy_pb2.Policy( + version=774, + etag=b"etag_blob", + ) + ) + response = await client.set_iam_policy(request) - expected_params = [("$alt", "json;enum-encoding=int")] - actual_params = req.call_args.kwargs["params"] - assert expected_params == actual_params + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = iam_policy_pb2.SetIamPolicyRequest() + assert args[0] == request + # Establish that the response is the type that we expect. + assert isinstance(response, policy_pb2.Policy) + assert response.version == 774 + assert response.etag == b"etag_blob" -def test_list_reservations_rest_unset_required_fields(): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials - ) - unset_fields = transport.list_reservations._get_unset_required_fields({}) - assert set(unset_fields) == ( - set( - ( - "pageSize", - "pageToken", - ) - ) - & set(("parent",)) - ) +@pytest.mark.asyncio +async def test_set_iam_policy_async_from_dict(): + await test_set_iam_policy_async(request_type=dict) -def test_list_reservations_rest_flattened(): +def test_set_iam_policy_field_headers(): client = ReservationServiceClient( 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 = reservation.ListReservationsResponse() + # 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 = iam_policy_pb2.SetIamPolicyRequest() - # get arguments that satisfy an http rule for this method - sample_request = {"parent": "projects/sample1/locations/sample2"} + request.resource = "resource_value" - # get truthy value for each flattened field - mock_args = dict( - parent="parent_value", - ) - mock_args.update(sample_request) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.set_iam_policy), "__call__") as call: + call.return_value = policy_pb2.Policy() + client.set_iam_policy(request) - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = reservation.ListReservationsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode("UTF-8") - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request - client.list_reservations(**mock_args) + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "resource=resource_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_set_iam_policy_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # 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 = iam_policy_pb2.SetIamPolicyRequest() + + request.resource = "resource_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.set_iam_policy), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy()) + await client.set_iam_policy(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", + "resource=resource_value", + ) in kw["metadata"] + + +def test_set_iam_policy_from_dict_foreign(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.set_iam_policy), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = policy_pb2.Policy() + response = client.set_iam_policy( + request={ + "resource": "resource_value", + "policy": policy_pb2.Policy(version=774), + "update_mask": field_mask_pb2.FieldMask(paths=["paths_value"]), + } + ) + call.assert_called() + + +def test_set_iam_policy_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.set_iam_policy), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = policy_pb2.Policy() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.set_iam_policy( + resource="resource_value", + ) # 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/v1/{parent=projects/*/locations/*}/reservations" - % client.transport._host, - args[1], - ) + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].resource + mock_val = "resource_value" + assert arg == mock_val -def test_list_reservations_rest_flattened_error(transport: str = "rest"): +def test_set_iam_policy_flattened_error(): client = ReservationServiceClient( 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_reservations( - reservation.ListReservationsRequest(), - parent="parent_value", + client.set_iam_policy( + iam_policy_pb2.SetIamPolicyRequest(), + resource="resource_value", ) -def test_list_reservations_rest_pager(transport: str = "rest"): +@pytest.mark.asyncio +async def test_set_iam_policy_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.set_iam_policy), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = policy_pb2.Policy() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(policy_pb2.Policy()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.set_iam_policy( + resource="resource_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].resource + mock_val = "resource_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_set_iam_policy_flattened_error_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.set_iam_policy( + iam_policy_pb2.SetIamPolicyRequest(), + resource="resource_value", + ) + + +@pytest.mark.parametrize( + "request_type", + [ + iam_policy_pb2.TestIamPermissionsRequest, + dict, + ], +) +def test_test_iam_permissions(request_type, transport: str = "grpc"): client = ReservationServiceClient( 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 = ( - reservation.ListReservationsResponse( - reservations=[ - reservation.Reservation(), - reservation.Reservation(), - reservation.Reservation(), - ], - next_page_token="abc", - ), - reservation.ListReservationsResponse( - reservations=[], - next_page_token="def", - ), - reservation.ListReservationsResponse( - reservations=[ - reservation.Reservation(), - ], - next_page_token="ghi", - ), - reservation.ListReservationsResponse( - reservations=[ - reservation.Reservation(), - reservation.Reservation(), - ], - ), - ) - # Two responses for two calls - response = response + response + # 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() - # Wrap the values into proper Response objs - response = tuple( - reservation.ListReservationsResponse.to_json(x) for x in response + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.test_iam_permissions), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = iam_policy_pb2.TestIamPermissionsResponse( + permissions=["permissions_value"], ) - 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 + response = client.test_iam_permissions(request) - sample_request = {"parent": "projects/sample1/locations/sample2"} + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = iam_policy_pb2.TestIamPermissionsRequest() + assert args[0] == request - pager = client.list_reservations(request=sample_request) + # Establish that the response is the type that we expect. + assert isinstance(response, iam_policy_pb2.TestIamPermissionsResponse) + assert response.permissions == ["permissions_value"] - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, reservation.Reservation) for i in results) - pages = list(client.list_reservations(request=sample_request).pages) - for page_, token in zip(pages, ["abc", "def", "ghi", ""]): - assert page_.raw_page.next_page_token == token +def test_test_iam_permissions_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = iam_policy_pb2.TestIamPermissionsRequest( + resource="resource_value", + ) -def test_get_reservation_rest_use_cached_wrapped_rpc(): + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.test_iam_permissions), "__call__" + ) as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.test_iam_permissions(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == iam_policy_pb2.TestIamPermissionsRequest( + resource="resource_value", + ) + + +def test_test_iam_permissions_use_cached_wrapped_rpc(): # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, # instead of constructing them on each call with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), - transport="rest", + transport="grpc", ) # Should wrap all calls on client creation @@ -10432,179 +10756,276 @@ def test_get_reservation_rest_use_cached_wrapped_rpc(): wrapper_fn.reset_mock() # Ensure method has been cached - assert client._transport.get_reservation in client._transport._wrapped_methods + assert ( + client._transport.test_iam_permissions in client._transport._wrapped_methods + ) # Replace cached wrapped function with mock mock_rpc = mock.Mock() mock_rpc.return_value.name = ( "foo" # operation_request.operation in compute client(s) expect a string. ) - client._transport._wrapped_methods[client._transport.get_reservation] = mock_rpc - + client._transport._wrapped_methods[ + client._transport.test_iam_permissions + ] = mock_rpc request = {} - client.get_reservation(request) + client.test_iam_permissions(request) # Establish that the underlying gRPC stub method was called. assert mock_rpc.call_count == 1 - client.get_reservation(request) + client.test_iam_permissions(request) # Establish that a new wrapper was not created for this call assert wrapper_fn.call_count == 0 assert mock_rpc.call_count == 2 -def test_get_reservation_rest_required_fields( - request_type=reservation.GetReservationRequest, +@pytest.mark.asyncio +async def test_test_iam_permissions_async_use_cached_wrapped_rpc( + transport: str = "grpc_asyncio", ): - transport_class = transports.ReservationServiceRestTransport + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) - 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, use_integers_for_enums=False) - ) + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() - # verify fields with default values are dropped + # Ensure method has been cached + assert ( + client._client._transport.test_iam_permissions + in client._client._transport._wrapped_methods + ) - unset_fields = transport_class( - credentials=ga_credentials.AnonymousCredentials() - ).get_reservation._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[ + client._client._transport.test_iam_permissions + ] = mock_rpc - # verify required fields with default values are now present + request = {} + await client.test_iam_permissions(request) - jsonified_request["name"] = "name_value" + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 - unset_fields = transport_class( - credentials=ga_credentials.AnonymousCredentials() - ).get_reservation._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) + await client.test_iam_permissions(request) - # verify required fields with non-default values are left alone - assert "name" in jsonified_request - assert jsonified_request["name"] == "name_value" + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", + +@pytest.mark.asyncio +async def test_test_iam_permissions_async( + transport: str = "grpc_asyncio", + request_type=iam_policy_pb2.TestIamPermissionsRequest, +): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, ) - request = request_type(**request_init) - # Designate an appropriate value for the returned response. - return_value = reservation.Reservation() - # 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 + # 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() - response_value = Response() - response_value.status_code = 200 + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.test_iam_permissions), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + iam_policy_pb2.TestIamPermissionsResponse( + permissions=["permissions_value"], + ) + ) + response = await client.test_iam_permissions(request) - # Convert return value to protobuf type - return_value = reservation.Reservation.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = iam_policy_pb2.TestIamPermissionsRequest() + assert args[0] == request - response_value._content = json_return_value.encode("UTF-8") - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + # Establish that the response is the type that we expect. + assert isinstance(response, iam_policy_pb2.TestIamPermissionsResponse) + assert response.permissions == ["permissions_value"] - response = client.get_reservation(request) - expected_params = [("$alt", "json;enum-encoding=int")] - actual_params = req.call_args.kwargs["params"] - assert expected_params == actual_params +@pytest.mark.asyncio +async def test_test_iam_permissions_async_from_dict(): + await test_test_iam_permissions_async(request_type=dict) -def test_get_reservation_rest_unset_required_fields(): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials +def test_test_iam_permissions_field_headers(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), ) - unset_fields = transport.get_reservation._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("name",))) + # 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 = iam_policy_pb2.TestIamPermissionsRequest() + request.resource = "resource_value" -def test_get_reservation_rest_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.test_iam_permissions), "__call__" + ) as call: + call.return_value = iam_policy_pb2.TestIamPermissionsResponse() + client.test_iam_permissions(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", + "resource=resource_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_test_iam_permissions_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), ) - # 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 = reservation.Reservation() + # 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 = iam_policy_pb2.TestIamPermissionsRequest() - # get arguments that satisfy an http rule for this method - sample_request = { - "name": "projects/sample1/locations/sample2/reservations/sample3" - } + request.resource = "resource_value" - # get truthy value for each flattened field - mock_args = dict( - name="name_value", + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.test_iam_permissions), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + iam_policy_pb2.TestIamPermissionsResponse() ) - mock_args.update(sample_request) + await client.test_iam_permissions(request) - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = reservation.Reservation.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode("UTF-8") - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request - client.get_reservation(**mock_args) + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "resource=resource_value", + ) in kw["metadata"] - # 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/v1/{name=projects/*/locations/*/reservations/*}" - % client.transport._host, - args[1], + +def test_test_iam_permissions_from_dict_foreign(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.test_iam_permissions), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = iam_policy_pb2.TestIamPermissionsResponse() + response = client.test_iam_permissions( + request={ + "resource": "resource_value", + "permissions": ["permissions_value"], + } ) + call.assert_called() -def test_get_reservation_rest_flattened_error(transport: str = "rest"): +@pytest.mark.parametrize( + "request_type", + [ + reservation.CreateReservationGroupRequest, + dict, + ], +) +def test_create_reservation_group(request_type, transport: str = "grpc"): client = ReservationServiceClient( 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_reservation( - reservation.GetReservationRequest(), + # 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_reservation_group), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.ReservationGroup( name="name_value", ) + response = client.create_reservation_group(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = reservation.CreateReservationGroupRequest() + assert args[0] == request + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.ReservationGroup) + assert response.name == "name_value" -def test_delete_reservation_rest_use_cached_wrapped_rpc(): + +def test_create_reservation_group_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = reservation.CreateReservationGroupRequest( + parent="parent_value", + reservation_group_id="reservation_group_id_value", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_reservation_group), "__call__" + ) as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.create_reservation_group(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.CreateReservationGroupRequest( + parent="parent_value", + reservation_group_id="reservation_group_id_value", + ) + + +def test_create_reservation_group_use_cached_wrapped_rpc(): # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, # instead of constructing them on each call with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), - transport="rest", + transport="grpc", ) # Should wrap all calls on client creation @@ -10613,7 +11034,8 @@ def test_delete_reservation_rest_use_cached_wrapped_rpc(): # Ensure method has been cached assert ( - client._transport.delete_reservation in client._transport._wrapped_methods + client._transport.create_reservation_group + in client._transport._wrapped_methods ) # Replace cached wrapped function with mock @@ -10622,168 +11044,245 @@ def test_delete_reservation_rest_use_cached_wrapped_rpc(): "foo" # operation_request.operation in compute client(s) expect a string. ) client._transport._wrapped_methods[ - client._transport.delete_reservation + client._transport.create_reservation_group ] = mock_rpc - request = {} - client.delete_reservation(request) + client.create_reservation_group(request) # Establish that the underlying gRPC stub method was called. assert mock_rpc.call_count == 1 - client.delete_reservation(request) + client.create_reservation_group(request) # Establish that a new wrapper was not created for this call assert wrapper_fn.call_count == 0 assert mock_rpc.call_count == 2 -def test_delete_reservation_rest_required_fields( - request_type=reservation.DeleteReservationRequest, +@pytest.mark.asyncio +async def test_create_reservation_group_async_use_cached_wrapped_rpc( + transport: str = "grpc_asyncio", ): - transport_class = transports.ReservationServiceRestTransport + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) - 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, use_integers_for_enums=False) - ) + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() - # verify fields with default values are dropped + # Ensure method has been cached + assert ( + client._client._transport.create_reservation_group + in client._client._transport._wrapped_methods + ) - unset_fields = transport_class( - credentials=ga_credentials.AnonymousCredentials() - ).delete_reservation._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[ + client._client._transport.create_reservation_group + ] = mock_rpc - # verify required fields with default values are now present + request = {} + await client.create_reservation_group(request) - jsonified_request["name"] = "name_value" + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 - unset_fields = transport_class( - credentials=ga_credentials.AnonymousCredentials() - ).delete_reservation._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) + await client.create_reservation_group(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +@pytest.mark.asyncio +async def test_create_reservation_group_async( + transport: str = "grpc_asyncio", + request_type=reservation.CreateReservationGroupRequest, +): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + 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_reservation_group), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + reservation.ReservationGroup( + name="name_value", + ) + ) + response = await client.create_reservation_group(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = reservation.CreateReservationGroupRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.ReservationGroup) + assert response.name == "name_value" + + +@pytest.mark.asyncio +async def test_create_reservation_group_async_from_dict(): + await test_create_reservation_group_async(request_type=dict) - # verify required fields with non-default values are left alone - assert "name" in jsonified_request - assert jsonified_request["name"] == "name_value" +def test_create_reservation_group_field_headers(): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), - transport="rest", ) - request = request_type(**request_init) - # Designate an appropriate value for the returned response. - return_value = None - # 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 + # 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 = reservation.CreateReservationGroupRequest() - response_value = Response() - response_value.status_code = 200 - json_return_value = "" + request.parent = "parent_value" - response_value._content = json_return_value.encode("UTF-8") - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_reservation_group), "__call__" + ) as call: + call.return_value = reservation.ReservationGroup() + client.create_reservation_group(request) - response = client.delete_reservation(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 - expected_params = [("$alt", "json;enum-encoding=int")] - actual_params = req.call_args.kwargs["params"] - assert expected_params == actual_params + # 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_delete_reservation_rest_unset_required_fields(): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials +@pytest.mark.asyncio +async def test_create_reservation_group_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), ) - unset_fields = transport.delete_reservation._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("name",))) + # 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 = reservation.CreateReservationGroupRequest() + request.parent = "parent_value" -def test_delete_reservation_rest_flattened(): + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_reservation_group), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + reservation.ReservationGroup() + ) + await client.create_reservation_group(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", + [ + reservation.GetReservationGroupRequest, + dict, + ], +) +def test_get_reservation_group(request_type, transport: str = "grpc"): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), - transport="rest", + transport=transport, ) - # 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 - - # get arguments that satisfy an http rule for this method - sample_request = { - "name": "projects/sample1/locations/sample2/reservations/sample3" - } + # 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() - # get truthy value for each flattened field - mock_args = dict( + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_reservation_group), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.ReservationGroup( 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 = "" - response_value._content = json_return_value.encode("UTF-8") - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.get_reservation_group(request) - client.delete_reservation(**mock_args) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = reservation.GetReservationGroupRequest() + assert args[0] == request - # 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/v1/{name=projects/*/locations/*/reservations/*}" - % client.transport._host, - args[1], - ) + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.ReservationGroup) + assert response.name == "name_value" -def test_delete_reservation_rest_flattened_error(transport: str = "rest"): +def test_get_reservation_group_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), - transport=transport, + transport="grpc", ) - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.delete_reservation( - reservation.DeleteReservationRequest(), + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = reservation.GetReservationGroupRequest( + name="name_value", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_reservation_group), "__call__" + ) as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.get_reservation_group(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.GetReservationGroupRequest( name="name_value", ) -def test_update_reservation_rest_use_cached_wrapped_rpc(): +def test_get_reservation_group_use_cached_wrapped_rpc(): # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, # instead of constructing them on each call with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), - transport="rest", + transport="grpc", ) # Should wrap all calls on client creation @@ -10792,7 +11291,8 @@ def test_update_reservation_rest_use_cached_wrapped_rpc(): # Ensure method has been cached assert ( - client._transport.update_reservation in client._transport._wrapped_methods + client._transport.get_reservation_group + in client._transport._wrapped_methods ) # Replace cached wrapped function with mock @@ -10801,93 +11301,327 @@ def test_update_reservation_rest_use_cached_wrapped_rpc(): "foo" # operation_request.operation in compute client(s) expect a string. ) client._transport._wrapped_methods[ - client._transport.update_reservation + client._transport.get_reservation_group ] = mock_rpc - request = {} - client.update_reservation(request) + client.get_reservation_group(request) # Establish that the underlying gRPC stub method was called. assert mock_rpc.call_count == 1 - client.update_reservation(request) + client.get_reservation_group(request) # Establish that a new wrapper was not created for this call assert wrapper_fn.call_count == 0 assert mock_rpc.call_count == 2 -def test_update_reservation_rest_flattened(): - client = ReservationServiceClient( - 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 = gcbr_reservation.Reservation() +@pytest.mark.asyncio +async def test_get_reservation_group_async_use_cached_wrapped_rpc( + transport: str = "grpc_asyncio", +): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) - # get arguments that satisfy an http rule for this method - sample_request = { - "reservation": { - "name": "projects/sample1/locations/sample2/reservations/sample3" - } - } + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() - # get truthy value for each flattened field - mock_args = dict( - reservation=gcbr_reservation.Reservation(name="name_value"), - update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + # Ensure method has been cached + assert ( + client._client._transport.get_reservation_group + in client._client._transport._wrapped_methods ) - mock_args.update(sample_request) - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = gcbr_reservation.Reservation.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode("UTF-8") - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[ + client._client._transport.get_reservation_group + ] = mock_rpc - client.update_reservation(**mock_args) + request = {} + await client.get_reservation_group(request) - # 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/v1/{reservation.name=projects/*/locations/*/reservations/*}" - % client.transport._host, - args[1], + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.get_reservation_group(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +@pytest.mark.asyncio +async def test_get_reservation_group_async( + transport: str = "grpc_asyncio", request_type=reservation.GetReservationGroupRequest +): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + 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_reservation_group), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + reservation.ReservationGroup( + name="name_value", + ) ) + response = await client.get_reservation_group(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = reservation.GetReservationGroupRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.ReservationGroup) + assert response.name == "name_value" -def test_update_reservation_rest_flattened_error(transport: str = "rest"): +@pytest.mark.asyncio +async def test_get_reservation_group_async_from_dict(): + await test_get_reservation_group_async(request_type=dict) + + +def test_get_reservation_group_field_headers(): + client = ReservationServiceClient( + 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 = reservation.GetReservationGroupRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_reservation_group), "__call__" + ) as call: + call.return_value = reservation.ReservationGroup() + client.get_reservation_group(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_reservation_group_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # 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 = reservation.GetReservationGroupRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_reservation_group), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + reservation.ReservationGroup() + ) + await client.get_reservation_group(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_reservation_group_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_reservation_group), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.ReservationGroup() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_reservation_group( + 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_reservation_group_flattened_error(): client = ReservationServiceClient( 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_reservation( - gcbr_reservation.UpdateReservationRequest(), - reservation=gcbr_reservation.Reservation(name="name_value"), - update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + client.get_reservation_group( + reservation.GetReservationGroupRequest(), + name="name_value", ) -def test_failover_reservation_rest_use_cached_wrapped_rpc(): +@pytest.mark.asyncio +async def test_get_reservation_group_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_reservation_group), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.ReservationGroup() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + reservation.ReservationGroup() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_reservation_group( + 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_reservation_group_flattened_error_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_reservation_group( + reservation.GetReservationGroupRequest(), + name="name_value", + ) + + +@pytest.mark.parametrize( + "request_type", + [ + reservation.DeleteReservationGroupRequest, + dict, + ], +) +def test_delete_reservation_group(request_type, transport: str = "grpc"): + client = ReservationServiceClient( + 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_reservation_group), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.delete_reservation_group(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = reservation.DeleteReservationGroupRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_reservation_group_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = reservation.DeleteReservationGroupRequest( + name="name_value", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_reservation_group), "__call__" + ) as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.delete_reservation_group(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.DeleteReservationGroupRequest( + name="name_value", + ) + + +def test_delete_reservation_group_use_cached_wrapped_rpc(): # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, # instead of constructing them on each call with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), - transport="rest", + transport="grpc", ) # Should wrap all calls on client creation @@ -10896,7 +11630,8 @@ def test_failover_reservation_rest_use_cached_wrapped_rpc(): # Ensure method has been cached assert ( - client._transport.failover_reservation in client._transport._wrapped_methods + client._transport.delete_reservation_group + in client._transport._wrapped_methods ) # Replace cached wrapped function with mock @@ -10905,315 +11640,324 @@ def test_failover_reservation_rest_use_cached_wrapped_rpc(): "foo" # operation_request.operation in compute client(s) expect a string. ) client._transport._wrapped_methods[ - client._transport.failover_reservation + client._transport.delete_reservation_group ] = mock_rpc - request = {} - client.failover_reservation(request) + client.delete_reservation_group(request) # Establish that the underlying gRPC stub method was called. assert mock_rpc.call_count == 1 - client.failover_reservation(request) + client.delete_reservation_group(request) # Establish that a new wrapper was not created for this call assert wrapper_fn.call_count == 0 assert mock_rpc.call_count == 2 -def test_failover_reservation_rest_required_fields( - request_type=reservation.FailoverReservationRequest, +@pytest.mark.asyncio +async def test_delete_reservation_group_async_use_cached_wrapped_rpc( + transport: str = "grpc_asyncio", ): - transport_class = transports.ReservationServiceRestTransport + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) - 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, use_integers_for_enums=False) - ) + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() - # verify fields with default values are dropped + # Ensure method has been cached + assert ( + client._client._transport.delete_reservation_group + in client._client._transport._wrapped_methods + ) - unset_fields = transport_class( - credentials=ga_credentials.AnonymousCredentials() - ).failover_reservation._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[ + client._client._transport.delete_reservation_group + ] = mock_rpc - # verify required fields with default values are now present + request = {} + await client.delete_reservation_group(request) - jsonified_request["name"] = "name_value" + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 - unset_fields = transport_class( - credentials=ga_credentials.AnonymousCredentials() - ).failover_reservation._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) + await client.delete_reservation_group(request) - # verify required fields with non-default values are left alone - assert "name" in jsonified_request - assert jsonified_request["name"] == "name_value" + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", + +@pytest.mark.asyncio +async def test_delete_reservation_group_async( + transport: str = "grpc_asyncio", + request_type=reservation.DeleteReservationGroupRequest, +): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, ) - request = request_type(**request_init) - # Designate an appropriate value for the returned response. - return_value = reservation.Reservation() - # 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 + # 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() - response_value = Response() - response_value.status_code = 200 + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_reservation_group), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.delete_reservation_group(request) - # Convert return value to protobuf type - return_value = reservation.Reservation.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = reservation.DeleteReservationGroupRequest() + assert args[0] == request - response_value._content = json_return_value.encode("UTF-8") - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + # Establish that the response is the type that we expect. + assert response is None - response = client.failover_reservation(request) - expected_params = [("$alt", "json;enum-encoding=int")] - actual_params = req.call_args.kwargs["params"] - assert expected_params == actual_params +@pytest.mark.asyncio +async def test_delete_reservation_group_async_from_dict(): + await test_delete_reservation_group_async(request_type=dict) -def test_failover_reservation_rest_unset_required_fields(): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials +def test_delete_reservation_group_field_headers(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), ) - unset_fields = transport.failover_reservation._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("name",))) - - -def test_create_capacity_commitment_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert ( - client._transport.create_capacity_commitment - in client._transport._wrapped_methods - ) + # 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 = reservation.DeleteReservationGroupRequest() - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = ( - "foo" # operation_request.operation in compute client(s) expect a string. - ) - client._transport._wrapped_methods[ - client._transport.create_capacity_commitment - ] = mock_rpc + request.name = "name_value" - request = {} - client.create_capacity_commitment(request) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_reservation_group), "__call__" + ) as call: + call.return_value = None + client.delete_reservation_group(request) # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.create_capacity_commitment(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 + 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"] -def test_create_capacity_commitment_rest_required_fields( - request_type=reservation.CreateCapacityCommitmentRequest, -): - transport_class = transports.ReservationServiceRestTransport - 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, use_integers_for_enums=False) +@pytest.mark.asyncio +async def test_delete_reservation_group_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), ) - # verify fields with default values are dropped + # 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 = reservation.DeleteReservationGroupRequest() - unset_fields = transport_class( - credentials=ga_credentials.AnonymousCredentials() - ).create_capacity_commitment._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) + request.name = "name_value" - # verify required fields with default values are now present + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_reservation_group), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_reservation_group(request) - jsonified_request["parent"] = "parent_value" + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request - unset_fields = transport_class( - credentials=ga_credentials.AnonymousCredentials() - ).create_capacity_commitment._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set( - ( - "capacity_commitment_id", - "enforce_single_admin_project_per_org", - ) - ) - jsonified_request.update(unset_fields) + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name_value", + ) in kw["metadata"] - # verify required fields with non-default values are left alone - assert "parent" in jsonified_request - assert jsonified_request["parent"] == "parent_value" +def test_delete_reservation_group_flattened(): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), - transport="rest", ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = reservation.CapacityCommitment() - # 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 + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_reservation_group), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = None + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.delete_reservation_group( + name="name_value", + ) - # Convert return value to protobuf type - return_value = reservation.CapacityCommitment.pb(return_value) - json_return_value = json_format.MessageToJson(return_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 - response_value._content = json_return_value.encode("UTF-8") - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.create_capacity_commitment(request) +def test_delete_reservation_group_flattened_error(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) - expected_params = [("$alt", "json;enum-encoding=int")] - actual_params = req.call_args.kwargs["params"] - assert expected_params == actual_params + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_reservation_group( + reservation.DeleteReservationGroupRequest(), + name="name_value", + ) -def test_create_capacity_commitment_rest_unset_required_fields(): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials +@pytest.mark.asyncio +async def test_delete_reservation_group_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), ) - unset_fields = transport.create_capacity_commitment._get_unset_required_fields({}) - assert set(unset_fields) == ( - set( - ( - "capacityCommitmentId", - "enforceSingleAdminProjectPerOrg", - ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_reservation_group), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = None + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.delete_reservation_group( + name="name_value", ) - & set(("parent",)) + + # 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_reservation_group_flattened_error_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), ) + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.delete_reservation_group( + reservation.DeleteReservationGroupRequest(), + name="name_value", + ) + -def test_create_capacity_commitment_rest_flattened(): +@pytest.mark.parametrize( + "request_type", + [ + reservation.ListReservationGroupsRequest, + dict, + ], +) +def test_list_reservation_groups(request_type, transport: str = "grpc"): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), - transport="rest", + transport=transport, ) - # 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 = reservation.CapacityCommitment() - - # get arguments that satisfy an http rule for this method - sample_request = {"parent": "projects/sample1/locations/sample2"} + # 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() - # get truthy value for each flattened field - mock_args = dict( - parent="parent_value", - capacity_commitment=reservation.CapacityCommitment(name="name_value"), + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_reservation_groups), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.ListReservationGroupsResponse( + next_page_token="next_page_token_value", ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = reservation.CapacityCommitment.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode("UTF-8") - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.list_reservation_groups(request) - client.create_capacity_commitment(**mock_args) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = reservation.ListReservationGroupsRequest() + assert args[0] == request - # 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/v1/{parent=projects/*/locations/*}/capacityCommitments" - % client.transport._host, - args[1], - ) + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListReservationGroupsPager) + assert response.next_page_token == "next_page_token_value" -def test_create_capacity_commitment_rest_flattened_error(transport: str = "rest"): +def test_list_reservation_groups_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), - transport=transport, + transport="grpc", ) - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.create_capacity_commitment( - reservation.CreateCapacityCommitmentRequest(), + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = reservation.ListReservationGroupsRequest( + parent="parent_value", + page_token="page_token_value", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_reservation_groups), "__call__" + ) as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.list_reservation_groups(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == reservation.ListReservationGroupsRequest( parent="parent_value", - capacity_commitment=reservation.CapacityCommitment(name="name_value"), + page_token="page_token_value", ) -def test_list_capacity_commitments_rest_use_cached_wrapped_rpc(): +def test_list_reservation_groups_use_cached_wrapped_rpc(): # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, # instead of constructing them on each call with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), - transport="rest", + transport="grpc", ) # Should wrap all calls on client creation @@ -11222,7 +11966,7 @@ def test_list_capacity_commitments_rest_use_cached_wrapped_rpc(): # Ensure method has been cached assert ( - client._transport.list_capacity_commitments + client._transport.list_reservation_groups in client._transport._wrapped_methods ) @@ -11232,290 +11976,505 @@ def test_list_capacity_commitments_rest_use_cached_wrapped_rpc(): "foo" # operation_request.operation in compute client(s) expect a string. ) client._transport._wrapped_methods[ - client._transport.list_capacity_commitments + client._transport.list_reservation_groups ] = mock_rpc - request = {} - client.list_capacity_commitments(request) + client.list_reservation_groups(request) # Establish that the underlying gRPC stub method was called. assert mock_rpc.call_count == 1 - client.list_capacity_commitments(request) + client.list_reservation_groups(request) # Establish that a new wrapper was not created for this call assert wrapper_fn.call_count == 0 assert mock_rpc.call_count == 2 -def test_list_capacity_commitments_rest_required_fields( - request_type=reservation.ListCapacityCommitmentsRequest, +@pytest.mark.asyncio +async def test_list_reservation_groups_async_use_cached_wrapped_rpc( + transport: str = "grpc_asyncio", ): - transport_class = transports.ReservationServiceRestTransport + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) - 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, use_integers_for_enums=False) - ) + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() - # verify fields with default values are dropped + # Ensure method has been cached + assert ( + client._client._transport.list_reservation_groups + in client._client._transport._wrapped_methods + ) - unset_fields = transport_class( - credentials=ga_credentials.AnonymousCredentials() - ).list_capacity_commitments._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[ + client._client._transport.list_reservation_groups + ] = mock_rpc - # verify required fields with default values are now present + request = {} + await client.list_reservation_groups(request) - jsonified_request["parent"] = "parent_value" + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 - unset_fields = transport_class( - credentials=ga_credentials.AnonymousCredentials() - ).list_capacity_commitments._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) + await client.list_reservation_groups(request) - # verify required fields with non-default values are left alone - assert "parent" in jsonified_request - assert jsonified_request["parent"] == "parent_value" + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", + +@pytest.mark.asyncio +async def test_list_reservation_groups_async( + transport: str = "grpc_asyncio", + request_type=reservation.ListReservationGroupsRequest, +): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, ) - request = request_type(**request_init) - # Designate an appropriate value for the returned response. - return_value = reservation.ListCapacityCommitmentsResponse() - # 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 + # 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() - response_value = Response() - response_value.status_code = 200 + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_reservation_groups), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + reservation.ListReservationGroupsResponse( + next_page_token="next_page_token_value", + ) + ) + response = await client.list_reservation_groups(request) - # Convert return value to protobuf type - return_value = reservation.ListCapacityCommitmentsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = reservation.ListReservationGroupsRequest() + assert args[0] == request - response_value._content = json_return_value.encode("UTF-8") - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListReservationGroupsAsyncPager) + assert response.next_page_token == "next_page_token_value" - response = client.list_capacity_commitments(request) - expected_params = [("$alt", "json;enum-encoding=int")] - actual_params = req.call_args.kwargs["params"] - assert expected_params == actual_params +@pytest.mark.asyncio +async def test_list_reservation_groups_async_from_dict(): + await test_list_reservation_groups_async(request_type=dict) -def test_list_capacity_commitments_rest_unset_required_fields(): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials +def test_list_reservation_groups_field_headers(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), ) - unset_fields = transport.list_capacity_commitments._get_unset_required_fields({}) - assert set(unset_fields) == ( - set( - ( - "pageSize", - "pageToken", - ) - ) - & set(("parent",)) - ) + # 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 = reservation.ListReservationGroupsRequest() + request.parent = "parent_value" -def test_list_capacity_commitments_rest_flattened(): + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_reservation_groups), "__call__" + ) as call: + call.return_value = reservation.ListReservationGroupsResponse() + client.list_reservation_groups(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_reservation_groups_field_headers_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # 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 = reservation.ListReservationGroupsRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_reservation_groups), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + reservation.ListReservationGroupsResponse() + ) + await client.list_reservation_groups(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_reservation_groups_flattened(): client = ReservationServiceClient( 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 = reservation.ListCapacityCommitmentsResponse() + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_reservation_groups), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.ListReservationGroupsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_reservation_groups( + parent="parent_value", + ) - # get arguments that satisfy an http rule for this method - sample_request = {"parent": "projects/sample1/locations/sample2"} + # 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 - # get truthy value for each flattened field - mock_args = dict( + +def test_list_reservation_groups_flattened_error(): + client = ReservationServiceClient( + 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_reservation_groups( + reservation.ListReservationGroupsRequest(), parent="parent_value", ) - mock_args.update(sample_request) - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = reservation.ListCapacityCommitmentsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode("UTF-8") - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.list_capacity_commitments(**mock_args) +@pytest.mark.asyncio +async def test_list_reservation_groups_flattened_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_reservation_groups), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = reservation.ListReservationGroupsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + reservation.ListReservationGroupsResponse() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_reservation_groups( + parent="parent_value", + ) # 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/v1/{parent=projects/*/locations/*}/capacityCommitments" - % client.transport._host, - args[1], - ) + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = "parent_value" + assert arg == mock_val -def test_list_capacity_commitments_rest_flattened_error(transport: str = "rest"): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, +@pytest.mark.asyncio +async def test_list_reservation_groups_flattened_error_async(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), ) # Attempting to call a method with both a request object and flattened # fields is an error. with pytest.raises(ValueError): - client.list_capacity_commitments( - reservation.ListCapacityCommitmentsRequest(), + await client.list_reservation_groups( + reservation.ListReservationGroupsRequest(), parent="parent_value", ) -def test_list_capacity_commitments_rest_pager(transport: str = "rest"): +def test_list_reservation_groups_pager(transport_name: str = "grpc"): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), - transport=transport, + transport=transport_name, ) - # 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 = ( - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[ - reservation.CapacityCommitment(), - reservation.CapacityCommitment(), - reservation.CapacityCommitment(), + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_reservation_groups), "__call__" + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.ListReservationGroupsResponse( + reservation_groups=[ + reservation.ReservationGroup(), + reservation.ReservationGroup(), + reservation.ReservationGroup(), ], next_page_token="abc", ), - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[], + reservation.ListReservationGroupsResponse( + reservation_groups=[], next_page_token="def", ), - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[ - reservation.CapacityCommitment(), + reservation.ListReservationGroupsResponse( + reservation_groups=[ + reservation.ReservationGroup(), ], next_page_token="ghi", ), - reservation.ListCapacityCommitmentsResponse( - capacity_commitments=[ - reservation.CapacityCommitment(), - reservation.CapacityCommitment(), + reservation.ListReservationGroupsResponse( + reservation_groups=[ + reservation.ReservationGroup(), + reservation.ReservationGroup(), ], ), + RuntimeError, ) - # Two responses for two calls - response = response + response - # Wrap the values into proper Response objs - response = tuple( - reservation.ListCapacityCommitmentsResponse.to_json(x) for x in response + expected_metadata = () + retry = retries.Retry() + timeout = 5 + expected_metadata = tuple(expected_metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", ""),)), ) - 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 + pager = client.list_reservation_groups(request={}, retry=retry, timeout=timeout) - sample_request = {"parent": "projects/sample1/locations/sample2"} - - pager = client.list_capacity_commitments(request=sample_request) + assert pager._metadata == expected_metadata + assert pager._retry == retry + assert pager._timeout == timeout results = list(pager) assert len(results) == 6 - assert all(isinstance(i, reservation.CapacityCommitment) for i in results) + assert all(isinstance(i, reservation.ReservationGroup) for i in results) - pages = list(client.list_capacity_commitments(request=sample_request).pages) - for page_, token in zip(pages, ["abc", "def", "ghi", ""]): - assert page_.raw_page.next_page_token == token +def test_list_reservation_groups_pages(transport_name: str = "grpc"): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport_name, + ) -def test_get_capacity_commitment_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_reservation_groups), "__call__" + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.ListReservationGroupsResponse( + reservation_groups=[ + reservation.ReservationGroup(), + reservation.ReservationGroup(), + reservation.ReservationGroup(), + ], + next_page_token="abc", + ), + reservation.ListReservationGroupsResponse( + reservation_groups=[], + next_page_token="def", + ), + reservation.ListReservationGroupsResponse( + reservation_groups=[ + reservation.ReservationGroup(), + ], + next_page_token="ghi", + ), + reservation.ListReservationGroupsResponse( + reservation_groups=[ + reservation.ReservationGroup(), + reservation.ReservationGroup(), + ], + ), + RuntimeError, ) + pages = list(client.list_reservation_groups(request={}).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - # Ensure method has been cached - assert ( - client._transport.get_capacity_commitment - in client._transport._wrapped_methods - ) +@pytest.mark.asyncio +async def test_list_reservation_groups_async_pager(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = ( - "foo" # operation_request.operation in compute client(s) expect a string. + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_reservation_groups), + "__call__", + new_callable=mock.AsyncMock, + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.ListReservationGroupsResponse( + reservation_groups=[ + reservation.ReservationGroup(), + reservation.ReservationGroup(), + reservation.ReservationGroup(), + ], + next_page_token="abc", + ), + reservation.ListReservationGroupsResponse( + reservation_groups=[], + next_page_token="def", + ), + reservation.ListReservationGroupsResponse( + reservation_groups=[ + reservation.ReservationGroup(), + ], + next_page_token="ghi", + ), + reservation.ListReservationGroupsResponse( + reservation_groups=[ + reservation.ReservationGroup(), + reservation.ReservationGroup(), + ], + ), + RuntimeError, ) - client._transport._wrapped_methods[ - client._transport.get_capacity_commitment - ] = mock_rpc + async_pager = await client.list_reservation_groups( + request={}, + ) + assert async_pager.next_page_token == "abc" + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) - request = {} - client.get_capacity_commitment(request) + assert len(responses) == 6 + assert all(isinstance(i, reservation.ReservationGroup) for i in responses) + + +@pytest.mark.asyncio +async def test_list_reservation_groups_async_pages(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_reservation_groups), + "__call__", + new_callable=mock.AsyncMock, + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + reservation.ListReservationGroupsResponse( + reservation_groups=[ + reservation.ReservationGroup(), + reservation.ReservationGroup(), + reservation.ReservationGroup(), + ], + next_page_token="abc", + ), + reservation.ListReservationGroupsResponse( + reservation_groups=[], + next_page_token="def", + ), + reservation.ListReservationGroupsResponse( + reservation_groups=[ + reservation.ReservationGroup(), + ], + next_page_token="ghi", + ), + reservation.ListReservationGroupsResponse( + reservation_groups=[ + reservation.ReservationGroup(), + reservation.ReservationGroup(), + ], + ), + RuntimeError, + ) + pages = [] + # Workaround issue in python 3.9 related to code coverage by adding `# pragma: no branch` + # See https://github.com/googleapis/gapic-generator-python/pull/1174#issuecomment-1025132372 + async for page_ in ( # pragma: no branch + await client.list_reservation_groups(request={}) + ).pages: + pages.append(page_) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +def test_create_reservation_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._transport.create_reservation in client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.create_reservation + ] = mock_rpc + + request = {} + client.create_reservation(request) # Establish that the underlying gRPC stub method was called. assert mock_rpc.call_count == 1 - client.get_capacity_commitment(request) + client.create_reservation(request) # Establish that a new wrapper was not created for this call assert wrapper_fn.call_count == 0 assert mock_rpc.call_count == 2 -def test_get_capacity_commitment_rest_required_fields( - request_type=reservation.GetCapacityCommitmentRequest, +def test_create_reservation_rest_required_fields( + request_type=gcbr_reservation.CreateReservationRequest, ): transport_class = transports.ReservationServiceRestTransport request_init = {} - request_init["name"] = "" + request_init["parent"] = "" request = request_type(**request_init) pb_request = request_type.pb(request) jsonified_request = json.loads( @@ -11526,21 +12485,23 @@ def test_get_capacity_commitment_rest_required_fields( unset_fields = transport_class( credentials=ga_credentials.AnonymousCredentials() - ).get_capacity_commitment._get_unset_required_fields(jsonified_request) + ).create_reservation._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" + jsonified_request["parent"] = "parent_value" unset_fields = transport_class( credentials=ga_credentials.AnonymousCredentials() - ).get_capacity_commitment._get_unset_required_fields(jsonified_request) + ).create_reservation._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("reservation_id",)) 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" + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), @@ -11549,7 +12510,7 @@ def test_get_capacity_commitment_rest_required_fields( request = request_type(**request_init) # Designate an appropriate value for the returned response. - return_value = reservation.CapacityCommitment() + return_value = gcbr_reservation.Reservation() # 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 @@ -11561,39 +12522,40 @@ def test_get_capacity_commitment_rest_required_fields( pb_request = request_type.pb(request) transcode_result = { "uri": "v1/sample_method", - "method": "get", + "method": "post", "query_params": pb_request, } + transcode_result["body"] = pb_request transcode.return_value = transcode_result response_value = Response() response_value.status_code = 200 # Convert return value to protobuf type - return_value = reservation.CapacityCommitment.pb(return_value) + return_value = gcbr_reservation.Reservation.pb(return_value) json_return_value = json_format.MessageToJson(return_value) response_value._content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.get_capacity_commitment(request) + response = client.create_reservation(request) expected_params = [("$alt", "json;enum-encoding=int")] actual_params = req.call_args.kwargs["params"] assert expected_params == actual_params -def test_get_capacity_commitment_rest_unset_required_fields(): +def test_create_reservation_rest_unset_required_fields(): transport = transports.ReservationServiceRestTransport( credentials=ga_credentials.AnonymousCredentials ) - unset_fields = transport.get_capacity_commitment._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("name",))) + unset_fields = transport.create_reservation._get_unset_required_fields({}) + assert set(unset_fields) == (set(("reservationId",)) & set(("parent",))) -def test_get_capacity_commitment_rest_flattened(): +def test_create_reservation_rest_flattened(): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest", @@ -11602,16 +12564,16 @@ def test_get_capacity_commitment_rest_flattened(): # 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 = reservation.CapacityCommitment() + return_value = gcbr_reservation.Reservation() # get arguments that satisfy an http rule for this method - sample_request = { - "name": "projects/sample1/locations/sample2/capacityCommitments/sample3" - } + sample_request = {"parent": "projects/sample1/locations/sample2"} # get truthy value for each flattened field mock_args = dict( - name="name_value", + parent="parent_value", + reservation=gcbr_reservation.Reservation(name="name_value"), + reservation_id="reservation_id_value", ) mock_args.update(sample_request) @@ -11619,26 +12581,26 @@ def test_get_capacity_commitment_rest_flattened(): response_value = Response() response_value.status_code = 200 # Convert return value to protobuf type - return_value = reservation.CapacityCommitment.pb(return_value) + return_value = gcbr_reservation.Reservation.pb(return_value) json_return_value = json_format.MessageToJson(return_value) response_value._content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.get_capacity_commitment(**mock_args) + client.create_reservation(**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/v1/{name=projects/*/locations/*/capacityCommitments/*}" + "%s/v1/{parent=projects/*/locations/*}/reservations" % client.transport._host, args[1], ) -def test_get_capacity_commitment_rest_flattened_error(transport: str = "rest"): +def test_create_reservation_rest_flattened_error(transport: str = "rest"): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport=transport, @@ -11647,13 +12609,15 @@ def test_get_capacity_commitment_rest_flattened_error(transport: str = "rest"): # Attempting to call a method with both a request object and flattened # fields is an error. with pytest.raises(ValueError): - client.get_capacity_commitment( - reservation.GetCapacityCommitmentRequest(), - name="name_value", + client.create_reservation( + gcbr_reservation.CreateReservationRequest(), + parent="parent_value", + reservation=gcbr_reservation.Reservation(name="name_value"), + reservation_id="reservation_id_value", ) -def test_delete_capacity_commitment_rest_use_cached_wrapped_rpc(): +def test_list_reservations_rest_use_cached_wrapped_rpc(): # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, # instead of constructing them on each call with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: @@ -11667,10 +12631,7 @@ def test_delete_capacity_commitment_rest_use_cached_wrapped_rpc(): wrapper_fn.reset_mock() # Ensure method has been cached - assert ( - client._transport.delete_capacity_commitment - in client._transport._wrapped_methods - ) + assert client._transport.list_reservations in client._transport._wrapped_methods # Replace cached wrapped function with mock mock_rpc = mock.Mock() @@ -11678,29 +12639,29 @@ def test_delete_capacity_commitment_rest_use_cached_wrapped_rpc(): "foo" # operation_request.operation in compute client(s) expect a string. ) client._transport._wrapped_methods[ - client._transport.delete_capacity_commitment + client._transport.list_reservations ] = mock_rpc request = {} - client.delete_capacity_commitment(request) + client.list_reservations(request) # Establish that the underlying gRPC stub method was called. assert mock_rpc.call_count == 1 - client.delete_capacity_commitment(request) + client.list_reservations(request) # Establish that a new wrapper was not created for this call assert wrapper_fn.call_count == 0 assert mock_rpc.call_count == 2 -def test_delete_capacity_commitment_rest_required_fields( - request_type=reservation.DeleteCapacityCommitmentRequest, +def test_list_reservations_rest_required_fields( + request_type=reservation.ListReservationsRequest, ): transport_class = transports.ReservationServiceRestTransport request_init = {} - request_init["name"] = "" + request_init["parent"] = "" request = request_type(**request_init) pb_request = request_type.pb(request) jsonified_request = json.loads( @@ -11711,23 +12672,28 @@ def test_delete_capacity_commitment_rest_required_fields( unset_fields = transport_class( credentials=ga_credentials.AnonymousCredentials() - ).delete_capacity_commitment._get_unset_required_fields(jsonified_request) + ).list_reservations._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" + jsonified_request["parent"] = "parent_value" unset_fields = transport_class( credentials=ga_credentials.AnonymousCredentials() - ).delete_capacity_commitment._get_unset_required_fields(jsonified_request) + ).list_reservations._get_unset_required_fields(jsonified_request) # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("force",)) + 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 "name" in jsonified_request - assert jsonified_request["name"] == "name_value" + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), @@ -11736,7 +12702,7 @@ def test_delete_capacity_commitment_rest_required_fields( request = request_type(**request_init) # Designate an appropriate value for the returned response. - return_value = None + return_value = reservation.ListReservationsResponse() # 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 @@ -11748,36 +12714,47 @@ def test_delete_capacity_commitment_rest_required_fields( pb_request = request_type.pb(request) transcode_result = { "uri": "v1/sample_method", - "method": "delete", + "method": "get", "query_params": pb_request, } transcode.return_value = transcode_result response_value = Response() response_value.status_code = 200 - json_return_value = "" + + # Convert return value to protobuf type + return_value = reservation.ListReservationsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) response_value._content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.delete_capacity_commitment(request) + response = client.list_reservations(request) expected_params = [("$alt", "json;enum-encoding=int")] actual_params = req.call_args.kwargs["params"] assert expected_params == actual_params -def test_delete_capacity_commitment_rest_unset_required_fields(): +def test_list_reservations_rest_unset_required_fields(): transport = transports.ReservationServiceRestTransport( credentials=ga_credentials.AnonymousCredentials ) - unset_fields = transport.delete_capacity_commitment._get_unset_required_fields({}) - assert set(unset_fields) == (set(("force",)) & set(("name",))) + unset_fields = transport.list_reservations._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "pageSize", + "pageToken", + ) + ) + & set(("parent",)) + ) -def test_delete_capacity_commitment_rest_flattened(): +def test_list_reservations_rest_flattened(): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest", @@ -11786,41 +12763,41 @@ def test_delete_capacity_commitment_rest_flattened(): # 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 + return_value = reservation.ListReservationsResponse() # get arguments that satisfy an http rule for this method - sample_request = { - "name": "projects/sample1/locations/sample2/capacityCommitments/sample3" - } + sample_request = {"parent": "projects/sample1/locations/sample2"} # get truthy value for each flattened field mock_args = dict( - name="name_value", + parent="parent_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 = "" + # Convert return value to protobuf type + return_value = reservation.ListReservationsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) response_value._content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.delete_capacity_commitment(**mock_args) + client.list_reservations(**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/v1/{name=projects/*/locations/*/capacityCommitments/*}" + "%s/v1/{parent=projects/*/locations/*}/reservations" % client.transport._host, args[1], ) -def test_delete_capacity_commitment_rest_flattened_error(transport: str = "rest"): +def test_list_reservations_rest_flattened_error(transport: str = "rest"): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport=transport, @@ -11829,118 +12806,76 @@ def test_delete_capacity_commitment_rest_flattened_error(transport: str = "rest" # Attempting to call a method with both a request object and flattened # fields is an error. with pytest.raises(ValueError): - client.delete_capacity_commitment( - reservation.DeleteCapacityCommitmentRequest(), - name="name_value", - ) - - -def test_update_capacity_commitment_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert ( - client._transport.update_capacity_commitment - in client._transport._wrapped_methods - ) - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = ( - "foo" # operation_request.operation in compute client(s) expect a string. + client.list_reservations( + reservation.ListReservationsRequest(), + parent="parent_value", ) - client._transport._wrapped_methods[ - client._transport.update_capacity_commitment - ] = mock_rpc - - request = {} - client.update_capacity_commitment(request) - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - client.update_capacity_commitment(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_update_capacity_commitment_rest_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) +def test_list_reservations_rest_pager(transport: str = "rest"): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) # 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 = reservation.CapacityCommitment() - - # get arguments that satisfy an http rule for this method - sample_request = { - "capacity_commitment": { - "name": "projects/sample1/locations/sample2/capacityCommitments/sample3" - } - } - - # get truthy value for each flattened field - mock_args = dict( - capacity_commitment=reservation.CapacityCommitment(name="name_value"), - update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + 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 = ( + reservation.ListReservationsResponse( + reservations=[ + reservation.Reservation(), + reservation.Reservation(), + reservation.Reservation(), + ], + next_page_token="abc", + ), + reservation.ListReservationsResponse( + reservations=[], + next_page_token="def", + ), + reservation.ListReservationsResponse( + reservations=[ + reservation.Reservation(), + ], + next_page_token="ghi", + ), + reservation.ListReservationsResponse( + reservations=[ + reservation.Reservation(), + reservation.Reservation(), + ], + ), ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = reservation.CapacityCommitment.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode("UTF-8") - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - client.update_capacity_commitment(**mock_args) + # Two responses for two calls + response = response + response - # 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/v1/{capacity_commitment.name=projects/*/locations/*/capacityCommitments/*}" - % client.transport._host, - args[1], + # Wrap the values into proper Response objs + response = tuple( + reservation.ListReservationsResponse.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"} -def test_update_capacity_commitment_rest_flattened_error(transport: str = "rest"): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) + pager = client.list_reservations(request=sample_request) - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.update_capacity_commitment( - reservation.UpdateCapacityCommitmentRequest(), - capacity_commitment=reservation.CapacityCommitment(name="name_value"), - update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), - ) + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, reservation.Reservation) for i in results) + pages = list(client.list_reservations(request=sample_request).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token -def test_split_capacity_commitment_rest_use_cached_wrapped_rpc(): + +def test_get_reservation_rest_use_cached_wrapped_rpc(): # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, # instead of constructing them on each call with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: @@ -11954,35 +12889,30 @@ def test_split_capacity_commitment_rest_use_cached_wrapped_rpc(): wrapper_fn.reset_mock() # Ensure method has been cached - assert ( - client._transport.split_capacity_commitment - in client._transport._wrapped_methods - ) + assert client._transport.get_reservation in client._transport._wrapped_methods # Replace cached wrapped function with mock mock_rpc = mock.Mock() mock_rpc.return_value.name = ( "foo" # operation_request.operation in compute client(s) expect a string. ) - client._transport._wrapped_methods[ - client._transport.split_capacity_commitment - ] = mock_rpc + client._transport._wrapped_methods[client._transport.get_reservation] = mock_rpc request = {} - client.split_capacity_commitment(request) + client.get_reservation(request) # Establish that the underlying gRPC stub method was called. assert mock_rpc.call_count == 1 - client.split_capacity_commitment(request) + client.get_reservation(request) # Establish that a new wrapper was not created for this call assert wrapper_fn.call_count == 0 assert mock_rpc.call_count == 2 -def test_split_capacity_commitment_rest_required_fields( - request_type=reservation.SplitCapacityCommitmentRequest, +def test_get_reservation_rest_required_fields( + request_type=reservation.GetReservationRequest, ): transport_class = transports.ReservationServiceRestTransport @@ -11998,7 +12928,7 @@ def test_split_capacity_commitment_rest_required_fields( unset_fields = transport_class( credentials=ga_credentials.AnonymousCredentials() - ).split_capacity_commitment._get_unset_required_fields(jsonified_request) + ).get_reservation._get_unset_required_fields(jsonified_request) jsonified_request.update(unset_fields) # verify required fields with default values are now present @@ -12007,7 +12937,7 @@ def test_split_capacity_commitment_rest_required_fields( unset_fields = transport_class( credentials=ga_credentials.AnonymousCredentials() - ).split_capacity_commitment._get_unset_required_fields(jsonified_request) + ).get_reservation._get_unset_required_fields(jsonified_request) jsonified_request.update(unset_fields) # verify required fields with non-default values are left alone @@ -12021,7 +12951,7 @@ def test_split_capacity_commitment_rest_required_fields( request = request_type(**request_init) # Designate an appropriate value for the returned response. - return_value = reservation.SplitCapacityCommitmentResponse() + return_value = reservation.Reservation() # 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 @@ -12033,40 +12963,39 @@ def test_split_capacity_commitment_rest_required_fields( pb_request = request_type.pb(request) transcode_result = { "uri": "v1/sample_method", - "method": "post", + "method": "get", "query_params": pb_request, } - transcode_result["body"] = pb_request transcode.return_value = transcode_result response_value = Response() response_value.status_code = 200 # Convert return value to protobuf type - return_value = reservation.SplitCapacityCommitmentResponse.pb(return_value) + return_value = reservation.Reservation.pb(return_value) json_return_value = json_format.MessageToJson(return_value) response_value._content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.split_capacity_commitment(request) + response = client.get_reservation(request) expected_params = [("$alt", "json;enum-encoding=int")] actual_params = req.call_args.kwargs["params"] assert expected_params == actual_params -def test_split_capacity_commitment_rest_unset_required_fields(): +def test_get_reservation_rest_unset_required_fields(): transport = transports.ReservationServiceRestTransport( credentials=ga_credentials.AnonymousCredentials ) - unset_fields = transport.split_capacity_commitment._get_unset_required_fields({}) + unset_fields = transport.get_reservation._get_unset_required_fields({}) assert set(unset_fields) == (set(()) & set(("name",))) -def test_split_capacity_commitment_rest_flattened(): +def test_get_reservation_rest_flattened(): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest", @@ -12075,17 +13004,16 @@ def test_split_capacity_commitment_rest_flattened(): # 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 = reservation.SplitCapacityCommitmentResponse() + return_value = reservation.Reservation() # get arguments that satisfy an http rule for this method sample_request = { - "name": "projects/sample1/locations/sample2/capacityCommitments/sample3" + "name": "projects/sample1/locations/sample2/reservations/sample3" } # get truthy value for each flattened field mock_args = dict( name="name_value", - slot_count=1098, ) mock_args.update(sample_request) @@ -12093,26 +13021,26 @@ def test_split_capacity_commitment_rest_flattened(): response_value = Response() response_value.status_code = 200 # Convert return value to protobuf type - return_value = reservation.SplitCapacityCommitmentResponse.pb(return_value) + return_value = reservation.Reservation.pb(return_value) json_return_value = json_format.MessageToJson(return_value) response_value._content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.split_capacity_commitment(**mock_args) + client.get_reservation(**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/v1/{name=projects/*/locations/*/capacityCommitments/*}:split" + "%s/v1/{name=projects/*/locations/*/reservations/*}" % client.transport._host, args[1], ) -def test_split_capacity_commitment_rest_flattened_error(transport: str = "rest"): +def test_get_reservation_rest_flattened_error(transport: str = "rest"): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport=transport, @@ -12121,14 +13049,13 @@ def test_split_capacity_commitment_rest_flattened_error(transport: str = "rest") # Attempting to call a method with both a request object and flattened # fields is an error. with pytest.raises(ValueError): - client.split_capacity_commitment( - reservation.SplitCapacityCommitmentRequest(), + client.get_reservation( + reservation.GetReservationRequest(), name="name_value", - slot_count=1098, ) -def test_merge_capacity_commitments_rest_use_cached_wrapped_rpc(): +def test_delete_reservation_rest_use_cached_wrapped_rpc(): # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, # instead of constructing them on each call with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: @@ -12143,8 +13070,7 @@ def test_merge_capacity_commitments_rest_use_cached_wrapped_rpc(): # Ensure method has been cached assert ( - client._transport.merge_capacity_commitments - in client._transport._wrapped_methods + client._transport.delete_reservation in client._transport._wrapped_methods ) # Replace cached wrapped function with mock @@ -12153,163 +13079,63 @@ def test_merge_capacity_commitments_rest_use_cached_wrapped_rpc(): "foo" # operation_request.operation in compute client(s) expect a string. ) client._transport._wrapped_methods[ - client._transport.merge_capacity_commitments + client._transport.delete_reservation ] = mock_rpc request = {} - client.merge_capacity_commitments(request) + client.delete_reservation(request) # Establish that the underlying gRPC stub method was called. assert mock_rpc.call_count == 1 - client.merge_capacity_commitments(request) + client.delete_reservation(request) # Establish that a new wrapper was not created for this call assert wrapper_fn.call_count == 0 assert mock_rpc.call_count == 2 -def test_merge_capacity_commitments_rest_flattened(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) +def test_delete_reservation_rest_required_fields( + request_type=reservation.DeleteReservationRequest, +): + transport_class = transports.ReservationServiceRestTransport - # 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 = reservation.CapacityCommitment() + 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, use_integers_for_enums=False) + ) - # get arguments that satisfy an http rule for this method - sample_request = {"parent": "projects/sample1/locations/sample2"} + # verify fields with default values are dropped - # get truthy value for each flattened field - mock_args = dict( - parent="parent_value", - capacity_commitment_ids=["capacity_commitment_ids_value"], - ) - mock_args.update(sample_request) + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_reservation._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = reservation.CapacityCommitment.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode("UTF-8") - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + # verify required fields with default values are now present - client.merge_capacity_commitments(**mock_args) + jsonified_request["name"] = "name_value" - # 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/v1/{parent=projects/*/locations/*}/capacityCommitments:merge" - % client.transport._host, - args[1], - ) + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_reservation._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" -def test_merge_capacity_commitments_rest_flattened_error(transport: str = "rest"): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), - transport=transport, + transport="rest", ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.merge_capacity_commitments( - reservation.MergeCapacityCommitmentsRequest(), - parent="parent_value", - capacity_commitment_ids=["capacity_commitment_ids_value"], - ) - - -def test_create_assignment_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.create_assignment in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = ( - "foo" # operation_request.operation in compute client(s) expect a string. - ) - client._transport._wrapped_methods[ - client._transport.create_assignment - ] = mock_rpc - - request = {} - client.create_assignment(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.create_assignment(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_create_assignment_rest_required_fields( - request_type=reservation.CreateAssignmentRequest, -): - transport_class = transports.ReservationServiceRestTransport - - 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, use_integers_for_enums=False) - ) - - # verify fields with default values are dropped - - unset_fields = transport_class( - credentials=ga_credentials.AnonymousCredentials() - ).create_assignment._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_assignment._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("assignment_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 = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - request = request_type(**request_init) + request = request_type(**request_init) # Designate an appropriate value for the returned response. - return_value = reservation.Assignment() + return_value = None # 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 @@ -12321,40 +13147,36 @@ def test_create_assignment_rest_required_fields( pb_request = request_type.pb(request) transcode_result = { "uri": "v1/sample_method", - "method": "post", + "method": "delete", "query_params": pb_request, } - transcode_result["body"] = pb_request transcode.return_value = transcode_result response_value = Response() response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = reservation.Assignment.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) + json_return_value = "" response_value._content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.create_assignment(request) + response = client.delete_reservation(request) expected_params = [("$alt", "json;enum-encoding=int")] actual_params = req.call_args.kwargs["params"] assert expected_params == actual_params -def test_create_assignment_rest_unset_required_fields(): +def test_delete_reservation_rest_unset_required_fields(): transport = transports.ReservationServiceRestTransport( credentials=ga_credentials.AnonymousCredentials ) - unset_fields = transport.create_assignment._get_unset_required_fields({}) - assert set(unset_fields) == (set(("assignmentId",)) & set(("parent",))) + unset_fields = transport.delete_reservation._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) -def test_create_assignment_rest_flattened(): +def test_delete_reservation_rest_flattened(): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest", @@ -12363,44 +13185,41 @@ def test_create_assignment_rest_flattened(): # 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 = reservation.Assignment() + return_value = None # get arguments that satisfy an http rule for this method sample_request = { - "parent": "projects/sample1/locations/sample2/reservations/sample3" + "name": "projects/sample1/locations/sample2/reservations/sample3" } # get truthy value for each flattened field mock_args = dict( - parent="parent_value", - assignment=reservation.Assignment(name="name_value"), + name="name_value", ) mock_args.update(sample_request) # Wrap the value into a proper Response obj response_value = Response() response_value.status_code = 200 - # Convert return value to protobuf type - return_value = reservation.Assignment.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) + json_return_value = "" response_value._content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.create_assignment(**mock_args) + client.delete_reservation(**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/v1/{parent=projects/*/locations/*/reservations/*}/assignments" + "%s/v1/{name=projects/*/locations/*/reservations/*}" % client.transport._host, args[1], ) -def test_create_assignment_rest_flattened_error(transport: str = "rest"): +def test_delete_reservation_rest_flattened_error(transport: str = "rest"): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport=transport, @@ -12409,14 +13228,13 @@ def test_create_assignment_rest_flattened_error(transport: str = "rest"): # Attempting to call a method with both a request object and flattened # fields is an error. with pytest.raises(ValueError): - client.create_assignment( - reservation.CreateAssignmentRequest(), - parent="parent_value", - assignment=reservation.Assignment(name="name_value"), + client.delete_reservation( + reservation.DeleteReservationRequest(), + name="name_value", ) -def test_list_assignments_rest_use_cached_wrapped_rpc(): +def test_update_reservation_rest_use_cached_wrapped_rpc(): # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, # instead of constructing them on each call with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: @@ -12430,7 +13248,9 @@ def test_list_assignments_rest_use_cached_wrapped_rpc(): wrapper_fn.reset_mock() # Ensure method has been cached - assert client._transport.list_assignments in client._transport._wrapped_methods + assert ( + client._transport.update_reservation in client._transport._wrapped_methods + ) # Replace cached wrapped function with mock mock_rpc = mock.Mock() @@ -12438,122 +13258,23 @@ def test_list_assignments_rest_use_cached_wrapped_rpc(): "foo" # operation_request.operation in compute client(s) expect a string. ) client._transport._wrapped_methods[ - client._transport.list_assignments + client._transport.update_reservation ] = mock_rpc request = {} - client.list_assignments(request) + client.update_reservation(request) # Establish that the underlying gRPC stub method was called. assert mock_rpc.call_count == 1 - client.list_assignments(request) + client.update_reservation(request) # Establish that a new wrapper was not created for this call assert wrapper_fn.call_count == 0 assert mock_rpc.call_count == 2 -def test_list_assignments_rest_required_fields( - request_type=reservation.ListAssignmentsRequest, -): - transport_class = transports.ReservationServiceRestTransport - - 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, use_integers_for_enums=False) - ) - - # verify fields with default values are dropped - - unset_fields = transport_class( - credentials=ga_credentials.AnonymousCredentials() - ).list_assignments._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_assignments._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 = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = reservation.ListAssignmentsResponse() - # 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 - - # Convert return value to protobuf type - return_value = reservation.ListAssignmentsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode("UTF-8") - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - response = client.list_assignments(request) - - expected_params = [("$alt", "json;enum-encoding=int")] - actual_params = req.call_args.kwargs["params"] - assert expected_params == actual_params - - -def test_list_assignments_rest_unset_required_fields(): - transport = transports.ReservationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials - ) - - unset_fields = transport.list_assignments._get_unset_required_fields({}) - assert set(unset_fields) == ( - set( - ( - "pageSize", - "pageToken", - ) - ) - & set(("parent",)) - ) - - -def test_list_assignments_rest_flattened(): +def test_update_reservation_rest_flattened(): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest", @@ -12562,16 +13283,19 @@ def test_list_assignments_rest_flattened(): # 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 = reservation.ListAssignmentsResponse() + return_value = gcbr_reservation.Reservation() # get arguments that satisfy an http rule for this method sample_request = { - "parent": "projects/sample1/locations/sample2/reservations/sample3" + "reservation": { + "name": "projects/sample1/locations/sample2/reservations/sample3" + } } # get truthy value for each flattened field mock_args = dict( - parent="parent_value", + reservation=gcbr_reservation.Reservation(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), ) mock_args.update(sample_request) @@ -12579,26 +13303,26 @@ def test_list_assignments_rest_flattened(): response_value = Response() response_value.status_code = 200 # Convert return value to protobuf type - return_value = reservation.ListAssignmentsResponse.pb(return_value) + return_value = gcbr_reservation.Reservation.pb(return_value) json_return_value = json_format.MessageToJson(return_value) response_value._content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.list_assignments(**mock_args) + client.update_reservation(**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/v1/{parent=projects/*/locations/*/reservations/*}/assignments" + "%s/v1/{reservation.name=projects/*/locations/*/reservations/*}" % client.transport._host, args[1], ) -def test_list_assignments_rest_flattened_error(transport: str = "rest"): +def test_update_reservation_rest_flattened_error(transport: str = "rest"): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport=transport, @@ -12607,78 +13331,14 @@ def test_list_assignments_rest_flattened_error(transport: str = "rest"): # Attempting to call a method with both a request object and flattened # fields is an error. with pytest.raises(ValueError): - client.list_assignments( - reservation.ListAssignmentsRequest(), - parent="parent_value", + client.update_reservation( + gcbr_reservation.UpdateReservationRequest(), + reservation=gcbr_reservation.Reservation(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), ) -def test_list_assignments_rest_pager(transport: str = "rest"): - client = ReservationServiceClient( - 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 = ( - reservation.ListAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - reservation.Assignment(), - ], - next_page_token="abc", - ), - reservation.ListAssignmentsResponse( - assignments=[], - next_page_token="def", - ), - reservation.ListAssignmentsResponse( - assignments=[ - reservation.Assignment(), - ], - next_page_token="ghi", - ), - reservation.ListAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - ], - ), - ) - # Two responses for two calls - response = response + response - - # Wrap the values into proper Response objs - response = tuple( - reservation.ListAssignmentsResponse.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/reservations/sample3" - } - - pager = client.list_assignments(request=sample_request) - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, reservation.Assignment) for i in results) - - pages = list(client.list_assignments(request=sample_request).pages) - for page_, token in zip(pages, ["abc", "def", "ghi", ""]): - assert page_.raw_page.next_page_token == token - - -def test_delete_assignment_rest_use_cached_wrapped_rpc(): +def test_failover_reservation_rest_use_cached_wrapped_rpc(): # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, # instead of constructing them on each call with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: @@ -12692,7 +13352,9 @@ def test_delete_assignment_rest_use_cached_wrapped_rpc(): wrapper_fn.reset_mock() # Ensure method has been cached - assert client._transport.delete_assignment in client._transport._wrapped_methods + assert ( + client._transport.failover_reservation in client._transport._wrapped_methods + ) # Replace cached wrapped function with mock mock_rpc = mock.Mock() @@ -12700,24 +13362,24 @@ def test_delete_assignment_rest_use_cached_wrapped_rpc(): "foo" # operation_request.operation in compute client(s) expect a string. ) client._transport._wrapped_methods[ - client._transport.delete_assignment + client._transport.failover_reservation ] = mock_rpc request = {} - client.delete_assignment(request) + client.failover_reservation(request) # Establish that the underlying gRPC stub method was called. assert mock_rpc.call_count == 1 - client.delete_assignment(request) + client.failover_reservation(request) # Establish that a new wrapper was not created for this call assert wrapper_fn.call_count == 0 assert mock_rpc.call_count == 2 -def test_delete_assignment_rest_required_fields( - request_type=reservation.DeleteAssignmentRequest, +def test_failover_reservation_rest_required_fields( + request_type=reservation.FailoverReservationRequest, ): transport_class = transports.ReservationServiceRestTransport @@ -12733,7 +13395,7 @@ def test_delete_assignment_rest_required_fields( unset_fields = transport_class( credentials=ga_credentials.AnonymousCredentials() - ).delete_assignment._get_unset_required_fields(jsonified_request) + ).failover_reservation._get_unset_required_fields(jsonified_request) jsonified_request.update(unset_fields) # verify required fields with default values are now present @@ -12742,7 +13404,7 @@ def test_delete_assignment_rest_required_fields( unset_fields = transport_class( credentials=ga_credentials.AnonymousCredentials() - ).delete_assignment._get_unset_required_fields(jsonified_request) + ).failover_reservation._get_unset_required_fields(jsonified_request) jsonified_request.update(unset_fields) # verify required fields with non-default values are left alone @@ -12756,7 +13418,7 @@ def test_delete_assignment_rest_required_fields( request = request_type(**request_init) # Designate an appropriate value for the returned response. - return_value = None + return_value = reservation.Reservation() # 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 @@ -12768,94 +13430,40 @@ def test_delete_assignment_rest_required_fields( pb_request = request_type.pb(request) transcode_result = { "uri": "v1/sample_method", - "method": "delete", + "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 = "" + + # Convert return value to protobuf type + return_value = reservation.Reservation.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) response_value._content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.delete_assignment(request) + response = client.failover_reservation(request) expected_params = [("$alt", "json;enum-encoding=int")] actual_params = req.call_args.kwargs["params"] assert expected_params == actual_params -def test_delete_assignment_rest_unset_required_fields(): +def test_failover_reservation_rest_unset_required_fields(): transport = transports.ReservationServiceRestTransport( credentials=ga_credentials.AnonymousCredentials ) - unset_fields = transport.delete_assignment._get_unset_required_fields({}) + unset_fields = transport.failover_reservation._get_unset_required_fields({}) assert set(unset_fields) == (set(()) & set(("name",))) -def test_delete_assignment_rest_flattened(): - client = ReservationServiceClient( - 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 = None - - # get arguments that satisfy an http rule for this method - sample_request = { - "name": "projects/sample1/locations/sample2/reservations/sample3/assignments/sample4" - } - - # 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 = "" - response_value._content = json_return_value.encode("UTF-8") - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - client.delete_assignment(**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/v1/{name=projects/*/locations/*/reservations/*/assignments/*}" - % client.transport._host, - args[1], - ) - - -def test_delete_assignment_rest_flattened_error(transport: str = "rest"): - client = ReservationServiceClient( - 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_assignment( - reservation.DeleteAssignmentRequest(), - name="name_value", - ) - - -def test_search_assignments_rest_use_cached_wrapped_rpc(): +def test_create_capacity_commitment_rest_use_cached_wrapped_rpc(): # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, # instead of constructing them on each call with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: @@ -12870,7 +13478,8 @@ def test_search_assignments_rest_use_cached_wrapped_rpc(): # Ensure method has been cached assert ( - client._transport.search_assignments in client._transport._wrapped_methods + client._transport.create_capacity_commitment + in client._transport._wrapped_methods ) # Replace cached wrapped function with mock @@ -12879,24 +13488,24 @@ def test_search_assignments_rest_use_cached_wrapped_rpc(): "foo" # operation_request.operation in compute client(s) expect a string. ) client._transport._wrapped_methods[ - client._transport.search_assignments + client._transport.create_capacity_commitment ] = mock_rpc request = {} - client.search_assignments(request) + client.create_capacity_commitment(request) # Establish that the underlying gRPC stub method was called. assert mock_rpc.call_count == 1 - client.search_assignments(request) + client.create_capacity_commitment(request) # Establish that a new wrapper was not created for this call assert wrapper_fn.call_count == 0 assert mock_rpc.call_count == 2 -def test_search_assignments_rest_required_fields( - request_type=reservation.SearchAssignmentsRequest, +def test_create_capacity_commitment_rest_required_fields( + request_type=reservation.CreateCapacityCommitmentRequest, ): transport_class = transports.ReservationServiceRestTransport @@ -12912,7 +13521,7 @@ def test_search_assignments_rest_required_fields( unset_fields = transport_class( credentials=ga_credentials.AnonymousCredentials() - ).search_assignments._get_unset_required_fields(jsonified_request) + ).create_capacity_commitment._get_unset_required_fields(jsonified_request) jsonified_request.update(unset_fields) # verify required fields with default values are now present @@ -12921,13 +13530,12 @@ def test_search_assignments_rest_required_fields( unset_fields = transport_class( credentials=ga_credentials.AnonymousCredentials() - ).search_assignments._get_unset_required_fields(jsonified_request) + ).create_capacity_commitment._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", - "query", + "capacity_commitment_id", + "enforce_single_admin_project_per_org", ) ) jsonified_request.update(unset_fields) @@ -12943,7 +13551,7 @@ def test_search_assignments_rest_required_fields( request = request_type(**request_init) # Designate an appropriate value for the returned response. - return_value = reservation.SearchAssignmentsResponse() + return_value = reservation.CapacityCommitment() # 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 @@ -12955,48 +13563,48 @@ def test_search_assignments_rest_required_fields( pb_request = request_type.pb(request) transcode_result = { "uri": "v1/sample_method", - "method": "get", + "method": "post", "query_params": pb_request, } + transcode_result["body"] = pb_request transcode.return_value = transcode_result response_value = Response() response_value.status_code = 200 # Convert return value to protobuf type - return_value = reservation.SearchAssignmentsResponse.pb(return_value) + return_value = reservation.CapacityCommitment.pb(return_value) json_return_value = json_format.MessageToJson(return_value) response_value._content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.search_assignments(request) + response = client.create_capacity_commitment(request) expected_params = [("$alt", "json;enum-encoding=int")] actual_params = req.call_args.kwargs["params"] assert expected_params == actual_params -def test_search_assignments_rest_unset_required_fields(): +def test_create_capacity_commitment_rest_unset_required_fields(): transport = transports.ReservationServiceRestTransport( credentials=ga_credentials.AnonymousCredentials ) - unset_fields = transport.search_assignments._get_unset_required_fields({}) + unset_fields = transport.create_capacity_commitment._get_unset_required_fields({}) assert set(unset_fields) == ( set( ( - "pageSize", - "pageToken", - "query", + "capacityCommitmentId", + "enforceSingleAdminProjectPerOrg", ) ) & set(("parent",)) ) -def test_search_assignments_rest_flattened(): +def test_create_capacity_commitment_rest_flattened(): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest", @@ -13005,7 +13613,7 @@ def test_search_assignments_rest_flattened(): # 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 = reservation.SearchAssignmentsResponse() + return_value = reservation.CapacityCommitment() # get arguments that satisfy an http rule for this method sample_request = {"parent": "projects/sample1/locations/sample2"} @@ -13013,7 +13621,7 @@ def test_search_assignments_rest_flattened(): # get truthy value for each flattened field mock_args = dict( parent="parent_value", - query="query_value", + capacity_commitment=reservation.CapacityCommitment(name="name_value"), ) mock_args.update(sample_request) @@ -13021,26 +13629,26 @@ def test_search_assignments_rest_flattened(): response_value = Response() response_value.status_code = 200 # Convert return value to protobuf type - return_value = reservation.SearchAssignmentsResponse.pb(return_value) + return_value = reservation.CapacityCommitment.pb(return_value) json_return_value = json_format.MessageToJson(return_value) response_value._content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.search_assignments(**mock_args) + client.create_capacity_commitment(**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/v1/{parent=projects/*/locations/*}:searchAssignments" + "%s/v1/{parent=projects/*/locations/*}/capacityCommitments" % client.transport._host, args[1], ) -def test_search_assignments_rest_flattened_error(transport: str = "rest"): +def test_create_capacity_commitment_rest_flattened_error(transport: str = "rest"): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport=transport, @@ -13049,84 +13657,21 @@ def test_search_assignments_rest_flattened_error(transport: str = "rest"): # Attempting to call a method with both a request object and flattened # fields is an error. with pytest.raises(ValueError): - client.search_assignments( - reservation.SearchAssignmentsRequest(), + client.create_capacity_commitment( + reservation.CreateCapacityCommitmentRequest(), parent="parent_value", - query="query_value", + capacity_commitment=reservation.CapacityCommitment(name="name_value"), ) -def test_search_assignments_rest_pager(transport: str = "rest"): - client = ReservationServiceClient( - 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 = ( - reservation.SearchAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - reservation.Assignment(), - ], - next_page_token="abc", - ), - reservation.SearchAssignmentsResponse( - assignments=[], - next_page_token="def", - ), - reservation.SearchAssignmentsResponse( - assignments=[ - reservation.Assignment(), - ], - next_page_token="ghi", - ), - reservation.SearchAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - ], - ), - ) - # Two responses for two calls - response = response + response - - # Wrap the values into proper Response objs - response = tuple( - reservation.SearchAssignmentsResponse.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.search_assignments(request=sample_request) - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, reservation.Assignment) for i in results) - - pages = list(client.search_assignments(request=sample_request).pages) - for page_, token in zip(pages, ["abc", "def", "ghi", ""]): - assert page_.raw_page.next_page_token == token - - -def test_search_all_assignments_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) +def test_list_capacity_commitments_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) # Should wrap all calls on client creation assert wrapper_fn.call_count > 0 @@ -13134,7 +13679,7 @@ def test_search_all_assignments_rest_use_cached_wrapped_rpc(): # Ensure method has been cached assert ( - client._transport.search_all_assignments + client._transport.list_capacity_commitments in client._transport._wrapped_methods ) @@ -13144,24 +13689,24 @@ def test_search_all_assignments_rest_use_cached_wrapped_rpc(): "foo" # operation_request.operation in compute client(s) expect a string. ) client._transport._wrapped_methods[ - client._transport.search_all_assignments + client._transport.list_capacity_commitments ] = mock_rpc request = {} - client.search_all_assignments(request) + client.list_capacity_commitments(request) # Establish that the underlying gRPC stub method was called. assert mock_rpc.call_count == 1 - client.search_all_assignments(request) + client.list_capacity_commitments(request) # Establish that a new wrapper was not created for this call assert wrapper_fn.call_count == 0 assert mock_rpc.call_count == 2 -def test_search_all_assignments_rest_required_fields( - request_type=reservation.SearchAllAssignmentsRequest, +def test_list_capacity_commitments_rest_required_fields( + request_type=reservation.ListCapacityCommitmentsRequest, ): transport_class = transports.ReservationServiceRestTransport @@ -13177,7 +13722,7 @@ def test_search_all_assignments_rest_required_fields( unset_fields = transport_class( credentials=ga_credentials.AnonymousCredentials() - ).search_all_assignments._get_unset_required_fields(jsonified_request) + ).list_capacity_commitments._get_unset_required_fields(jsonified_request) jsonified_request.update(unset_fields) # verify required fields with default values are now present @@ -13186,13 +13731,12 @@ def test_search_all_assignments_rest_required_fields( unset_fields = transport_class( credentials=ga_credentials.AnonymousCredentials() - ).search_all_assignments._get_unset_required_fields(jsonified_request) + ).list_capacity_commitments._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", - "query", ) ) jsonified_request.update(unset_fields) @@ -13208,7 +13752,7 @@ def test_search_all_assignments_rest_required_fields( request = request_type(**request_init) # Designate an appropriate value for the returned response. - return_value = reservation.SearchAllAssignmentsResponse() + return_value = reservation.ListCapacityCommitmentsResponse() # 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 @@ -13229,39 +13773,38 @@ def test_search_all_assignments_rest_required_fields( response_value.status_code = 200 # Convert return value to protobuf type - return_value = reservation.SearchAllAssignmentsResponse.pb(return_value) + return_value = reservation.ListCapacityCommitmentsResponse.pb(return_value) json_return_value = json_format.MessageToJson(return_value) response_value._content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.search_all_assignments(request) + response = client.list_capacity_commitments(request) expected_params = [("$alt", "json;enum-encoding=int")] actual_params = req.call_args.kwargs["params"] assert expected_params == actual_params -def test_search_all_assignments_rest_unset_required_fields(): +def test_list_capacity_commitments_rest_unset_required_fields(): transport = transports.ReservationServiceRestTransport( credentials=ga_credentials.AnonymousCredentials ) - unset_fields = transport.search_all_assignments._get_unset_required_fields({}) + unset_fields = transport.list_capacity_commitments._get_unset_required_fields({}) assert set(unset_fields) == ( set( ( "pageSize", "pageToken", - "query", ) ) & set(("parent",)) ) -def test_search_all_assignments_rest_flattened(): +def test_list_capacity_commitments_rest_flattened(): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest", @@ -13270,7 +13813,7 @@ def test_search_all_assignments_rest_flattened(): # 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 = reservation.SearchAllAssignmentsResponse() + return_value = reservation.ListCapacityCommitmentsResponse() # get arguments that satisfy an http rule for this method sample_request = {"parent": "projects/sample1/locations/sample2"} @@ -13278,7 +13821,6 @@ def test_search_all_assignments_rest_flattened(): # get truthy value for each flattened field mock_args = dict( parent="parent_value", - query="query_value", ) mock_args.update(sample_request) @@ -13286,26 +13828,26 @@ def test_search_all_assignments_rest_flattened(): response_value = Response() response_value.status_code = 200 # Convert return value to protobuf type - return_value = reservation.SearchAllAssignmentsResponse.pb(return_value) + return_value = reservation.ListCapacityCommitmentsResponse.pb(return_value) json_return_value = json_format.MessageToJson(return_value) response_value._content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.search_all_assignments(**mock_args) + client.list_capacity_commitments(**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/v1/{parent=projects/*/locations/*}:searchAllAssignments" + "%s/v1/{parent=projects/*/locations/*}/capacityCommitments" % client.transport._host, args[1], ) -def test_search_all_assignments_rest_flattened_error(transport: str = "rest"): +def test_list_capacity_commitments_rest_flattened_error(transport: str = "rest"): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport=transport, @@ -13314,14 +13856,13 @@ def test_search_all_assignments_rest_flattened_error(transport: str = "rest"): # Attempting to call a method with both a request object and flattened # fields is an error. with pytest.raises(ValueError): - client.search_all_assignments( - reservation.SearchAllAssignmentsRequest(), + client.list_capacity_commitments( + reservation.ListCapacityCommitmentsRequest(), parent="parent_value", - query="query_value", ) -def test_search_all_assignments_rest_pager(transport: str = "rest"): +def test_list_capacity_commitments_rest_pager(transport: str = "rest"): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport=transport, @@ -13333,28 +13874,28 @@ def test_search_all_assignments_rest_pager(transport: str = "rest"): # with mock.patch.object(path_template, 'transcode') as transcode: # Set the response as a series of pages response = ( - reservation.SearchAllAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), - reservation.Assignment(), + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[ + reservation.CapacityCommitment(), + reservation.CapacityCommitment(), + reservation.CapacityCommitment(), ], next_page_token="abc", ), - reservation.SearchAllAssignmentsResponse( - assignments=[], + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[], next_page_token="def", ), - reservation.SearchAllAssignmentsResponse( - assignments=[ - reservation.Assignment(), + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[ + reservation.CapacityCommitment(), ], next_page_token="ghi", ), - reservation.SearchAllAssignmentsResponse( - assignments=[ - reservation.Assignment(), - reservation.Assignment(), + reservation.ListCapacityCommitmentsResponse( + capacity_commitments=[ + reservation.CapacityCommitment(), + reservation.CapacityCommitment(), ], ), ) @@ -13363,7 +13904,7 @@ def test_search_all_assignments_rest_pager(transport: str = "rest"): # Wrap the values into proper Response objs response = tuple( - reservation.SearchAllAssignmentsResponse.to_json(x) for x in response + reservation.ListCapacityCommitmentsResponse.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): @@ -13373,18 +13914,18 @@ def test_search_all_assignments_rest_pager(transport: str = "rest"): sample_request = {"parent": "projects/sample1/locations/sample2"} - pager = client.search_all_assignments(request=sample_request) + pager = client.list_capacity_commitments(request=sample_request) results = list(pager) assert len(results) == 6 - assert all(isinstance(i, reservation.Assignment) for i in results) + assert all(isinstance(i, reservation.CapacityCommitment) for i in results) - pages = list(client.search_all_assignments(request=sample_request).pages) + pages = list(client.list_capacity_commitments(request=sample_request).pages) for page_, token in zip(pages, ["abc", "def", "ghi", ""]): assert page_.raw_page.next_page_token == token -def test_move_assignment_rest_use_cached_wrapped_rpc(): +def test_get_capacity_commitment_rest_use_cached_wrapped_rpc(): # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, # instead of constructing them on each call with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: @@ -13398,30 +13939,35 @@ def test_move_assignment_rest_use_cached_wrapped_rpc(): wrapper_fn.reset_mock() # Ensure method has been cached - assert client._transport.move_assignment in client._transport._wrapped_methods + assert ( + client._transport.get_capacity_commitment + in client._transport._wrapped_methods + ) # Replace cached wrapped function with mock mock_rpc = mock.Mock() mock_rpc.return_value.name = ( "foo" # operation_request.operation in compute client(s) expect a string. ) - client._transport._wrapped_methods[client._transport.move_assignment] = mock_rpc + client._transport._wrapped_methods[ + client._transport.get_capacity_commitment + ] = mock_rpc request = {} - client.move_assignment(request) + client.get_capacity_commitment(request) # Establish that the underlying gRPC stub method was called. assert mock_rpc.call_count == 1 - client.move_assignment(request) + client.get_capacity_commitment(request) # Establish that a new wrapper was not created for this call assert wrapper_fn.call_count == 0 assert mock_rpc.call_count == 2 -def test_move_assignment_rest_required_fields( - request_type=reservation.MoveAssignmentRequest, +def test_get_capacity_commitment_rest_required_fields( + request_type=reservation.GetCapacityCommitmentRequest, ): transport_class = transports.ReservationServiceRestTransport @@ -13437,7 +13983,7 @@ def test_move_assignment_rest_required_fields( unset_fields = transport_class( credentials=ga_credentials.AnonymousCredentials() - ).move_assignment._get_unset_required_fields(jsonified_request) + ).get_capacity_commitment._get_unset_required_fields(jsonified_request) jsonified_request.update(unset_fields) # verify required fields with default values are now present @@ -13446,7 +13992,7 @@ def test_move_assignment_rest_required_fields( unset_fields = transport_class( credentials=ga_credentials.AnonymousCredentials() - ).move_assignment._get_unset_required_fields(jsonified_request) + ).get_capacity_commitment._get_unset_required_fields(jsonified_request) jsonified_request.update(unset_fields) # verify required fields with non-default values are left alone @@ -13460,7 +14006,7 @@ def test_move_assignment_rest_required_fields( request = request_type(**request_init) # Designate an appropriate value for the returned response. - return_value = reservation.Assignment() + return_value = reservation.CapacityCommitment() # 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 @@ -13472,40 +14018,39 @@ def test_move_assignment_rest_required_fields( pb_request = request_type.pb(request) transcode_result = { "uri": "v1/sample_method", - "method": "post", + "method": "get", "query_params": pb_request, } - transcode_result["body"] = pb_request transcode.return_value = transcode_result response_value = Response() response_value.status_code = 200 # Convert return value to protobuf type - return_value = reservation.Assignment.pb(return_value) + return_value = reservation.CapacityCommitment.pb(return_value) json_return_value = json_format.MessageToJson(return_value) response_value._content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.move_assignment(request) + response = client.get_capacity_commitment(request) expected_params = [("$alt", "json;enum-encoding=int")] actual_params = req.call_args.kwargs["params"] assert expected_params == actual_params -def test_move_assignment_rest_unset_required_fields(): +def test_get_capacity_commitment_rest_unset_required_fields(): transport = transports.ReservationServiceRestTransport( credentials=ga_credentials.AnonymousCredentials ) - unset_fields = transport.move_assignment._get_unset_required_fields({}) + unset_fields = transport.get_capacity_commitment._get_unset_required_fields({}) assert set(unset_fields) == (set(()) & set(("name",))) -def test_move_assignment_rest_flattened(): +def test_get_capacity_commitment_rest_flattened(): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest", @@ -13514,17 +14059,16 @@ def test_move_assignment_rest_flattened(): # 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 = reservation.Assignment() + return_value = reservation.CapacityCommitment() # get arguments that satisfy an http rule for this method sample_request = { - "name": "projects/sample1/locations/sample2/reservations/sample3/assignments/sample4" + "name": "projects/sample1/locations/sample2/capacityCommitments/sample3" } # get truthy value for each flattened field mock_args = dict( name="name_value", - destination_id="destination_id_value", ) mock_args.update(sample_request) @@ -13532,26 +14076,26 @@ def test_move_assignment_rest_flattened(): response_value = Response() response_value.status_code = 200 # Convert return value to protobuf type - return_value = reservation.Assignment.pb(return_value) + return_value = reservation.CapacityCommitment.pb(return_value) json_return_value = json_format.MessageToJson(return_value) response_value._content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.move_assignment(**mock_args) + client.get_capacity_commitment(**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/v1/{name=projects/*/locations/*/reservations/*/assignments/*}:move" + "%s/v1/{name=projects/*/locations/*/capacityCommitments/*}" % client.transport._host, args[1], ) -def test_move_assignment_rest_flattened_error(transport: str = "rest"): +def test_get_capacity_commitment_rest_flattened_error(transport: str = "rest"): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport=transport, @@ -13560,14 +14104,13 @@ def test_move_assignment_rest_flattened_error(transport: str = "rest"): # Attempting to call a method with both a request object and flattened # fields is an error. with pytest.raises(ValueError): - client.move_assignment( - reservation.MoveAssignmentRequest(), + client.get_capacity_commitment( + reservation.GetCapacityCommitmentRequest(), name="name_value", - destination_id="destination_id_value", ) -def test_update_assignment_rest_use_cached_wrapped_rpc(): +def test_delete_capacity_commitment_rest_use_cached_wrapped_rpc(): # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, # instead of constructing them on each call with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: @@ -13581,7 +14124,10 @@ def test_update_assignment_rest_use_cached_wrapped_rpc(): wrapper_fn.reset_mock() # Ensure method has been cached - assert client._transport.update_assignment in client._transport._wrapped_methods + assert ( + client._transport.delete_capacity_commitment + in client._transport._wrapped_methods + ) # Replace cached wrapped function with mock mock_rpc = mock.Mock() @@ -13589,43 +14135,225 @@ def test_update_assignment_rest_use_cached_wrapped_rpc(): "foo" # operation_request.operation in compute client(s) expect a string. ) client._transport._wrapped_methods[ - client._transport.update_assignment + client._transport.delete_capacity_commitment ] = mock_rpc request = {} - client.update_assignment(request) + client.delete_capacity_commitment(request) # Establish that the underlying gRPC stub method was called. assert mock_rpc.call_count == 1 - client.update_assignment(request) + client.delete_capacity_commitment(request) # Establish that a new wrapper was not created for this call assert wrapper_fn.call_count == 0 assert mock_rpc.call_count == 2 -def test_update_assignment_rest_flattened(): +def test_delete_capacity_commitment_rest_required_fields( + request_type=reservation.DeleteCapacityCommitmentRequest, +): + transport_class = transports.ReservationServiceRestTransport + + 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, use_integers_for_enums=False) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_capacity_commitment._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_capacity_commitment._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("force",)) + 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 = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest", ) + request = request_type(**request_init) + # Designate an appropriate value for the returned response. + return_value = None # 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 = reservation.Assignment() - - # get arguments that satisfy an http rule for this method - sample_request = { - "assignment": { - "name": "projects/sample1/locations/sample2/reservations/sample3/assignments/sample4" + 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 = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.delete_capacity_commitment(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_delete_capacity_commitment_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.delete_capacity_commitment._get_unset_required_fields({}) + assert set(unset_fields) == (set(("force",)) & set(("name",))) + + +def test_delete_capacity_commitment_rest_flattened(): + client = ReservationServiceClient( + 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 = None + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/capacityCommitments/sample3" + } # get truthy value for each flattened field mock_args = dict( - assignment=reservation.Assignment(name="name_value"), + 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 = "" + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.delete_capacity_commitment(**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/v1/{name=projects/*/locations/*/capacityCommitments/*}" + % client.transport._host, + args[1], + ) + + +def test_delete_capacity_commitment_rest_flattened_error(transport: str = "rest"): + client = ReservationServiceClient( + 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_capacity_commitment( + reservation.DeleteCapacityCommitmentRequest(), + name="name_value", + ) + + +def test_update_capacity_commitment_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._transport.update_capacity_commitment + in client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.update_capacity_commitment + ] = mock_rpc + + request = {} + client.update_capacity_commitment(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.update_capacity_commitment(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_update_capacity_commitment_rest_flattened(): + client = ReservationServiceClient( + 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 = reservation.CapacityCommitment() + + # get arguments that satisfy an http rule for this method + sample_request = { + "capacity_commitment": { + "name": "projects/sample1/locations/sample2/capacityCommitments/sample3" + } + } + + # get truthy value for each flattened field + mock_args = dict( + capacity_commitment=reservation.CapacityCommitment(name="name_value"), update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), ) mock_args.update(sample_request) @@ -13634,26 +14362,26 @@ def test_update_assignment_rest_flattened(): response_value = Response() response_value.status_code = 200 # Convert return value to protobuf type - return_value = reservation.Assignment.pb(return_value) + return_value = reservation.CapacityCommitment.pb(return_value) json_return_value = json_format.MessageToJson(return_value) response_value._content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.update_assignment(**mock_args) + client.update_capacity_commitment(**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/v1/{assignment.name=projects/*/locations/*/reservations/*/assignments/*}" + "%s/v1/{capacity_commitment.name=projects/*/locations/*/capacityCommitments/*}" % client.transport._host, args[1], ) -def test_update_assignment_rest_flattened_error(transport: str = "rest"): +def test_update_capacity_commitment_rest_flattened_error(transport: str = "rest"): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport=transport, @@ -13662,14 +14390,14 @@ def test_update_assignment_rest_flattened_error(transport: str = "rest"): # Attempting to call a method with both a request object and flattened # fields is an error. with pytest.raises(ValueError): - client.update_assignment( - reservation.UpdateAssignmentRequest(), - assignment=reservation.Assignment(name="name_value"), + client.update_capacity_commitment( + reservation.UpdateCapacityCommitmentRequest(), + capacity_commitment=reservation.CapacityCommitment(name="name_value"), update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), ) -def test_get_bi_reservation_rest_use_cached_wrapped_rpc(): +def test_split_capacity_commitment_rest_use_cached_wrapped_rpc(): # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, # instead of constructing them on each call with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: @@ -13684,7 +14412,8 @@ def test_get_bi_reservation_rest_use_cached_wrapped_rpc(): # Ensure method has been cached assert ( - client._transport.get_bi_reservation in client._transport._wrapped_methods + client._transport.split_capacity_commitment + in client._transport._wrapped_methods ) # Replace cached wrapped function with mock @@ -13693,24 +14422,24 @@ def test_get_bi_reservation_rest_use_cached_wrapped_rpc(): "foo" # operation_request.operation in compute client(s) expect a string. ) client._transport._wrapped_methods[ - client._transport.get_bi_reservation + client._transport.split_capacity_commitment ] = mock_rpc request = {} - client.get_bi_reservation(request) + client.split_capacity_commitment(request) # Establish that the underlying gRPC stub method was called. assert mock_rpc.call_count == 1 - client.get_bi_reservation(request) + client.split_capacity_commitment(request) # Establish that a new wrapper was not created for this call assert wrapper_fn.call_count == 0 assert mock_rpc.call_count == 2 -def test_get_bi_reservation_rest_required_fields( - request_type=reservation.GetBiReservationRequest, +def test_split_capacity_commitment_rest_required_fields( + request_type=reservation.SplitCapacityCommitmentRequest, ): transport_class = transports.ReservationServiceRestTransport @@ -13726,7 +14455,7 @@ def test_get_bi_reservation_rest_required_fields( unset_fields = transport_class( credentials=ga_credentials.AnonymousCredentials() - ).get_bi_reservation._get_unset_required_fields(jsonified_request) + ).split_capacity_commitment._get_unset_required_fields(jsonified_request) jsonified_request.update(unset_fields) # verify required fields with default values are now present @@ -13735,7 +14464,7 @@ def test_get_bi_reservation_rest_required_fields( unset_fields = transport_class( credentials=ga_credentials.AnonymousCredentials() - ).get_bi_reservation._get_unset_required_fields(jsonified_request) + ).split_capacity_commitment._get_unset_required_fields(jsonified_request) jsonified_request.update(unset_fields) # verify required fields with non-default values are left alone @@ -13749,7 +14478,7 @@ def test_get_bi_reservation_rest_required_fields( request = request_type(**request_init) # Designate an appropriate value for the returned response. - return_value = reservation.BiReservation() + return_value = reservation.SplitCapacityCommitmentResponse() # 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 @@ -13761,39 +14490,40 @@ def test_get_bi_reservation_rest_required_fields( pb_request = request_type.pb(request) transcode_result = { "uri": "v1/sample_method", - "method": "get", + "method": "post", "query_params": pb_request, } + transcode_result["body"] = pb_request transcode.return_value = transcode_result response_value = Response() response_value.status_code = 200 # Convert return value to protobuf type - return_value = reservation.BiReservation.pb(return_value) + return_value = reservation.SplitCapacityCommitmentResponse.pb(return_value) json_return_value = json_format.MessageToJson(return_value) response_value._content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.get_bi_reservation(request) + response = client.split_capacity_commitment(request) expected_params = [("$alt", "json;enum-encoding=int")] actual_params = req.call_args.kwargs["params"] assert expected_params == actual_params -def test_get_bi_reservation_rest_unset_required_fields(): +def test_split_capacity_commitment_rest_unset_required_fields(): transport = transports.ReservationServiceRestTransport( credentials=ga_credentials.AnonymousCredentials ) - unset_fields = transport.get_bi_reservation._get_unset_required_fields({}) + unset_fields = transport.split_capacity_commitment._get_unset_required_fields({}) assert set(unset_fields) == (set(()) & set(("name",))) -def test_get_bi_reservation_rest_flattened(): +def test_split_capacity_commitment_rest_flattened(): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest", @@ -13802,14 +14532,17 @@ def test_get_bi_reservation_rest_flattened(): # 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 = reservation.BiReservation() + return_value = reservation.SplitCapacityCommitmentResponse() # get arguments that satisfy an http rule for this method - sample_request = {"name": "projects/sample1/locations/sample2/biReservation"} + sample_request = { + "name": "projects/sample1/locations/sample2/capacityCommitments/sample3" + } # get truthy value for each flattened field mock_args = dict( name="name_value", + slot_count=1098, ) mock_args.update(sample_request) @@ -13817,26 +14550,26 @@ def test_get_bi_reservation_rest_flattened(): response_value = Response() response_value.status_code = 200 # Convert return value to protobuf type - return_value = reservation.BiReservation.pb(return_value) + return_value = reservation.SplitCapacityCommitmentResponse.pb(return_value) json_return_value = json_format.MessageToJson(return_value) response_value._content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.get_bi_reservation(**mock_args) + client.split_capacity_commitment(**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/v1/{name=projects/*/locations/*/biReservation}" + "%s/v1/{name=projects/*/locations/*/capacityCommitments/*}:split" % client.transport._host, args[1], ) -def test_get_bi_reservation_rest_flattened_error(transport: str = "rest"): +def test_split_capacity_commitment_rest_flattened_error(transport: str = "rest"): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport=transport, @@ -13845,13 +14578,14 @@ def test_get_bi_reservation_rest_flattened_error(transport: str = "rest"): # Attempting to call a method with both a request object and flattened # fields is an error. with pytest.raises(ValueError): - client.get_bi_reservation( - reservation.GetBiReservationRequest(), + client.split_capacity_commitment( + reservation.SplitCapacityCommitmentRequest(), name="name_value", + slot_count=1098, ) -def test_update_bi_reservation_rest_use_cached_wrapped_rpc(): +def test_merge_capacity_commitments_rest_use_cached_wrapped_rpc(): # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, # instead of constructing them on each call with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: @@ -13866,7 +14600,7 @@ def test_update_bi_reservation_rest_use_cached_wrapped_rpc(): # Ensure method has been cached assert ( - client._transport.update_bi_reservation + client._transport.merge_capacity_commitments in client._transport._wrapped_methods ) @@ -13876,23 +14610,23 @@ def test_update_bi_reservation_rest_use_cached_wrapped_rpc(): "foo" # operation_request.operation in compute client(s) expect a string. ) client._transport._wrapped_methods[ - client._transport.update_bi_reservation + client._transport.merge_capacity_commitments ] = mock_rpc request = {} - client.update_bi_reservation(request) + client.merge_capacity_commitments(request) # Establish that the underlying gRPC stub method was called. assert mock_rpc.call_count == 1 - client.update_bi_reservation(request) + client.merge_capacity_commitments(request) # Establish that a new wrapper was not created for this call assert wrapper_fn.call_count == 0 assert mock_rpc.call_count == 2 -def test_update_bi_reservation_rest_flattened(): +def test_merge_capacity_commitments_rest_flattened(): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest", @@ -13901,19 +14635,15 @@ def test_update_bi_reservation_rest_flattened(): # 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 = reservation.BiReservation() + return_value = reservation.CapacityCommitment() # get arguments that satisfy an http rule for this method - sample_request = { - "bi_reservation": { - "name": "projects/sample1/locations/sample2/biReservation" - } - } + sample_request = {"parent": "projects/sample1/locations/sample2"} # get truthy value for each flattened field mock_args = dict( - bi_reservation=reservation.BiReservation(name="name_value"), - update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + parent="parent_value", + capacity_commitment_ids=["capacity_commitment_ids_value"], ) mock_args.update(sample_request) @@ -13921,26 +14651,26 @@ def test_update_bi_reservation_rest_flattened(): response_value = Response() response_value.status_code = 200 # Convert return value to protobuf type - return_value = reservation.BiReservation.pb(return_value) + return_value = reservation.CapacityCommitment.pb(return_value) json_return_value = json_format.MessageToJson(return_value) response_value._content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.update_bi_reservation(**mock_args) + client.merge_capacity_commitments(**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/v1/{bi_reservation.name=projects/*/locations/*/biReservation}" + "%s/v1/{parent=projects/*/locations/*}/capacityCommitments:merge" % client.transport._host, args[1], ) -def test_update_bi_reservation_rest_flattened_error(transport: str = "rest"): +def test_merge_capacity_commitments_rest_flattened_error(transport: str = "rest"): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport=transport, @@ -13949,1220 +14679,4417 @@ def test_update_bi_reservation_rest_flattened_error(transport: str = "rest"): # Attempting to call a method with both a request object and flattened # fields is an error. with pytest.raises(ValueError): - client.update_bi_reservation( - reservation.UpdateBiReservationRequest(), - bi_reservation=reservation.BiReservation(name="name_value"), - update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + client.merge_capacity_commitments( + reservation.MergeCapacityCommitmentsRequest(), + parent="parent_value", + capacity_commitment_ids=["capacity_commitment_ids_value"], ) -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.ReservationServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): +def test_create_assignment_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # It is an error to provide a credentials file and a transport instance. - transport = transports.ReservationServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = ReservationServiceClient( - client_options={"credentials_file": "credentials.json"}, - transport=transport, + transport="rest", ) - # It is an error to provide an api_key and a transport instance. - transport = transports.ReservationServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - options = client_options.ClientOptions() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = ReservationServiceClient( - client_options=options, - transport=transport, - ) + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() - # It is an error to provide an api_key and a credential. - options = client_options.ClientOptions() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = ReservationServiceClient( - client_options=options, credentials=ga_credentials.AnonymousCredentials() - ) + # Ensure method has been cached + assert client._transport.create_assignment in client._transport._wrapped_methods - # It is an error to provide scopes and a transport instance. - transport = transports.ReservationServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = ReservationServiceClient( - client_options={"scopes": ["1", "2"]}, - transport=transport, + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. ) + client._transport._wrapped_methods[ + client._transport.create_assignment + ] = mock_rpc + request = {} + client.create_assignment(request) -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.ReservationServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - client = ReservationServiceClient(transport=transport) - assert client.transport is transport + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + client.create_assignment(request) -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.ReservationServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 - transport = transports.ReservationServiceGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel +def test_create_assignment_rest_required_fields( + request_type=reservation.CreateAssignmentRequest, +): + transport_class = transports.ReservationServiceRestTransport -@pytest.mark.parametrize( - "transport_class", - [ - transports.ReservationServiceGrpcTransport, - transports.ReservationServiceGrpcAsyncIOTransport, - transports.ReservationServiceRestTransport, - ], -) -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() + 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, use_integers_for_enums=False) + ) + # verify fields with default values are dropped -def test_transport_kind_grpc(): - transport = ReservationServiceClient.get_transport_class("grpc")( + unset_fields = transport_class( credentials=ga_credentials.AnonymousCredentials() - ) - assert transport.kind == "grpc" + ).create_assignment._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + # verify required fields with default values are now present -def test_initialize_client_w_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), transport="grpc" - ) - assert client is not None + jsonified_request["parent"] = "parent_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).create_assignment._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("assignment_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" -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_create_reservation_empty_call_grpc(): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", + transport="rest", ) + request = request_type(**request_init) - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.create_reservation), "__call__" - ) as call: - call.return_value = gcbr_reservation.Reservation() - client.create_reservation(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = gcbr_reservation.CreateReservationRequest() - - assert args[0] == request_msg + # Designate an appropriate value for the returned response. + return_value = reservation.Assignment() + # 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 -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_list_reservations_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) + # Convert return value to protobuf type + return_value = reservation.Assignment.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.list_reservations), "__call__" - ) as call: - call.return_value = reservation.ListReservationsResponse() - client.list_reservations(request=None) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.ListReservationsRequest() + response = client.create_assignment(request) - assert args[0] == request_msg + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_get_reservation_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", +def test_create_assignment_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials ) - # Mock the actual call, and fake the request. - with mock.patch.object(type(client.transport.get_reservation), "__call__") as call: - call.return_value = reservation.Reservation() - client.get_reservation(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.GetReservationRequest() - - assert args[0] == request_msg + unset_fields = transport.create_assignment._get_unset_required_fields({}) + assert set(unset_fields) == (set(("assignmentId",)) & set(("parent",))) -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_delete_reservation_empty_call_grpc(): +def test_create_assignment_rest_flattened(): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", + transport="rest", ) - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.delete_reservation), "__call__" - ) as call: - call.return_value = None - client.delete_reservation(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.DeleteReservationRequest() + # 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 = reservation.Assignment() - assert args[0] == request_msg + # get arguments that satisfy an http rule for this method + sample_request = { + "parent": "projects/sample1/locations/sample2/reservations/sample3" + } + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + assignment=reservation.Assignment(name="name_value"), + ) + mock_args.update(sample_request) -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_update_reservation_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.update_reservation), "__call__" - ) as call: - call.return_value = gcbr_reservation.Reservation() - client.update_reservation(request=None) + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = reservation.Assignment.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = gcbr_reservation.UpdateReservationRequest() + client.create_assignment(**mock_args) - assert args[0] == request_msg + # 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/v1/{parent=projects/*/locations/*/reservations/*}/assignments" + % client.transport._host, + args[1], + ) -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_failover_reservation_empty_call_grpc(): +def test_create_assignment_rest_flattened_error(transport: str = "rest"): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", + transport=transport, ) - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.failover_reservation), "__call__" - ) as call: - call.return_value = reservation.Reservation() - client.failover_reservation(request=None) + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_assignment( + reservation.CreateAssignmentRequest(), + parent="parent_value", + assignment=reservation.Assignment(name="name_value"), + ) - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.FailoverReservationRequest() - assert args[0] == request_msg +def test_list_assignments_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_create_capacity_commitment_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) + # Ensure method has been cached + assert client._transport.list_assignments in client._transport._wrapped_methods - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.create_capacity_commitment), "__call__" - ) as call: - call.return_value = reservation.CapacityCommitment() - client.create_capacity_commitment(request=None) + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.list_assignments + ] = mock_rpc - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.CreateCapacityCommitmentRequest() + request = {} + client.list_assignments(request) - assert args[0] == request_msg + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + client.list_assignments(request) -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_list_capacity_commitments_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_list_assignments_rest_required_fields( + request_type=reservation.ListAssignmentsRequest, +): + transport_class = transports.ReservationServiceRestTransport + + 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, use_integers_for_enums=False) ) - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.list_capacity_commitments), "__call__" - ) as call: - call.return_value = reservation.ListCapacityCommitmentsResponse() - client.list_capacity_commitments(request=None) + # verify fields with default values are dropped - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.ListCapacityCommitmentsRequest() + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_assignments._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) - assert args[0] == request_msg + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_assignments._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" -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_get_capacity_commitment_empty_call_grpc(): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", + transport="rest", ) + request = request_type(**request_init) - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.get_capacity_commitment), "__call__" - ) as call: - call.return_value = reservation.CapacityCommitment() - client.get_capacity_commitment(request=None) + # Designate an appropriate value for the returned response. + return_value = reservation.ListAssignmentsResponse() + # 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 - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.GetCapacityCommitmentRequest() + response_value = Response() + response_value.status_code = 200 - assert args[0] == request_msg + # Convert return value to protobuf type + return_value = reservation.ListAssignmentsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_delete_capacity_commitment_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) + response = client.list_assignments(request) - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.delete_capacity_commitment), "__call__" - ) as call: - call.return_value = None - client.delete_capacity_commitment(request=None) + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.DeleteCapacityCommitmentRequest() - assert args[0] == request_msg +def test_list_assignments_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + unset_fields = transport.list_assignments._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "pageSize", + "pageToken", + ) + ) + & set(("parent",)) + ) -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_update_capacity_commitment_empty_call_grpc(): + +def test_list_assignments_rest_flattened(): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", + transport="rest", ) - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.update_capacity_commitment), "__call__" - ) as call: - call.return_value = reservation.CapacityCommitment() - client.update_capacity_commitment(request=None) + # 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 = reservation.ListAssignmentsResponse() - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.UpdateCapacityCommitmentRequest() + # get arguments that satisfy an http rule for this method + sample_request = { + "parent": "projects/sample1/locations/sample2/reservations/sample3" + } - assert args[0] == request_msg + # 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 + # Convert return value to protobuf type + return_value = reservation.ListAssignmentsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.list_assignments(**mock_args) -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_split_capacity_commitment_empty_call_grpc(): + # 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/v1/{parent=projects/*/locations/*/reservations/*}/assignments" + % client.transport._host, + args[1], + ) + + +def test_list_assignments_rest_flattened_error(transport: str = "rest"): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", + transport=transport, ) - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.split_capacity_commitment), "__call__" - ) as call: - call.return_value = reservation.SplitCapacityCommitmentResponse() - client.split_capacity_commitment(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.SplitCapacityCommitmentRequest() - - assert args[0] == request_msg + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_assignments( + reservation.ListAssignmentsRequest(), + parent="parent_value", + ) -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_merge_capacity_commitments_empty_call_grpc(): +def test_list_assignments_rest_pager(transport: str = "rest"): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", + transport=transport, ) - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.merge_capacity_commitments), "__call__" - ) as call: - call.return_value = reservation.CapacityCommitment() - client.merge_capacity_commitments(request=None) + # 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 = ( + reservation.ListAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + reservation.Assignment(), + ], + next_page_token="abc", + ), + reservation.ListAssignmentsResponse( + assignments=[], + next_page_token="def", + ), + reservation.ListAssignmentsResponse( + assignments=[ + reservation.Assignment(), + ], + next_page_token="ghi", + ), + reservation.ListAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + ], + ), + ) + # Two responses for two calls + response = response + response - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.MergeCapacityCommitmentsRequest() + # Wrap the values into proper Response objs + response = tuple( + reservation.ListAssignmentsResponse.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 - assert args[0] == request_msg + sample_request = { + "parent": "projects/sample1/locations/sample2/reservations/sample3" + } + pager = client.list_assignments(request=sample_request) -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_create_assignment_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, reservation.Assignment) for i in results) - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.create_assignment), "__call__" - ) as call: - call.return_value = reservation.Assignment() - client.create_assignment(request=None) + pages = list(client.list_assignments(request=sample_request).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.CreateAssignmentRequest() - assert args[0] == request_msg +def test_delete_assignment_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_list_assignments_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) + # Ensure method has been cached + assert client._transport.delete_assignment in client._transport._wrapped_methods - # Mock the actual call, and fake the request. - with mock.patch.object(type(client.transport.list_assignments), "__call__") as call: - call.return_value = reservation.ListAssignmentsResponse() - client.list_assignments(request=None) + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.delete_assignment + ] = mock_rpc - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.ListAssignmentsRequest() + request = {} + client.delete_assignment(request) - assert args[0] == request_msg + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + client.delete_assignment(request) -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_delete_assignment_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.delete_assignment), "__call__" - ) as call: - call.return_value = None - client.delete_assignment(request=None) - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.DeleteAssignmentRequest() +def test_delete_assignment_rest_required_fields( + request_type=reservation.DeleteAssignmentRequest, +): + transport_class = transports.ReservationServiceRestTransport - assert args[0] == request_msg + 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, use_integers_for_enums=False) + ) + # verify fields with default values are dropped -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_search_assignments_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_assignment._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.search_assignments), "__call__" - ) as call: - call.return_value = reservation.SearchAssignmentsResponse() - client.search_assignments(request=None) + # verify required fields with default values are now present - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.SearchAssignmentsRequest() + jsonified_request["name"] = "name_value" - assert args[0] == request_msg + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_assignment._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" -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_search_all_assignments_empty_call_grpc(): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", + transport="rest", ) + request = request_type(**request_init) - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.search_all_assignments), "__call__" - ) as call: - call.return_value = reservation.SearchAllAssignmentsResponse() - client.search_all_assignments(request=None) + # Designate an appropriate value for the returned response. + return_value = None + # 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 - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.SearchAllAssignmentsRequest() + response_value = Response() + response_value.status_code = 200 + json_return_value = "" - assert args[0] == request_msg + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.delete_assignment(request) -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_move_assignment_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params - # Mock the actual call, and fake the request. - with mock.patch.object(type(client.transport.move_assignment), "__call__") as call: - call.return_value = reservation.Assignment() - client.move_assignment(request=None) - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.MoveAssignmentRequest() +def test_delete_assignment_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) - assert args[0] == request_msg + unset_fields = transport.delete_assignment._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_update_assignment_empty_call_grpc(): +def test_delete_assignment_rest_flattened(): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", + transport="rest", ) - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.update_assignment), "__call__" - ) as call: - call.return_value = reservation.Assignment() - client.update_assignment(request=None) + # 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 - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.UpdateAssignmentRequest() + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/reservations/sample3/assignments/sample4" + } - assert args[0] == request_msg + # 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 = "" + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.delete_assignment(**mock_args) -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_get_bi_reservation_empty_call_grpc(): + # 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/v1/{name=projects/*/locations/*/reservations/*/assignments/*}" + % client.transport._host, + args[1], + ) + + +def test_delete_assignment_rest_flattened_error(transport: str = "rest"): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", + transport=transport, ) - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.get_bi_reservation), "__call__" - ) as call: - call.return_value = reservation.BiReservation() - client.get_bi_reservation(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.GetBiReservationRequest() + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_assignment( + reservation.DeleteAssignmentRequest(), + name="name_value", + ) - assert args[0] == request_msg +def test_search_assignments_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_update_bi_reservation_empty_call_grpc(): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.update_bi_reservation), "__call__" - ) as call: - call.return_value = reservation.BiReservation() - client.update_bi_reservation(request=None) + # Ensure method has been cached + assert ( + client._transport.search_assignments in client._transport._wrapped_methods + ) - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.UpdateBiReservationRequest() + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.search_assignments + ] = mock_rpc - assert args[0] == request_msg + request = {} + client.search_assignments(request) + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 -def test_transport_kind_grpc_asyncio(): - transport = ReservationServiceAsyncClient.get_transport_class("grpc_asyncio")( - credentials=async_anonymous_credentials() - ) - assert transport.kind == "grpc_asyncio" + client.search_assignments(request) + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 -def test_initialize_client_w_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), transport="grpc_asyncio" - ) - assert client is not None +def test_search_assignments_rest_required_fields( + request_type=reservation.SearchAssignmentsRequest, +): + transport_class = transports.ReservationServiceRestTransport -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_create_reservation_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", + 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, use_integers_for_enums=False) ) - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.create_reservation), "__call__" - ) as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - gcbr_reservation.Reservation( - name="name_value", - slot_capacity=1391, - ignore_idle_slots=True, - concurrency=1195, - multi_region_auxiliary=True, - edition=gcbr_reservation.Edition.STANDARD, - primary_location="primary_location_value", - secondary_location="secondary_location_value", - original_primary_location="original_primary_location_value", - max_slots=986, - scaling_mode=gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, - ) - ) - await client.create_reservation(request=None) + # verify fields with default values are dropped - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = gcbr_reservation.CreateReservationRequest() + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).search_assignments._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) - assert args[0] == request_msg + # verify required fields with default values are now present + jsonified_request["parent"] = "parent_value" -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_list_reservations_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.list_reservations), "__call__" - ) as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - reservation.ListReservationsResponse( - next_page_token="next_page_token_value", - ) + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).search_assignments._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", + "query", ) - await client.list_reservations(request=None) + ) + jsonified_request.update(unset_fields) - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.ListReservationsRequest() + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" - assert args[0] == request_msg + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + # Designate an appropriate value for the returned response. + return_value = reservation.SearchAssignmentsResponse() + # 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 -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_get_reservation_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) + response_value = Response() + response_value.status_code = 200 - # Mock the actual call, and fake the request. - with mock.patch.object(type(client.transport.get_reservation), "__call__") as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - reservation.Reservation( - name="name_value", - slot_capacity=1391, - ignore_idle_slots=True, - concurrency=1195, - multi_region_auxiliary=True, - edition=reservation.Edition.STANDARD, - primary_location="primary_location_value", - secondary_location="secondary_location_value", - original_primary_location="original_primary_location_value", - max_slots=986, - scaling_mode=reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, - ) - ) - await client.get_reservation(request=None) + # Convert return value to protobuf type + return_value = reservation.SearchAssignmentsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.GetReservationRequest() + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - assert args[0] == request_msg + response = client.search_assignments(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_delete_reservation_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", +def test_search_assignments_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials ) - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.delete_reservation), "__call__" - ) as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - await client.delete_reservation(request=None) + unset_fields = transport.search_assignments._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "pageSize", + "pageToken", + "query", + ) + ) + & set(("parent",)) + ) - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.DeleteReservationRequest() - assert args[0] == request_msg +def test_search_assignments_rest_flattened(): + client = ReservationServiceClient( + 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 = reservation.SearchAssignmentsResponse() -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_update_reservation_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) + # get arguments that satisfy an http rule for this method + sample_request = {"parent": "projects/sample1/locations/sample2"} - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.update_reservation), "__call__" - ) as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - gcbr_reservation.Reservation( - name="name_value", - slot_capacity=1391, - ignore_idle_slots=True, - concurrency=1195, - multi_region_auxiliary=True, - edition=gcbr_reservation.Edition.STANDARD, - primary_location="primary_location_value", - secondary_location="secondary_location_value", - original_primary_location="original_primary_location_value", - max_slots=986, - scaling_mode=gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, - ) + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + query="query_value", ) - await client.update_reservation(request=None) + mock_args.update(sample_request) - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = gcbr_reservation.UpdateReservationRequest() + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = reservation.SearchAssignmentsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - assert args[0] == request_msg + client.search_assignments(**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/v1/{parent=projects/*/locations/*}:searchAssignments" + % client.transport._host, + args[1], + ) -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_failover_reservation_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", +def test_search_assignments_rest_flattened_error(transport: str = "rest"): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.failover_reservation), "__call__" - ) as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - reservation.Reservation( - name="name_value", - slot_capacity=1391, - ignore_idle_slots=True, - concurrency=1195, - multi_region_auxiliary=True, - edition=reservation.Edition.STANDARD, - primary_location="primary_location_value", - secondary_location="secondary_location_value", - original_primary_location="original_primary_location_value", - max_slots=986, - scaling_mode=reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, - ) + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.search_assignments( + reservation.SearchAssignmentsRequest(), + parent="parent_value", + query="query_value", ) - await client.failover_reservation(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.FailoverReservationRequest() - - assert args[0] == request_msg -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_create_capacity_commitment_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", +def test_search_assignments_rest_pager(transport: str = "rest"): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.create_capacity_commitment), "__call__" - ) as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - reservation.CapacityCommitment( - name="name_value", - slot_count=1098, - plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - state=reservation.CapacityCommitment.State.PENDING, - renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - multi_region_auxiliary=True, - edition=reservation.Edition.STANDARD, - is_flat_rate=True, - ) + # 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 = ( + reservation.SearchAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + reservation.Assignment(), + ], + next_page_token="abc", + ), + reservation.SearchAssignmentsResponse( + assignments=[], + next_page_token="def", + ), + reservation.SearchAssignmentsResponse( + assignments=[ + reservation.Assignment(), + ], + next_page_token="ghi", + ), + reservation.SearchAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + ], + ), ) - await client.create_capacity_commitment(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.CreateCapacityCommitmentRequest() + # Two responses for two calls + response = response + response - assert args[0] == request_msg + # Wrap the values into proper Response objs + response = tuple( + reservation.SearchAssignmentsResponse.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"} -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_list_capacity_commitments_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) + pager = client.search_assignments(request=sample_request) - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.list_capacity_commitments), "__call__" - ) as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - reservation.ListCapacityCommitmentsResponse( - next_page_token="next_page_token_value", - ) - ) - await client.list_capacity_commitments(request=None) + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, reservation.Assignment) for i in results) - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.ListCapacityCommitmentsRequest() + pages = list(client.search_assignments(request=sample_request).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token - assert args[0] == request_msg +def test_search_all_assignments_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_get_capacity_commitment_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.get_capacity_commitment), "__call__" - ) as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - reservation.CapacityCommitment( - name="name_value", - slot_count=1098, - plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - state=reservation.CapacityCommitment.State.PENDING, - renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - multi_region_auxiliary=True, - edition=reservation.Edition.STANDARD, - is_flat_rate=True, - ) + # Ensure method has been cached + assert ( + client._transport.search_all_assignments + in client._transport._wrapped_methods ) - await client.get_capacity_commitment(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.GetCapacityCommitmentRequest() - assert args[0] == request_msg + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.search_all_assignments + ] = mock_rpc + request = {} + client.search_all_assignments(request) -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_delete_capacity_commitment_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.delete_capacity_commitment), "__call__" - ) as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - await client.delete_capacity_commitment(request=None) + client.search_all_assignments(request) - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.DeleteCapacityCommitmentRequest() + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 - assert args[0] == request_msg +def test_search_all_assignments_rest_required_fields( + request_type=reservation.SearchAllAssignmentsRequest, +): + transport_class = transports.ReservationServiceRestTransport -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_update_capacity_commitment_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", + 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, use_integers_for_enums=False) ) - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.update_capacity_commitment), "__call__" - ) as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - reservation.CapacityCommitment( - name="name_value", - slot_count=1098, - plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - state=reservation.CapacityCommitment.State.PENDING, - renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - multi_region_auxiliary=True, - edition=reservation.Edition.STANDARD, - is_flat_rate=True, - ) - ) - await client.update_capacity_commitment(request=None) + # verify fields with default values are dropped - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.UpdateCapacityCommitmentRequest() + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).search_all_assignments._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) - assert args[0] == request_msg + # verify required fields with default values are now present + jsonified_request["parent"] = "parent_value" -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_split_capacity_commitment_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).search_all_assignments._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", + "query", + ) ) + jsonified_request.update(unset_fields) - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.split_capacity_commitment), "__call__" - ) as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - reservation.SplitCapacityCommitmentResponse() - ) - await client.split_capacity_commitment(request=None) + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.SplitCapacityCommitmentRequest() - - assert args[0] == request_msg - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_merge_capacity_commitments_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", ) + request = request_type(**request_init) - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.merge_capacity_commitments), "__call__" - ) as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - reservation.CapacityCommitment( - name="name_value", - slot_count=1098, - plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - state=reservation.CapacityCommitment.State.PENDING, - renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - multi_region_auxiliary=True, - edition=reservation.Edition.STANDARD, - is_flat_rate=True, - ) - ) - await client.merge_capacity_commitments(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.MergeCapacityCommitmentsRequest() - - assert args[0] == request_msg + # Designate an appropriate value for the returned response. + return_value = reservation.SearchAllAssignmentsResponse() + # 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 -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_create_assignment_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) + # Convert return value to protobuf type + return_value = reservation.SearchAllAssignmentsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.create_assignment), "__call__" - ) as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - reservation.Assignment( - name="name_value", - assignee="assignee_value", - job_type=reservation.Assignment.JobType.PIPELINE, - state=reservation.Assignment.State.PENDING, - enable_gemini_in_bigquery=True, - ) - ) - await client.create_assignment(request=None) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.CreateAssignmentRequest() + response = client.search_all_assignments(request) - assert args[0] == request_msg + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_list_assignments_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", +def test_search_all_assignments_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials ) - # Mock the actual call, and fake the request. - with mock.patch.object(type(client.transport.list_assignments), "__call__") as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - reservation.ListAssignmentsResponse( - next_page_token="next_page_token_value", + unset_fields = transport.search_all_assignments._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "pageSize", + "pageToken", + "query", ) ) - await client.list_assignments(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.ListAssignmentsRequest() - - assert args[0] == request_msg + & set(("parent",)) + ) -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_delete_assignment_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", +def test_search_all_assignments_rest_flattened(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", ) - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.delete_assignment), "__call__" - ) as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - await client.delete_assignment(request=None) + # 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 = reservation.SearchAllAssignmentsResponse() - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.DeleteAssignmentRequest() + # get arguments that satisfy an http rule for this method + sample_request = {"parent": "projects/sample1/locations/sample2"} - assert args[0] == request_msg + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + query="query_value", + ) + mock_args.update(sample_request) + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = reservation.SearchAllAssignmentsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_search_assignments_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) + client.search_all_assignments(**mock_args) - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.search_assignments), "__call__" - ) as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - reservation.SearchAssignmentsResponse( - next_page_token="next_page_token_value", - ) + # 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/v1/{parent=projects/*/locations/*}:searchAllAssignments" + % client.transport._host, + args[1], ) - await client.search_assignments(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.SearchAssignmentsRequest() - - assert args[0] == request_msg -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_search_all_assignments_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", +def test_search_all_assignments_rest_flattened_error(transport: str = "rest"): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.search_all_assignments), "__call__" - ) as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - reservation.SearchAllAssignmentsResponse( - next_page_token="next_page_token_value", - ) + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.search_all_assignments( + reservation.SearchAllAssignmentsRequest(), + parent="parent_value", + query="query_value", ) - await client.search_all_assignments(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.SearchAllAssignmentsRequest() - - assert args[0] == request_msg -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_move_assignment_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", +def test_search_all_assignments_rest_pager(transport: str = "rest"): + client = ReservationServiceClient( + 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 = ( + reservation.SearchAllAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + reservation.Assignment(), + ], + next_page_token="abc", + ), + reservation.SearchAllAssignmentsResponse( + assignments=[], + next_page_token="def", + ), + reservation.SearchAllAssignmentsResponse( + assignments=[ + reservation.Assignment(), + ], + next_page_token="ghi", + ), + reservation.SearchAllAssignmentsResponse( + assignments=[ + reservation.Assignment(), + reservation.Assignment(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple( + reservation.SearchAllAssignmentsResponse.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.search_all_assignments(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, reservation.Assignment) for i in results) + + pages = list(client.search_all_assignments(request=sample_request).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +def test_move_assignment_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.move_assignment in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[client._transport.move_assignment] = mock_rpc + + request = {} + client.move_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.move_assignment(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_move_assignment_rest_required_fields( + request_type=reservation.MoveAssignmentRequest, +): + transport_class = transports.ReservationServiceRestTransport + + 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, use_integers_for_enums=False) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).move_assignment._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() + ).move_assignment._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 = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = reservation.Assignment() + # 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 + + # Convert return value to protobuf type + return_value = reservation.Assignment.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.move_assignment(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_move_assignment_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.move_assignment._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +def test_move_assignment_rest_flattened(): + client = ReservationServiceClient( + 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 = reservation.Assignment() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/reservations/sample3/assignments/sample4" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + destination_id="destination_id_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = reservation.Assignment.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.move_assignment(**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/v1/{name=projects/*/locations/*/reservations/*/assignments/*}:move" + % client.transport._host, + args[1], + ) + + +def test_move_assignment_rest_flattened_error(transport: str = "rest"): + client = ReservationServiceClient( + 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.move_assignment( + reservation.MoveAssignmentRequest(), + name="name_value", + destination_id="destination_id_value", + ) + + +def test_update_assignment_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.update_assignment in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.update_assignment + ] = mock_rpc + + request = {} + client.update_assignment(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.update_assignment(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_update_assignment_rest_flattened(): + client = ReservationServiceClient( + 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 = reservation.Assignment() + + # get arguments that satisfy an http rule for this method + sample_request = { + "assignment": { + "name": "projects/sample1/locations/sample2/reservations/sample3/assignments/sample4" + } + } + + # get truthy value for each flattened field + mock_args = dict( + assignment=reservation.Assignment(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 + # Convert return value to protobuf type + return_value = reservation.Assignment.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.update_assignment(**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/v1/{assignment.name=projects/*/locations/*/reservations/*/assignments/*}" + % client.transport._host, + args[1], + ) + + +def test_update_assignment_rest_flattened_error(transport: str = "rest"): + client = ReservationServiceClient( + 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_assignment( + reservation.UpdateAssignmentRequest(), + assignment=reservation.Assignment(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +def test_get_bi_reservation_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._transport.get_bi_reservation in client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.get_bi_reservation + ] = mock_rpc + + request = {} + client.get_bi_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.get_bi_reservation(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_get_bi_reservation_rest_required_fields( + request_type=reservation.GetBiReservationRequest, +): + transport_class = transports.ReservationServiceRestTransport + + 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, use_integers_for_enums=False) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_bi_reservation._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_bi_reservation._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 = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = reservation.BiReservation() + # 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 + + # Convert return value to protobuf type + return_value = reservation.BiReservation.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.get_bi_reservation(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_get_bi_reservation_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.get_bi_reservation._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +def test_get_bi_reservation_rest_flattened(): + client = ReservationServiceClient( + 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 = reservation.BiReservation() + + # get arguments that satisfy an http rule for this method + sample_request = {"name": "projects/sample1/locations/sample2/biReservation"} + + # 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 + # Convert return value to protobuf type + return_value = reservation.BiReservation.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.get_bi_reservation(**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/v1/{name=projects/*/locations/*/biReservation}" + % client.transport._host, + args[1], + ) + + +def test_get_bi_reservation_rest_flattened_error(transport: str = "rest"): + client = ReservationServiceClient( + 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_bi_reservation( + reservation.GetBiReservationRequest(), + name="name_value", + ) + + +def test_update_bi_reservation_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._transport.update_bi_reservation + in client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.update_bi_reservation + ] = mock_rpc + + request = {} + client.update_bi_reservation(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.update_bi_reservation(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_update_bi_reservation_rest_flattened(): + client = ReservationServiceClient( + 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 = reservation.BiReservation() + + # get arguments that satisfy an http rule for this method + sample_request = { + "bi_reservation": { + "name": "projects/sample1/locations/sample2/biReservation" + } + } + + # get truthy value for each flattened field + mock_args = dict( + bi_reservation=reservation.BiReservation(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 + # Convert return value to protobuf type + return_value = reservation.BiReservation.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.update_bi_reservation(**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/v1/{bi_reservation.name=projects/*/locations/*/biReservation}" + % client.transport._host, + args[1], + ) + + +def test_update_bi_reservation_rest_flattened_error(transport: str = "rest"): + client = ReservationServiceClient( + 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_bi_reservation( + reservation.UpdateBiReservationRequest(), + bi_reservation=reservation.BiReservation(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +def test_get_iam_policy_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.get_iam_policy in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[client._transport.get_iam_policy] = mock_rpc + + request = {} + client.get_iam_policy(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.get_iam_policy(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_get_iam_policy_rest_required_fields( + request_type=iam_policy_pb2.GetIamPolicyRequest, +): + transport_class = transports.ReservationServiceRestTransport + + request_init = {} + request_init["resource"] = "" + request = request_type(**request_init) + pb_request = request + jsonified_request = json.loads( + json_format.MessageToJson(pb_request, use_integers_for_enums=False) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_iam_policy._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["resource"] = "resource_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_iam_policy._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("options",)) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "resource" in jsonified_request + assert jsonified_request["resource"] == "resource_value" + + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = policy_pb2.Policy() + # 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 + 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 + + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.get_iam_policy(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_get_iam_policy_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.get_iam_policy._get_unset_required_fields({}) + assert set(unset_fields) == (set(("options",)) & set(("resource",))) + + +def test_get_iam_policy_rest_flattened(): + client = ReservationServiceClient( + 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 = policy_pb2.Policy() + + # get arguments that satisfy an http rule for this method + sample_request = { + "resource": "projects/sample1/locations/sample2/reservations/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + resource="resource_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 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.get_iam_policy(**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/v1/{resource=projects/*/locations/*/reservations/*}:getIamPolicy" + % client.transport._host, + args[1], + ) + + +def test_get_iam_policy_rest_flattened_error(transport: str = "rest"): + client = ReservationServiceClient( + 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_iam_policy( + iam_policy_pb2.GetIamPolicyRequest(), + resource="resource_value", + ) + + +def test_set_iam_policy_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.set_iam_policy in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[client._transport.set_iam_policy] = mock_rpc + + request = {} + client.set_iam_policy(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.set_iam_policy(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_set_iam_policy_rest_required_fields( + request_type=iam_policy_pb2.SetIamPolicyRequest, +): + transport_class = transports.ReservationServiceRestTransport + + request_init = {} + request_init["resource"] = "" + request = request_type(**request_init) + pb_request = request + jsonified_request = json.loads( + json_format.MessageToJson(pb_request, use_integers_for_enums=False) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).set_iam_policy._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["resource"] = "resource_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).set_iam_policy._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "resource" in jsonified_request + assert jsonified_request["resource"] == "resource_value" + + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = policy_pb2.Policy() + # 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 + 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 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.set_iam_policy(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_set_iam_policy_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.set_iam_policy._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(()) + & set( + ( + "resource", + "policy", + ) + ) + ) + + +def test_set_iam_policy_rest_flattened(): + client = ReservationServiceClient( + 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 = policy_pb2.Policy() + + # get arguments that satisfy an http rule for this method + sample_request = { + "resource": "projects/sample1/locations/sample2/reservations/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + resource="resource_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 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.set_iam_policy(**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/v1/{resource=projects/*/locations/*/reservations/*}:setIamPolicy" + % client.transport._host, + args[1], + ) + + +def test_set_iam_policy_rest_flattened_error(transport: str = "rest"): + client = ReservationServiceClient( + 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.set_iam_policy( + iam_policy_pb2.SetIamPolicyRequest(), + resource="resource_value", + ) + + +def test_test_iam_permissions_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._transport.test_iam_permissions in client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.test_iam_permissions + ] = mock_rpc + + request = {} + client.test_iam_permissions(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.test_iam_permissions(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_test_iam_permissions_rest_required_fields( + request_type=iam_policy_pb2.TestIamPermissionsRequest, +): + transport_class = transports.ReservationServiceRestTransport + + request_init = {} + request_init["resource"] = "" + request_init["permissions"] = "" + request = request_type(**request_init) + pb_request = request + jsonified_request = json.loads( + json_format.MessageToJson(pb_request, use_integers_for_enums=False) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).test_iam_permissions._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["resource"] = "resource_value" + jsonified_request["permissions"] = "permissions_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).test_iam_permissions._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "resource" in jsonified_request + assert jsonified_request["resource"] == "resource_value" + assert "permissions" in jsonified_request + assert jsonified_request["permissions"] == "permissions_value" + + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = iam_policy_pb2.TestIamPermissionsResponse() + # 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 + 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 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.test_iam_permissions(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_test_iam_permissions_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.test_iam_permissions._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(()) + & set( + ( + "resource", + "permissions", + ) + ) + ) + + +def test_create_reservation_group_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._transport.create_reservation_group + in client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.create_reservation_group + ] = mock_rpc + + request = {} + client.create_reservation_group(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.create_reservation_group(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_create_reservation_group_rest_required_fields( + request_type=reservation.CreateReservationGroupRequest, +): + transport_class = transports.ReservationServiceRestTransport + + request_init = {} + request_init["parent"] = "" + request_init["reservation_group_id"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson(pb_request, use_integers_for_enums=False) + ) + + # verify fields with default values are dropped + assert "reservationGroupId" not in jsonified_request + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).create_reservation_group._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "reservationGroupId" in jsonified_request + assert ( + jsonified_request["reservationGroupId"] == request_init["reservation_group_id"] + ) + + jsonified_request["parent"] = "parent_value" + jsonified_request["reservationGroupId"] = "reservation_group_id_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).create_reservation_group._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("reservation_group_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" + assert "reservationGroupId" in jsonified_request + assert jsonified_request["reservationGroupId"] == "reservation_group_id_value" + + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = reservation.ReservationGroup() + # 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 + + # Convert return value to protobuf type + return_value = reservation.ReservationGroup.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.create_reservation_group(request) + + expected_params = [ + ( + "reservationGroupId", + "", + ), + ("$alt", "json;enum-encoding=int"), + ] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_create_reservation_group_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.create_reservation_group._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(("reservationGroupId",)) + & set( + ( + "parent", + "reservationGroupId", + "reservationGroup", + ) + ) + ) + + +def test_get_reservation_group_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._transport.get_reservation_group + in client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.get_reservation_group + ] = mock_rpc + + request = {} + client.get_reservation_group(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.get_reservation_group(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_get_reservation_group_rest_required_fields( + request_type=reservation.GetReservationGroupRequest, +): + transport_class = transports.ReservationServiceRestTransport + + 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, use_integers_for_enums=False) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_reservation_group._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_reservation_group._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 = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = reservation.ReservationGroup() + # 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 + + # Convert return value to protobuf type + return_value = reservation.ReservationGroup.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.get_reservation_group(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_get_reservation_group_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.get_reservation_group._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +def test_get_reservation_group_rest_flattened(): + client = ReservationServiceClient( + 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 = reservation.ReservationGroup() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/reservationGroups/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 + # Convert return value to protobuf type + return_value = reservation.ReservationGroup.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.get_reservation_group(**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/v1/{name=projects/*/locations/*/reservationGroups/*}" + % client.transport._host, + args[1], + ) + + +def test_get_reservation_group_rest_flattened_error(transport: str = "rest"): + client = ReservationServiceClient( + 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_reservation_group( + reservation.GetReservationGroupRequest(), + name="name_value", + ) + + +def test_delete_reservation_group_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._transport.delete_reservation_group + in client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.delete_reservation_group + ] = mock_rpc + + request = {} + client.delete_reservation_group(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.delete_reservation_group(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_delete_reservation_group_rest_required_fields( + request_type=reservation.DeleteReservationGroupRequest, +): + transport_class = transports.ReservationServiceRestTransport + + 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, use_integers_for_enums=False) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_reservation_group._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_reservation_group._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 = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # 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 = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.delete_reservation_group(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_delete_reservation_group_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.delete_reservation_group._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +def test_delete_reservation_group_rest_flattened(): + client = ReservationServiceClient( + 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 = None + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/reservationGroups/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 = "" + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.delete_reservation_group(**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/v1/{name=projects/*/locations/*/reservationGroups/*}" + % client.transport._host, + args[1], + ) + + +def test_delete_reservation_group_rest_flattened_error(transport: str = "rest"): + client = ReservationServiceClient( + 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_reservation_group( + reservation.DeleteReservationGroupRequest(), + name="name_value", + ) + + +def test_list_reservation_groups_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._transport.list_reservation_groups + in client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.list_reservation_groups + ] = mock_rpc + + request = {} + client.list_reservation_groups(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.list_reservation_groups(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_list_reservation_groups_rest_required_fields( + request_type=reservation.ListReservationGroupsRequest, +): + transport_class = transports.ReservationServiceRestTransport + + 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, use_integers_for_enums=False) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_reservation_groups._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_reservation_groups._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 = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = reservation.ListReservationGroupsResponse() + # 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 + + # Convert return value to protobuf type + return_value = reservation.ListReservationGroupsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.list_reservation_groups(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_reservation_groups_rest_unset_required_fields(): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_reservation_groups._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "pageSize", + "pageToken", + ) + ) + & set(("parent",)) + ) + + +def test_list_reservation_groups_rest_flattened(): + client = ReservationServiceClient( + 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 = reservation.ListReservationGroupsResponse() + + # 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 + # Convert return value to protobuf type + return_value = reservation.ListReservationGroupsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.list_reservation_groups(**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/v1/{parent=projects/*/locations/*}/reservationGroups" + % client.transport._host, + args[1], + ) + + +def test_list_reservation_groups_rest_flattened_error(transport: str = "rest"): + client = ReservationServiceClient( + 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_reservation_groups( + reservation.ListReservationGroupsRequest(), + parent="parent_value", + ) + + +def test_list_reservation_groups_rest_pager(transport: str = "rest"): + client = ReservationServiceClient( + 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 = ( + reservation.ListReservationGroupsResponse( + reservation_groups=[ + reservation.ReservationGroup(), + reservation.ReservationGroup(), + reservation.ReservationGroup(), + ], + next_page_token="abc", + ), + reservation.ListReservationGroupsResponse( + reservation_groups=[], + next_page_token="def", + ), + reservation.ListReservationGroupsResponse( + reservation_groups=[ + reservation.ReservationGroup(), + ], + next_page_token="ghi", + ), + reservation.ListReservationGroupsResponse( + reservation_groups=[ + reservation.ReservationGroup(), + reservation.ReservationGroup(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple( + reservation.ListReservationGroupsResponse.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_reservation_groups(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, reservation.ReservationGroup) for i in results) + + pages = list(client.list_reservation_groups(request=sample_request).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.ReservationServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.ReservationServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = ReservationServiceClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.ReservationServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = ReservationServiceClient( + client_options=options, + transport=transport, + ) + + # It is an error to provide an api_key and a credential. + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = ReservationServiceClient( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.ReservationServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = ReservationServiceClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.ReservationServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = ReservationServiceClient(transport=transport) + assert client.transport is transport + + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.ReservationServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.ReservationServiceGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.ReservationServiceGrpcTransport, + transports.ReservationServiceGrpcAsyncIOTransport, + transports.ReservationServiceRestTransport, + ], +) +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() + + +def test_transport_kind_grpc(): + transport = ReservationServiceClient.get_transport_class("grpc")( + credentials=ga_credentials.AnonymousCredentials() + ) + assert transport.kind == "grpc" + + +def test_initialize_client_w_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc" + ) + assert client is not None + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_create_reservation_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.create_reservation), "__call__" + ) as call: + call.return_value = gcbr_reservation.Reservation() + client.create_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = gcbr_reservation.CreateReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_list_reservations_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_reservations), "__call__" + ) as call: + call.return_value = reservation.ListReservationsResponse() + client.list_reservations(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.ListReservationsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_get_reservation_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object(type(client.transport.get_reservation), "__call__") as call: + call.return_value = reservation.Reservation() + client.get_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.GetReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_delete_reservation_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.delete_reservation), "__call__" + ) as call: + call.return_value = None + client.delete_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.DeleteReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_update_reservation_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.update_reservation), "__call__" + ) as call: + call.return_value = gcbr_reservation.Reservation() + client.update_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = gcbr_reservation.UpdateReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_failover_reservation_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.failover_reservation), "__call__" + ) as call: + call.return_value = reservation.Reservation() + client.failover_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.FailoverReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_create_capacity_commitment_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.create_capacity_commitment), "__call__" + ) as call: + call.return_value = reservation.CapacityCommitment() + client.create_capacity_commitment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.CreateCapacityCommitmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_list_capacity_commitments_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_capacity_commitments), "__call__" + ) as call: + call.return_value = reservation.ListCapacityCommitmentsResponse() + client.list_capacity_commitments(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.ListCapacityCommitmentsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_get_capacity_commitment_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_capacity_commitment), "__call__" + ) as call: + call.return_value = reservation.CapacityCommitment() + client.get_capacity_commitment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.GetCapacityCommitmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_delete_capacity_commitment_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.delete_capacity_commitment), "__call__" + ) as call: + call.return_value = None + client.delete_capacity_commitment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.DeleteCapacityCommitmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_update_capacity_commitment_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.update_capacity_commitment), "__call__" + ) as call: + call.return_value = reservation.CapacityCommitment() + client.update_capacity_commitment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.UpdateCapacityCommitmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_split_capacity_commitment_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.split_capacity_commitment), "__call__" + ) as call: + call.return_value = reservation.SplitCapacityCommitmentResponse() + client.split_capacity_commitment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.SplitCapacityCommitmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_merge_capacity_commitments_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.merge_capacity_commitments), "__call__" + ) as call: + call.return_value = reservation.CapacityCommitment() + client.merge_capacity_commitments(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.MergeCapacityCommitmentsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_create_assignment_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.create_assignment), "__call__" + ) as call: + call.return_value = reservation.Assignment() + client.create_assignment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.CreateAssignmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_list_assignments_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object(type(client.transport.list_assignments), "__call__") as call: + call.return_value = reservation.ListAssignmentsResponse() + client.list_assignments(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.ListAssignmentsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_delete_assignment_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.delete_assignment), "__call__" + ) as call: + call.return_value = None + client.delete_assignment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.DeleteAssignmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_search_assignments_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.search_assignments), "__call__" + ) as call: + call.return_value = reservation.SearchAssignmentsResponse() + client.search_assignments(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.SearchAssignmentsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_search_all_assignments_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.search_all_assignments), "__call__" + ) as call: + call.return_value = reservation.SearchAllAssignmentsResponse() + client.search_all_assignments(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.SearchAllAssignmentsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_move_assignment_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object(type(client.transport.move_assignment), "__call__") as call: + call.return_value = reservation.Assignment() + client.move_assignment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.MoveAssignmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_update_assignment_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.update_assignment), "__call__" + ) as call: + call.return_value = reservation.Assignment() + client.update_assignment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.UpdateAssignmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_get_bi_reservation_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_bi_reservation), "__call__" + ) as call: + call.return_value = reservation.BiReservation() + client.get_bi_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.GetBiReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_update_bi_reservation_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.update_bi_reservation), "__call__" + ) as call: + call.return_value = reservation.BiReservation() + client.update_bi_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.UpdateBiReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_get_iam_policy_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object(type(client.transport.get_iam_policy), "__call__") as call: + call.return_value = policy_pb2.Policy() + client.get_iam_policy(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = iam_policy_pb2.GetIamPolicyRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_set_iam_policy_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object(type(client.transport.set_iam_policy), "__call__") as call: + call.return_value = policy_pb2.Policy() + client.set_iam_policy(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = iam_policy_pb2.SetIamPolicyRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_test_iam_permissions_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.test_iam_permissions), "__call__" + ) as call: + call.return_value = iam_policy_pb2.TestIamPermissionsResponse() + client.test_iam_permissions(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = iam_policy_pb2.TestIamPermissionsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_create_reservation_group_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.create_reservation_group), "__call__" + ) as call: + call.return_value = reservation.ReservationGroup() + client.create_reservation_group(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.CreateReservationGroupRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_get_reservation_group_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_reservation_group), "__call__" + ) as call: + call.return_value = reservation.ReservationGroup() + client.get_reservation_group(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.GetReservationGroupRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_delete_reservation_group_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.delete_reservation_group), "__call__" + ) as call: + call.return_value = None + client.delete_reservation_group(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.DeleteReservationGroupRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_list_reservation_groups_empty_call_grpc(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_reservation_groups), "__call__" + ) as call: + call.return_value = reservation.ListReservationGroupsResponse() + client.list_reservation_groups(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.ListReservationGroupsRequest() + + assert args[0] == request_msg + + +def test_transport_kind_grpc_asyncio(): + transport = ReservationServiceAsyncClient.get_transport_class("grpc_asyncio")( + credentials=async_anonymous_credentials() + ) + assert transport.kind == "grpc_asyncio" + + +def test_initialize_client_w_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), transport="grpc_asyncio" + ) + assert client is not None + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_create_reservation_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.create_reservation), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + gcbr_reservation.Reservation( + name="name_value", + slot_capacity=1391, + ignore_idle_slots=True, + concurrency=1195, + multi_region_auxiliary=True, + edition=gcbr_reservation.Edition.STANDARD, + primary_location="primary_location_value", + secondary_location="secondary_location_value", + original_primary_location="original_primary_location_value", + max_slots=986, + scaling_mode=gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + reservation_group="reservation_group_value", + ) + ) + await client.create_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = gcbr_reservation.CreateReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_list_reservations_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_reservations), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + reservation.ListReservationsResponse( + next_page_token="next_page_token_value", + ) + ) + await client.list_reservations(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.ListReservationsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_get_reservation_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object(type(client.transport.get_reservation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + reservation.Reservation( + name="name_value", + slot_capacity=1391, + ignore_idle_slots=True, + concurrency=1195, + multi_region_auxiliary=True, + edition=reservation.Edition.STANDARD, + primary_location="primary_location_value", + secondary_location="secondary_location_value", + original_primary_location="original_primary_location_value", + max_slots=986, + scaling_mode=reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + reservation_group="reservation_group_value", + ) + ) + await client.get_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.GetReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_delete_reservation_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.delete_reservation), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.DeleteReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_update_reservation_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.update_reservation), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + gcbr_reservation.Reservation( + name="name_value", + slot_capacity=1391, + ignore_idle_slots=True, + concurrency=1195, + multi_region_auxiliary=True, + edition=gcbr_reservation.Edition.STANDARD, + primary_location="primary_location_value", + secondary_location="secondary_location_value", + original_primary_location="original_primary_location_value", + max_slots=986, + scaling_mode=gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + reservation_group="reservation_group_value", + ) + ) + await client.update_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = gcbr_reservation.UpdateReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_failover_reservation_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.failover_reservation), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + reservation.Reservation( + name="name_value", + slot_capacity=1391, + ignore_idle_slots=True, + concurrency=1195, + multi_region_auxiliary=True, + edition=reservation.Edition.STANDARD, + primary_location="primary_location_value", + secondary_location="secondary_location_value", + original_primary_location="original_primary_location_value", + max_slots=986, + scaling_mode=reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + reservation_group="reservation_group_value", + ) + ) + await client.failover_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.FailoverReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_create_capacity_commitment_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.create_capacity_commitment), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + reservation.CapacityCommitment( + name="name_value", + slot_count=1098, + plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + state=reservation.CapacityCommitment.State.PENDING, + renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + multi_region_auxiliary=True, + edition=reservation.Edition.STANDARD, + is_flat_rate=True, + ) + ) + await client.create_capacity_commitment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.CreateCapacityCommitmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_list_capacity_commitments_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_capacity_commitments), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + reservation.ListCapacityCommitmentsResponse( + next_page_token="next_page_token_value", + ) + ) + await client.list_capacity_commitments(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.ListCapacityCommitmentsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_get_capacity_commitment_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_capacity_commitment), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + reservation.CapacityCommitment( + name="name_value", + slot_count=1098, + plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + state=reservation.CapacityCommitment.State.PENDING, + renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + multi_region_auxiliary=True, + edition=reservation.Edition.STANDARD, + is_flat_rate=True, + ) + ) + await client.get_capacity_commitment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.GetCapacityCommitmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_delete_capacity_commitment_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.delete_capacity_commitment), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_capacity_commitment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.DeleteCapacityCommitmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_update_capacity_commitment_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.update_capacity_commitment), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + reservation.CapacityCommitment( + name="name_value", + slot_count=1098, + plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + state=reservation.CapacityCommitment.State.PENDING, + renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + multi_region_auxiliary=True, + edition=reservation.Edition.STANDARD, + is_flat_rate=True, + ) + ) + await client.update_capacity_commitment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.UpdateCapacityCommitmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_split_capacity_commitment_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.split_capacity_commitment), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + reservation.SplitCapacityCommitmentResponse() + ) + await client.split_capacity_commitment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.SplitCapacityCommitmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_merge_capacity_commitments_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.merge_capacity_commitments), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + reservation.CapacityCommitment( + name="name_value", + slot_count=1098, + plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + state=reservation.CapacityCommitment.State.PENDING, + renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + multi_region_auxiliary=True, + edition=reservation.Edition.STANDARD, + is_flat_rate=True, + ) + ) + await client.merge_capacity_commitments(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.MergeCapacityCommitmentsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_create_assignment_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.create_assignment), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + reservation.Assignment( + name="name_value", + assignee="assignee_value", + job_type=reservation.Assignment.JobType.PIPELINE, + state=reservation.Assignment.State.PENDING, + enable_gemini_in_bigquery=True, + ) + ) + await client.create_assignment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.CreateAssignmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_list_assignments_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object(type(client.transport.list_assignments), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + reservation.ListAssignmentsResponse( + next_page_token="next_page_token_value", + ) + ) + await client.list_assignments(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.ListAssignmentsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_delete_assignment_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.delete_assignment), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_assignment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.DeleteAssignmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_search_assignments_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.search_assignments), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + reservation.SearchAssignmentsResponse( + next_page_token="next_page_token_value", + ) + ) + await client.search_assignments(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.SearchAssignmentsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_search_all_assignments_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.search_all_assignments), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + reservation.SearchAllAssignmentsResponse( + next_page_token="next_page_token_value", + ) + ) + await client.search_all_assignments(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.SearchAllAssignmentsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_move_assignment_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object(type(client.transport.move_assignment), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + reservation.Assignment( + name="name_value", + assignee="assignee_value", + job_type=reservation.Assignment.JobType.PIPELINE, + state=reservation.Assignment.State.PENDING, + enable_gemini_in_bigquery=True, + ) + ) + await client.move_assignment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.MoveAssignmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_update_assignment_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", ) # Mock the actual call, and fake the request. - with mock.patch.object(type(client.transport.move_assignment), "__call__") as call: + with mock.patch.object( + type(client.transport.update_assignment), "__call__" + ) as call: # Designate an appropriate return value for the call. call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( reservation.Assignment( @@ -15173,118 +19100,1342 @@ async def test_move_assignment_empty_call_grpc_asyncio(): enable_gemini_in_bigquery=True, ) ) - await client.move_assignment(request=None) + await client.update_assignment(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.UpdateAssignmentRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_get_bi_reservation_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_bi_reservation), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + reservation.BiReservation( + name="name_value", + size=443, + ) + ) + await client.get_bi_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.GetBiReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_update_bi_reservation_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.update_bi_reservation), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + reservation.BiReservation( + name="name_value", + size=443, + ) + ) + await client.update_bi_reservation(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.UpdateBiReservationRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_get_iam_policy_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object(type(client.transport.get_iam_policy), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + policy_pb2.Policy( + version=774, + etag=b"etag_blob", + ) + ) + await client.get_iam_policy(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = iam_policy_pb2.GetIamPolicyRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_set_iam_policy_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object(type(client.transport.set_iam_policy), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + policy_pb2.Policy( + version=774, + etag=b"etag_blob", + ) + ) + await client.set_iam_policy(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = iam_policy_pb2.SetIamPolicyRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_test_iam_permissions_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.test_iam_permissions), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + iam_policy_pb2.TestIamPermissionsResponse( + permissions=["permissions_value"], + ) + ) + await client.test_iam_permissions(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = iam_policy_pb2.TestIamPermissionsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_create_reservation_group_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.create_reservation_group), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + reservation.ReservationGroup( + name="name_value", + ) + ) + await client.create_reservation_group(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.CreateReservationGroupRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_get_reservation_group_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_reservation_group), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + reservation.ReservationGroup( + name="name_value", + ) + ) + await client.get_reservation_group(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.GetReservationGroupRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_delete_reservation_group_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.delete_reservation_group), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_reservation_group(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.DeleteReservationGroupRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_list_reservation_groups_empty_call_grpc_asyncio(): + client = ReservationServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_reservation_groups), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + reservation.ListReservationGroupsResponse( + next_page_token="next_page_token_value", + ) + ) + await client.list_reservation_groups(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.ListReservationGroupsRequest() + + assert args[0] == request_msg + + +def test_transport_kind_rest(): + transport = ReservationServiceClient.get_transport_class("rest")( + credentials=ga_credentials.AnonymousCredentials() + ) + assert transport.kind == "rest" + + +def test_create_reservation_rest_bad_request( + request_type=gcbr_reservation.CreateReservationRequest, +): + client = ReservationServiceClient( + 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 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 = mock.Mock() + json_return_value = "" + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.create_reservation(request) + + +@pytest.mark.parametrize( + "request_type", + [ + gcbr_reservation.CreateReservationRequest, + dict, + ], +) +def test_create_reservation_rest_call_success(request_type): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request_init["reservation"] = { + "name": "name_value", + "slot_capacity": 1391, + "ignore_idle_slots": True, + "autoscale": {"current_slots": 1431, "max_slots": 986}, + "concurrency": 1195, + "creation_time": {"seconds": 751, "nanos": 543}, + "update_time": {}, + "multi_region_auxiliary": True, + "edition": 1, + "primary_location": "primary_location_value", + "secondary_location": "secondary_location_value", + "original_primary_location": "original_primary_location_value", + "max_slots": 986, + "scaling_mode": 1, + "labels": {}, + "reservation_group": "reservation_group_value", + "replication_status": { + "error": { + "code": 411, + "message": "message_value", + "details": [ + { + "type_url": "type.googleapis.com/google.protobuf.Duration", + "value": b"\x08\x0c\x10\xdb\x07", + } + ], + }, + "last_error_time": {}, + "last_replication_time": {}, + "soft_failover_start_time": {}, + }, + "scheduling_policy": {"concurrency": 1195, "max_slots": 986}, + } + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = gcbr_reservation.CreateReservationRequest.meta.fields["reservation"] + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["reservation"].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + { + "field": field, + "subfield": subfield, + "is_repeated": is_repeated, + } + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["reservation"][field])): + del request_init["reservation"][field][i][subfield] + else: + del request_init["reservation"][field][subfield] + 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 = gcbr_reservation.Reservation( + name="name_value", + slot_capacity=1391, + ignore_idle_slots=True, + concurrency=1195, + multi_region_auxiliary=True, + edition=gcbr_reservation.Edition.STANDARD, + primary_location="primary_location_value", + secondary_location="secondary_location_value", + original_primary_location="original_primary_location_value", + max_slots=986, + scaling_mode=gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + reservation_group="reservation_group_value", + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = gcbr_reservation.Reservation.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.create_reservation(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, gcbr_reservation.Reservation) + assert response.name == "name_value" + assert response.slot_capacity == 1391 + assert response.ignore_idle_slots is True + assert response.concurrency == 1195 + assert response.multi_region_auxiliary is True + assert response.edition == gcbr_reservation.Edition.STANDARD + assert response.primary_location == "primary_location_value" + assert response.secondary_location == "secondary_location_value" + assert response.original_primary_location == "original_primary_location_value" + assert response.max_slots == 986 + assert ( + response.scaling_mode == gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY + ) + assert response.reservation_group == "reservation_group_value" + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_reservation_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ReservationServiceRestInterceptor(), + ) + client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_create_reservation" + ) as post, mock.patch.object( + transports.ReservationServiceRestInterceptor, + "post_create_reservation_with_metadata", + ) as post_with_metadata, mock.patch.object( + transports.ReservationServiceRestInterceptor, "pre_create_reservation" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = gcbr_reservation.CreateReservationRequest.pb( + gcbr_reservation.CreateReservationRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = gcbr_reservation.Reservation.to_json( + gcbr_reservation.Reservation() + ) + req.return_value.content = return_value + + request = gcbr_reservation.CreateReservationRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = gcbr_reservation.Reservation() + post_with_metadata.return_value = gcbr_reservation.Reservation(), metadata + + client.create_reservation( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_list_reservations_rest_bad_request( + request_type=reservation.ListReservationsRequest, +): + client = ReservationServiceClient( + 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 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 = mock.Mock() + json_return_value = "" + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.list_reservations(request) + + +@pytest.mark.parametrize( + "request_type", + [ + reservation.ListReservationsRequest, + dict, + ], +) +def test_list_reservations_rest_call_success(request_type): + client = ReservationServiceClient( + 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 = reservation.ListReservationsResponse( + next_page_token="next_page_token_value", + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = reservation.ListReservationsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.list_reservations(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListReservationsPager) + assert response.next_page_token == "next_page_token_value" + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_reservations_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ReservationServiceRestInterceptor(), + ) + client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_list_reservations" + ) as post, mock.patch.object( + transports.ReservationServiceRestInterceptor, + "post_list_reservations_with_metadata", + ) as post_with_metadata, mock.patch.object( + transports.ReservationServiceRestInterceptor, "pre_list_reservations" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = reservation.ListReservationsRequest.pb( + reservation.ListReservationsRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = reservation.ListReservationsResponse.to_json( + reservation.ListReservationsResponse() + ) + req.return_value.content = return_value + + request = reservation.ListReservationsRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = reservation.ListReservationsResponse() + post_with_metadata.return_value = ( + reservation.ListReservationsResponse(), + metadata, + ) + + client.list_reservations( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_get_reservation_rest_bad_request( + request_type=reservation.GetReservationRequest, +): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/reservations/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 = mock.Mock() + json_return_value = "" + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.get_reservation(request) + + +@pytest.mark.parametrize( + "request_type", + [ + reservation.GetReservationRequest, + dict, + ], +) +def test_get_reservation_rest_call_success(request_type): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/reservations/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 = reservation.Reservation( + name="name_value", + slot_capacity=1391, + ignore_idle_slots=True, + concurrency=1195, + multi_region_auxiliary=True, + edition=reservation.Edition.STANDARD, + primary_location="primary_location_value", + secondary_location="secondary_location_value", + original_primary_location="original_primary_location_value", + max_slots=986, + scaling_mode=reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + reservation_group="reservation_group_value", + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = reservation.Reservation.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.get_reservation(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.Reservation) + assert response.name == "name_value" + assert response.slot_capacity == 1391 + assert response.ignore_idle_slots is True + assert response.concurrency == 1195 + assert response.multi_region_auxiliary is True + assert response.edition == reservation.Edition.STANDARD + assert response.primary_location == "primary_location_value" + assert response.secondary_location == "secondary_location_value" + assert response.original_primary_location == "original_primary_location_value" + assert response.max_slots == 986 + assert response.scaling_mode == reservation.Reservation.ScalingMode.AUTOSCALE_ONLY + assert response.reservation_group == "reservation_group_value" + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_reservation_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ReservationServiceRestInterceptor(), + ) + client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "post_get_reservation" + ) as post, mock.patch.object( + transports.ReservationServiceRestInterceptor, + "post_get_reservation_with_metadata", + ) as post_with_metadata, mock.patch.object( + transports.ReservationServiceRestInterceptor, "pre_get_reservation" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = reservation.GetReservationRequest.pb( + reservation.GetReservationRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = reservation.Reservation.to_json(reservation.Reservation()) + req.return_value.content = return_value + + request = reservation.GetReservationRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = reservation.Reservation() + post_with_metadata.return_value = reservation.Reservation(), metadata + + client.get_reservation( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_delete_reservation_rest_bad_request( + request_type=reservation.DeleteReservationRequest, +): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/reservations/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 = mock.Mock() + json_return_value = "" + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.delete_reservation(request) + + +@pytest.mark.parametrize( + "request_type", + [ + reservation.DeleteReservationRequest, + dict, + ], +) +def test_delete_reservation_rest_call_success(request_type): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/reservations/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 = mock.Mock() + response_value.status_code = 200 + json_return_value = "" + response_value.content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.delete_reservation(request) + + # Establish that the response is the type that we expect. + assert response is None + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_reservation_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ReservationServiceRestInterceptor(), + ) + client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "pre_delete_reservation" + ) as pre: + pre.assert_not_called() + pb_message = reservation.DeleteReservationRequest.pb( + reservation.DeleteReservationRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + request = reservation.DeleteReservationRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_reservation( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + + +def test_update_reservation_rest_bad_request( + request_type=gcbr_reservation.UpdateReservationRequest, +): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + # send a request that will satisfy transcoding + request_init = { + "reservation": { + "name": "projects/sample1/locations/sample2/reservations/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 = mock.Mock() + json_return_value = "" + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.update_reservation(request) + + +@pytest.mark.parametrize( + "request_type", + [ + gcbr_reservation.UpdateReservationRequest, + dict, + ], +) +def test_update_reservation_rest_call_success(request_type): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = { + "reservation": { + "name": "projects/sample1/locations/sample2/reservations/sample3" + } + } + request_init["reservation"] = { + "name": "projects/sample1/locations/sample2/reservations/sample3", + "slot_capacity": 1391, + "ignore_idle_slots": True, + "autoscale": {"current_slots": 1431, "max_slots": 986}, + "concurrency": 1195, + "creation_time": {"seconds": 751, "nanos": 543}, + "update_time": {}, + "multi_region_auxiliary": True, + "edition": 1, + "primary_location": "primary_location_value", + "secondary_location": "secondary_location_value", + "original_primary_location": "original_primary_location_value", + "max_slots": 986, + "scaling_mode": 1, + "labels": {}, + "reservation_group": "reservation_group_value", + "replication_status": { + "error": { + "code": 411, + "message": "message_value", + "details": [ + { + "type_url": "type.googleapis.com/google.protobuf.Duration", + "value": b"\x08\x0c\x10\xdb\x07", + } + ], + }, + "last_error_time": {}, + "last_replication_time": {}, + "soft_failover_start_time": {}, + }, + "scheduling_policy": {"concurrency": 1195, "max_slots": 986}, + } + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = gcbr_reservation.UpdateReservationRequest.meta.fields["reservation"] + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["reservation"].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + { + "field": field, + "subfield": subfield, + "is_repeated": is_repeated, + } + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["reservation"][field])): + del request_init["reservation"][field][i][subfield] + else: + del request_init["reservation"][field][subfield] + 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 = gcbr_reservation.Reservation( + name="name_value", + slot_capacity=1391, + ignore_idle_slots=True, + concurrency=1195, + multi_region_auxiliary=True, + edition=gcbr_reservation.Edition.STANDARD, + primary_location="primary_location_value", + secondary_location="secondary_location_value", + original_primary_location="original_primary_location_value", + max_slots=986, + scaling_mode=gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + reservation_group="reservation_group_value", + ) - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.MoveAssignmentRequest() + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 - assert args[0] == request_msg + # Convert return value to protobuf type + return_value = gcbr_reservation.Reservation.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.update_reservation(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, gcbr_reservation.Reservation) + assert response.name == "name_value" + assert response.slot_capacity == 1391 + assert response.ignore_idle_slots is True + assert response.concurrency == 1195 + assert response.multi_region_auxiliary is True + assert response.edition == gcbr_reservation.Edition.STANDARD + assert response.primary_location == "primary_location_value" + assert response.secondary_location == "secondary_location_value" + assert response.original_primary_location == "original_primary_location_value" + assert response.max_slots == 986 + assert ( + response.scaling_mode == gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY + ) + assert response.reservation_group == "reservation_group_value" -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_update_assignment_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_reservation_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ReservationServiceRestInterceptor(), ) + client = ReservationServiceClient(transport=transport) - # Mock the actual call, and fake the request. with mock.patch.object( - type(client.transport.update_assignment), "__call__" - ) as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - reservation.Assignment( - name="name_value", - assignee="assignee_value", - job_type=reservation.Assignment.JobType.PIPELINE, - state=reservation.Assignment.State.PENDING, - enable_gemini_in_bigquery=True, - ) + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ReservationServiceRestInterceptor, "post_update_reservation" + ) as post, mock.patch.object( + transports.ReservationServiceRestInterceptor, + "post_update_reservation_with_metadata", + ) as post_with_metadata, mock.patch.object( + transports.ReservationServiceRestInterceptor, "pre_update_reservation" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = gcbr_reservation.UpdateReservationRequest.pb( + gcbr_reservation.UpdateReservationRequest() ) - await client.update_assignment(request=None) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.UpdateAssignmentRequest() + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = gcbr_reservation.Reservation.to_json( + gcbr_reservation.Reservation() + ) + req.return_value.content = return_value - assert args[0] == request_msg + request = gcbr_reservation.UpdateReservationRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = gcbr_reservation.Reservation() + post_with_metadata.return_value = gcbr_reservation.Reservation(), metadata + + client.update_reservation( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_get_bi_reservation_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", + +def test_failover_reservation_rest_bad_request( + request_type=reservation.FailoverReservationRequest, +): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/reservations/sample3"} + request = request_type(**request_init) - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.get_bi_reservation), "__call__" - ) as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - reservation.BiReservation( - name="name_value", - size=443, - ) + # 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 = mock.Mock() + json_return_value = "" + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.failover_reservation(request) + + +@pytest.mark.parametrize( + "request_type", + [ + reservation.FailoverReservationRequest, + dict, + ], +) +def test_failover_reservation_rest_call_success(request_type): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/reservations/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 = reservation.Reservation( + name="name_value", + slot_capacity=1391, + ignore_idle_slots=True, + concurrency=1195, + multi_region_auxiliary=True, + edition=reservation.Edition.STANDARD, + primary_location="primary_location_value", + secondary_location="secondary_location_value", + original_primary_location="original_primary_location_value", + max_slots=986, + scaling_mode=reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + reservation_group="reservation_group_value", ) - await client.get_bi_reservation(request=None) - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.GetBiReservationRequest() + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 - assert args[0] == request_msg + # Convert return value to protobuf type + return_value = reservation.Reservation.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.failover_reservation(request) + # Establish that the response is the type that we expect. + assert isinstance(response, reservation.Reservation) + assert response.name == "name_value" + assert response.slot_capacity == 1391 + assert response.ignore_idle_slots is True + assert response.concurrency == 1195 + assert response.multi_region_auxiliary is True + assert response.edition == reservation.Edition.STANDARD + assert response.primary_location == "primary_location_value" + assert response.secondary_location == "secondary_location_value" + assert response.original_primary_location == "original_primary_location_value" + assert response.max_slots == 986 + assert response.scaling_mode == reservation.Reservation.ScalingMode.AUTOSCALE_ONLY + assert response.reservation_group == "reservation_group_value" -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_update_bi_reservation_empty_call_grpc_asyncio(): - client = ReservationServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_failover_reservation_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ReservationServiceRestInterceptor(), ) + client = ReservationServiceClient(transport=transport) - # Mock the actual call, and fake the request. with mock.patch.object( - type(client.transport.update_bi_reservation), "__call__" - ) as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - reservation.BiReservation( - name="name_value", - size=443, - ) + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.ReservationServiceRestInterceptor, "post_failover_reservation" + ) as post, mock.patch.object( + transports.ReservationServiceRestInterceptor, + "post_failover_reservation_with_metadata", + ) as post_with_metadata, mock.patch.object( + transports.ReservationServiceRestInterceptor, "pre_failover_reservation" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = reservation.FailoverReservationRequest.pb( + reservation.FailoverReservationRequest() ) - await client.update_bi_reservation(request=None) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = reservation.UpdateBiReservationRequest() + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = reservation.Reservation.to_json(reservation.Reservation()) + req.return_value.content = return_value - assert args[0] == request_msg + request = reservation.FailoverReservationRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = reservation.Reservation() + post_with_metadata.return_value = reservation.Reservation(), metadata + client.failover_reservation( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) -def test_transport_kind_rest(): - transport = ReservationServiceClient.get_transport_class("rest")( - credentials=ga_credentials.AnonymousCredentials() - ) - assert transport.kind == "rest" + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() -def test_create_reservation_rest_bad_request( - request_type=gcbr_reservation.CreateReservationRequest, +def test_create_capacity_commitment_rest_bad_request( + request_type=reservation.CreateCapacityCommitmentRequest, ): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" @@ -15305,60 +20456,53 @@ def test_create_reservation_rest_bad_request( response_value.request = mock.Mock() req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.create_reservation(request) + client.create_capacity_commitment(request) @pytest.mark.parametrize( "request_type", [ - gcbr_reservation.CreateReservationRequest, + reservation.CreateCapacityCommitmentRequest, dict, ], ) -def test_create_reservation_rest_call_success(request_type): +def test_create_capacity_commitment_rest_call_success(request_type): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding request_init = {"parent": "projects/sample1/locations/sample2"} - request_init["reservation"] = { + request_init["capacity_commitment"] = { "name": "name_value", - "slot_capacity": 1391, - "ignore_idle_slots": True, - "autoscale": {"current_slots": 1431, "max_slots": 986}, - "concurrency": 1195, - "creation_time": {"seconds": 751, "nanos": 543}, - "update_time": {}, + "slot_count": 1098, + "plan": 3, + "state": 1, + "commitment_start_time": {"seconds": 751, "nanos": 543}, + "commitment_end_time": {}, + "failure_status": { + "code": 411, + "message": "message_value", + "details": [ + { + "type_url": "type.googleapis.com/google.protobuf.Duration", + "value": b"\x08\x0c\x10\xdb\x07", + } + ], + }, + "renewal_plan": 3, "multi_region_auxiliary": True, "edition": 1, - "primary_location": "primary_location_value", - "secondary_location": "secondary_location_value", - "original_primary_location": "original_primary_location_value", - "max_slots": 986, - "scaling_mode": 1, - "replication_status": { - "error": { - "code": 411, - "message": "message_value", - "details": [ - { - "type_url": "type.googleapis.com/google.protobuf.Duration", - "value": b"\x08\x0c\x10\xdb\x07", - } - ], - }, - "last_error_time": {}, - "last_replication_time": {}, - "soft_failover_start_time": {}, - }, + "is_flat_rate": True, } # The version of a generated dependency at test runtime may differ from the version used during generation. # Delete any fields which are not present in the current runtime dependency # See https://github.com/googleapis/gapic-generator-python/issues/1748 # Determine if the message type is proto-plus or protobuf - test_field = gcbr_reservation.CreateReservationRequest.meta.fields["reservation"] + test_field = reservation.CreateCapacityCommitmentRequest.meta.fields[ + "capacity_commitment" + ] def get_message_fields(field): # Given a field which is a message (composite type), return a list with @@ -15386,7 +20530,7 @@ def get_message_fields(field): # For each item in the sample request, create a list of sub fields which are not present at runtime # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for field, value in request_init["reservation"].items(): # pragma: NO COVER + for field, value in request_init["capacity_commitment"].items(): # pragma: NO COVER result = None is_repeated = False # For repeated fields @@ -15416,27 +20560,24 @@ def get_message_fields(field): subfield = subfield_to_delete.get("subfield") if subfield: if field_repeated: - for i in range(0, len(request_init["reservation"][field])): - del request_init["reservation"][field][i][subfield] + for i in range(0, len(request_init["capacity_commitment"][field])): + del request_init["capacity_commitment"][field][i][subfield] else: - del request_init["reservation"][field][subfield] + del request_init["capacity_commitment"][field][subfield] 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 = gcbr_reservation.Reservation( + return_value = reservation.CapacityCommitment( name="name_value", - slot_capacity=1391, - ignore_idle_slots=True, - concurrency=1195, + slot_count=1098, + plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + state=reservation.CapacityCommitment.State.PENDING, + renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, multi_region_auxiliary=True, - edition=gcbr_reservation.Edition.STANDARD, - primary_location="primary_location_value", - secondary_location="secondary_location_value", - original_primary_location="original_primary_location_value", - max_slots=986, - scaling_mode=gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + edition=reservation.Edition.STANDARD, + is_flat_rate=True, ) # Wrap the value into a proper Response obj @@ -15444,32 +20585,27 @@ def get_message_fields(field): response_value.status_code = 200 # Convert return value to protobuf type - return_value = gcbr_reservation.Reservation.pb(return_value) + return_value = reservation.CapacityCommitment.pb(return_value) json_return_value = json_format.MessageToJson(return_value) response_value.content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.create_reservation(request) + response = client.create_capacity_commitment(request) # Establish that the response is the type that we expect. - assert isinstance(response, gcbr_reservation.Reservation) + assert isinstance(response, reservation.CapacityCommitment) assert response.name == "name_value" - assert response.slot_capacity == 1391 - assert response.ignore_idle_slots is True - assert response.concurrency == 1195 + assert response.slot_count == 1098 + assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.state == reservation.CapacityCommitment.State.PENDING + assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX assert response.multi_region_auxiliary is True - assert response.edition == gcbr_reservation.Edition.STANDARD - assert response.primary_location == "primary_location_value" - assert response.secondary_location == "secondary_location_value" - assert response.original_primary_location == "original_primary_location_value" - assert response.max_slots == 986 - assert ( - response.scaling_mode == gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY - ) + assert response.edition == reservation.Edition.STANDARD + assert response.is_flat_rate is True @pytest.mark.parametrize("null_interceptor", [True, False]) -def test_create_reservation_rest_interceptors(null_interceptor): +def test_create_capacity_commitment_rest_interceptors(null_interceptor): transport = transports.ReservationServiceRestTransport( credentials=ga_credentials.AnonymousCredentials(), interceptor=None @@ -15483,18 +20619,18 @@ def test_create_reservation_rest_interceptors(null_interceptor): ) as req, mock.patch.object( path_template, "transcode" ) as transcode, mock.patch.object( - transports.ReservationServiceRestInterceptor, "post_create_reservation" + transports.ReservationServiceRestInterceptor, "post_create_capacity_commitment" ) as post, mock.patch.object( transports.ReservationServiceRestInterceptor, - "post_create_reservation_with_metadata", + "post_create_capacity_commitment_with_metadata", ) as post_with_metadata, mock.patch.object( - transports.ReservationServiceRestInterceptor, "pre_create_reservation" + transports.ReservationServiceRestInterceptor, "pre_create_capacity_commitment" ) as pre: pre.assert_not_called() post.assert_not_called() post_with_metadata.assert_not_called() - pb_message = gcbr_reservation.CreateReservationRequest.pb( - gcbr_reservation.CreateReservationRequest() + pb_message = reservation.CreateCapacityCommitmentRequest.pb( + reservation.CreateCapacityCommitmentRequest() ) transcode.return_value = { "method": "post", @@ -15506,21 +20642,21 @@ def test_create_reservation_rest_interceptors(null_interceptor): req.return_value = mock.Mock() req.return_value.status_code = 200 req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = gcbr_reservation.Reservation.to_json( - gcbr_reservation.Reservation() + return_value = reservation.CapacityCommitment.to_json( + reservation.CapacityCommitment() ) req.return_value.content = return_value - request = gcbr_reservation.CreateReservationRequest() + request = reservation.CreateCapacityCommitmentRequest() metadata = [ ("key", "val"), ("cephalopod", "squid"), ] pre.return_value = request, metadata - post.return_value = gcbr_reservation.Reservation() - post_with_metadata.return_value = gcbr_reservation.Reservation(), metadata + post.return_value = reservation.CapacityCommitment() + post_with_metadata.return_value = reservation.CapacityCommitment(), metadata - client.create_reservation( + client.create_capacity_commitment( request, metadata=[ ("key", "val"), @@ -15533,8 +20669,8 @@ def test_create_reservation_rest_interceptors(null_interceptor): post_with_metadata.assert_called_once() -def test_list_reservations_rest_bad_request( - request_type=reservation.ListReservationsRequest, +def test_list_capacity_commitments_rest_bad_request( + request_type=reservation.ListCapacityCommitmentsRequest, ): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" @@ -15555,17 +20691,17 @@ def test_list_reservations_rest_bad_request( response_value.request = mock.Mock() req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.list_reservations(request) + client.list_capacity_commitments(request) @pytest.mark.parametrize( "request_type", [ - reservation.ListReservationsRequest, + reservation.ListCapacityCommitmentsRequest, dict, ], ) -def test_list_reservations_rest_call_success(request_type): +def test_list_capacity_commitments_rest_call_success(request_type): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) @@ -15577,7 +20713,7 @@ def test_list_reservations_rest_call_success(request_type): # 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 = reservation.ListReservationsResponse( + return_value = reservation.ListCapacityCommitmentsResponse( next_page_token="next_page_token_value", ) @@ -15586,20 +20722,20 @@ def test_list_reservations_rest_call_success(request_type): response_value.status_code = 200 # Convert return value to protobuf type - return_value = reservation.ListReservationsResponse.pb(return_value) + return_value = reservation.ListCapacityCommitmentsResponse.pb(return_value) json_return_value = json_format.MessageToJson(return_value) response_value.content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.list_reservations(request) + response = client.list_capacity_commitments(request) # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListReservationsPager) + assert isinstance(response, pagers.ListCapacityCommitmentsPager) assert response.next_page_token == "next_page_token_value" @pytest.mark.parametrize("null_interceptor", [True, False]) -def test_list_reservations_rest_interceptors(null_interceptor): +def test_list_capacity_commitments_rest_interceptors(null_interceptor): transport = transports.ReservationServiceRestTransport( credentials=ga_credentials.AnonymousCredentials(), interceptor=None @@ -15613,18 +20749,18 @@ def test_list_reservations_rest_interceptors(null_interceptor): ) as req, mock.patch.object( path_template, "transcode" ) as transcode, mock.patch.object( - transports.ReservationServiceRestInterceptor, "post_list_reservations" + transports.ReservationServiceRestInterceptor, "post_list_capacity_commitments" ) as post, mock.patch.object( transports.ReservationServiceRestInterceptor, - "post_list_reservations_with_metadata", + "post_list_capacity_commitments_with_metadata", ) as post_with_metadata, mock.patch.object( - transports.ReservationServiceRestInterceptor, "pre_list_reservations" + transports.ReservationServiceRestInterceptor, "pre_list_capacity_commitments" ) as pre: pre.assert_not_called() post.assert_not_called() post_with_metadata.assert_not_called() - pb_message = reservation.ListReservationsRequest.pb( - reservation.ListReservationsRequest() + pb_message = reservation.ListCapacityCommitmentsRequest.pb( + reservation.ListCapacityCommitmentsRequest() ) transcode.return_value = { "method": "post", @@ -15636,24 +20772,24 @@ def test_list_reservations_rest_interceptors(null_interceptor): req.return_value = mock.Mock() req.return_value.status_code = 200 req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.ListReservationsResponse.to_json( - reservation.ListReservationsResponse() + return_value = reservation.ListCapacityCommitmentsResponse.to_json( + reservation.ListCapacityCommitmentsResponse() ) req.return_value.content = return_value - request = reservation.ListReservationsRequest() + request = reservation.ListCapacityCommitmentsRequest() metadata = [ ("key", "val"), ("cephalopod", "squid"), ] pre.return_value = request, metadata - post.return_value = reservation.ListReservationsResponse() + post.return_value = reservation.ListCapacityCommitmentsResponse() post_with_metadata.return_value = ( - reservation.ListReservationsResponse(), + reservation.ListCapacityCommitmentsResponse(), metadata, ) - client.list_reservations( + client.list_capacity_commitments( request, metadata=[ ("key", "val"), @@ -15666,14 +20802,16 @@ def test_list_reservations_rest_interceptors(null_interceptor): post_with_metadata.assert_called_once() -def test_get_reservation_rest_bad_request( - request_type=reservation.GetReservationRequest, +def test_get_capacity_commitment_rest_bad_request( + request_type=reservation.GetCapacityCommitmentRequest, ): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding - request_init = {"name": "projects/sample1/locations/sample2/reservations/sample3"} + request_init = { + "name": "projects/sample1/locations/sample2/capacityCommitments/sample3" + } request = request_type(**request_init) # Mock the http request call within the method and fake a BadRequest error. @@ -15688,40 +20826,39 @@ def test_get_reservation_rest_bad_request( response_value.request = mock.Mock() req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.get_reservation(request) + client.get_capacity_commitment(request) @pytest.mark.parametrize( "request_type", [ - reservation.GetReservationRequest, + reservation.GetCapacityCommitmentRequest, dict, ], ) -def test_get_reservation_rest_call_success(request_type): +def test_get_capacity_commitment_rest_call_success(request_type): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding - request_init = {"name": "projects/sample1/locations/sample2/reservations/sample3"} + request_init = { + "name": "projects/sample1/locations/sample2/capacityCommitments/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 = reservation.Reservation( + return_value = reservation.CapacityCommitment( name="name_value", - slot_capacity=1391, - ignore_idle_slots=True, - concurrency=1195, + slot_count=1098, + plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + state=reservation.CapacityCommitment.State.PENDING, + renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, multi_region_auxiliary=True, edition=reservation.Edition.STANDARD, - primary_location="primary_location_value", - secondary_location="secondary_location_value", - original_primary_location="original_primary_location_value", - max_slots=986, - scaling_mode=reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + is_flat_rate=True, ) # Wrap the value into a proper Response obj @@ -15729,30 +20866,27 @@ def test_get_reservation_rest_call_success(request_type): response_value.status_code = 200 # Convert return value to protobuf type - return_value = reservation.Reservation.pb(return_value) + return_value = reservation.CapacityCommitment.pb(return_value) json_return_value = json_format.MessageToJson(return_value) response_value.content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.get_reservation(request) + response = client.get_capacity_commitment(request) # Establish that the response is the type that we expect. - assert isinstance(response, reservation.Reservation) + assert isinstance(response, reservation.CapacityCommitment) assert response.name == "name_value" - assert response.slot_capacity == 1391 - assert response.ignore_idle_slots is True - assert response.concurrency == 1195 + assert response.slot_count == 1098 + assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.state == reservation.CapacityCommitment.State.PENDING + assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX assert response.multi_region_auxiliary is True assert response.edition == reservation.Edition.STANDARD - assert response.primary_location == "primary_location_value" - assert response.secondary_location == "secondary_location_value" - assert response.original_primary_location == "original_primary_location_value" - assert response.max_slots == 986 - assert response.scaling_mode == reservation.Reservation.ScalingMode.AUTOSCALE_ONLY + assert response.is_flat_rate is True @pytest.mark.parametrize("null_interceptor", [True, False]) -def test_get_reservation_rest_interceptors(null_interceptor): +def test_get_capacity_commitment_rest_interceptors(null_interceptor): transport = transports.ReservationServiceRestTransport( credentials=ga_credentials.AnonymousCredentials(), interceptor=None @@ -15766,18 +20900,18 @@ def test_get_reservation_rest_interceptors(null_interceptor): ) as req, mock.patch.object( path_template, "transcode" ) as transcode, mock.patch.object( - transports.ReservationServiceRestInterceptor, "post_get_reservation" + transports.ReservationServiceRestInterceptor, "post_get_capacity_commitment" ) as post, mock.patch.object( transports.ReservationServiceRestInterceptor, - "post_get_reservation_with_metadata", + "post_get_capacity_commitment_with_metadata", ) as post_with_metadata, mock.patch.object( - transports.ReservationServiceRestInterceptor, "pre_get_reservation" + transports.ReservationServiceRestInterceptor, "pre_get_capacity_commitment" ) as pre: pre.assert_not_called() post.assert_not_called() post_with_metadata.assert_not_called() - pb_message = reservation.GetReservationRequest.pb( - reservation.GetReservationRequest() + pb_message = reservation.GetCapacityCommitmentRequest.pb( + reservation.GetCapacityCommitmentRequest() ) transcode.return_value = { "method": "post", @@ -15789,19 +20923,21 @@ def test_get_reservation_rest_interceptors(null_interceptor): req.return_value = mock.Mock() req.return_value.status_code = 200 req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.Reservation.to_json(reservation.Reservation()) + return_value = reservation.CapacityCommitment.to_json( + reservation.CapacityCommitment() + ) req.return_value.content = return_value - request = reservation.GetReservationRequest() + request = reservation.GetCapacityCommitmentRequest() metadata = [ ("key", "val"), ("cephalopod", "squid"), ] pre.return_value = request, metadata - post.return_value = reservation.Reservation() - post_with_metadata.return_value = reservation.Reservation(), metadata + post.return_value = reservation.CapacityCommitment() + post_with_metadata.return_value = reservation.CapacityCommitment(), metadata - client.get_reservation( + client.get_capacity_commitment( request, metadata=[ ("key", "val"), @@ -15814,14 +20950,16 @@ def test_get_reservation_rest_interceptors(null_interceptor): post_with_metadata.assert_called_once() -def test_delete_reservation_rest_bad_request( - request_type=reservation.DeleteReservationRequest, +def test_delete_capacity_commitment_rest_bad_request( + request_type=reservation.DeleteCapacityCommitmentRequest, ): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding - request_init = {"name": "projects/sample1/locations/sample2/reservations/sample3"} + request_init = { + "name": "projects/sample1/locations/sample2/capacityCommitments/sample3" + } request = request_type(**request_init) # Mock the http request call within the method and fake a BadRequest error. @@ -15836,23 +20974,25 @@ def test_delete_reservation_rest_bad_request( response_value.request = mock.Mock() req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.delete_reservation(request) + client.delete_capacity_commitment(request) @pytest.mark.parametrize( "request_type", [ - reservation.DeleteReservationRequest, + reservation.DeleteCapacityCommitmentRequest, dict, ], ) -def test_delete_reservation_rest_call_success(request_type): +def test_delete_capacity_commitment_rest_call_success(request_type): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding - request_init = {"name": "projects/sample1/locations/sample2/reservations/sample3"} + request_init = { + "name": "projects/sample1/locations/sample2/capacityCommitments/sample3" + } request = request_type(**request_init) # Mock the http request call within the method and fake a response. @@ -15867,14 +21007,14 @@ def test_delete_reservation_rest_call_success(request_type): response_value.content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.delete_reservation(request) + response = client.delete_capacity_commitment(request) # Establish that the response is the type that we expect. assert response is None @pytest.mark.parametrize("null_interceptor", [True, False]) -def test_delete_reservation_rest_interceptors(null_interceptor): +def test_delete_capacity_commitment_rest_interceptors(null_interceptor): transport = transports.ReservationServiceRestTransport( credentials=ga_credentials.AnonymousCredentials(), interceptor=None @@ -15888,11 +21028,11 @@ def test_delete_reservation_rest_interceptors(null_interceptor): ) as req, mock.patch.object( path_template, "transcode" ) as transcode, mock.patch.object( - transports.ReservationServiceRestInterceptor, "pre_delete_reservation" + transports.ReservationServiceRestInterceptor, "pre_delete_capacity_commitment" ) as pre: pre.assert_not_called() - pb_message = reservation.DeleteReservationRequest.pb( - reservation.DeleteReservationRequest() + pb_message = reservation.DeleteCapacityCommitmentRequest.pb( + reservation.DeleteCapacityCommitmentRequest() ) transcode.return_value = { "method": "post", @@ -15905,14 +21045,14 @@ def test_delete_reservation_rest_interceptors(null_interceptor): req.return_value.status_code = 200 req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - request = reservation.DeleteReservationRequest() + request = reservation.DeleteCapacityCommitmentRequest() metadata = [ ("key", "val"), ("cephalopod", "squid"), ] pre.return_value = request, metadata - client.delete_reservation( + client.delete_capacity_commitment( request, metadata=[ ("key", "val"), @@ -15923,16 +21063,16 @@ def test_delete_reservation_rest_interceptors(null_interceptor): pre.assert_called_once() -def test_update_reservation_rest_bad_request( - request_type=gcbr_reservation.UpdateReservationRequest, +def test_update_capacity_commitment_rest_bad_request( + request_type=reservation.UpdateCapacityCommitmentRequest, ): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding request_init = { - "reservation": { - "name": "projects/sample1/locations/sample2/reservations/sample3" + "capacity_commitment": { + "name": "projects/sample1/locations/sample2/capacityCommitments/sample3" } } request = request_type(**request_init) @@ -15949,64 +21089,57 @@ def test_update_reservation_rest_bad_request( response_value.request = mock.Mock() req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.update_reservation(request) + client.update_capacity_commitment(request) @pytest.mark.parametrize( "request_type", [ - gcbr_reservation.UpdateReservationRequest, + reservation.UpdateCapacityCommitmentRequest, dict, ], ) -def test_update_reservation_rest_call_success(request_type): +def test_update_capacity_commitment_rest_call_success(request_type): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding request_init = { - "reservation": { - "name": "projects/sample1/locations/sample2/reservations/sample3" + "capacity_commitment": { + "name": "projects/sample1/locations/sample2/capacityCommitments/sample3" } } - request_init["reservation"] = { - "name": "projects/sample1/locations/sample2/reservations/sample3", - "slot_capacity": 1391, - "ignore_idle_slots": True, - "autoscale": {"current_slots": 1431, "max_slots": 986}, - "concurrency": 1195, - "creation_time": {"seconds": 751, "nanos": 543}, - "update_time": {}, + request_init["capacity_commitment"] = { + "name": "projects/sample1/locations/sample2/capacityCommitments/sample3", + "slot_count": 1098, + "plan": 3, + "state": 1, + "commitment_start_time": {"seconds": 751, "nanos": 543}, + "commitment_end_time": {}, + "failure_status": { + "code": 411, + "message": "message_value", + "details": [ + { + "type_url": "type.googleapis.com/google.protobuf.Duration", + "value": b"\x08\x0c\x10\xdb\x07", + } + ], + }, + "renewal_plan": 3, "multi_region_auxiliary": True, "edition": 1, - "primary_location": "primary_location_value", - "secondary_location": "secondary_location_value", - "original_primary_location": "original_primary_location_value", - "max_slots": 986, - "scaling_mode": 1, - "replication_status": { - "error": { - "code": 411, - "message": "message_value", - "details": [ - { - "type_url": "type.googleapis.com/google.protobuf.Duration", - "value": b"\x08\x0c\x10\xdb\x07", - } - ], - }, - "last_error_time": {}, - "last_replication_time": {}, - "soft_failover_start_time": {}, - }, + "is_flat_rate": True, } # The version of a generated dependency at test runtime may differ from the version used during generation. # Delete any fields which are not present in the current runtime dependency # See https://github.com/googleapis/gapic-generator-python/issues/1748 # Determine if the message type is proto-plus or protobuf - test_field = gcbr_reservation.UpdateReservationRequest.meta.fields["reservation"] + test_field = reservation.UpdateCapacityCommitmentRequest.meta.fields[ + "capacity_commitment" + ] def get_message_fields(field): # Given a field which is a message (composite type), return a list with @@ -16034,7 +21167,7 @@ def get_message_fields(field): # For each item in the sample request, create a list of sub fields which are not present at runtime # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for field, value in request_init["reservation"].items(): # pragma: NO COVER + for field, value in request_init["capacity_commitment"].items(): # pragma: NO COVER result = None is_repeated = False # For repeated fields @@ -16064,27 +21197,24 @@ def get_message_fields(field): subfield = subfield_to_delete.get("subfield") if subfield: if field_repeated: - for i in range(0, len(request_init["reservation"][field])): - del request_init["reservation"][field][i][subfield] + for i in range(0, len(request_init["capacity_commitment"][field])): + del request_init["capacity_commitment"][field][i][subfield] else: - del request_init["reservation"][field][subfield] + del request_init["capacity_commitment"][field][subfield] 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 = gcbr_reservation.Reservation( + return_value = reservation.CapacityCommitment( name="name_value", - slot_capacity=1391, - ignore_idle_slots=True, - concurrency=1195, + slot_count=1098, + plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, + state=reservation.CapacityCommitment.State.PENDING, + renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, multi_region_auxiliary=True, - edition=gcbr_reservation.Edition.STANDARD, - primary_location="primary_location_value", - secondary_location="secondary_location_value", - original_primary_location="original_primary_location_value", - max_slots=986, - scaling_mode=gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, + edition=reservation.Edition.STANDARD, + is_flat_rate=True, ) # Wrap the value into a proper Response obj @@ -16092,32 +21222,27 @@ def get_message_fields(field): response_value.status_code = 200 # Convert return value to protobuf type - return_value = gcbr_reservation.Reservation.pb(return_value) + return_value = reservation.CapacityCommitment.pb(return_value) json_return_value = json_format.MessageToJson(return_value) response_value.content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.update_reservation(request) + response = client.update_capacity_commitment(request) # Establish that the response is the type that we expect. - assert isinstance(response, gcbr_reservation.Reservation) + assert isinstance(response, reservation.CapacityCommitment) assert response.name == "name_value" - assert response.slot_capacity == 1391 - assert response.ignore_idle_slots is True - assert response.concurrency == 1195 + assert response.slot_count == 1098 + assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX + assert response.state == reservation.CapacityCommitment.State.PENDING + assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX assert response.multi_region_auxiliary is True - assert response.edition == gcbr_reservation.Edition.STANDARD - assert response.primary_location == "primary_location_value" - assert response.secondary_location == "secondary_location_value" - assert response.original_primary_location == "original_primary_location_value" - assert response.max_slots == 986 - assert ( - response.scaling_mode == gcbr_reservation.Reservation.ScalingMode.AUTOSCALE_ONLY - ) + assert response.edition == reservation.Edition.STANDARD + assert response.is_flat_rate is True @pytest.mark.parametrize("null_interceptor", [True, False]) -def test_update_reservation_rest_interceptors(null_interceptor): +def test_update_capacity_commitment_rest_interceptors(null_interceptor): transport = transports.ReservationServiceRestTransport( credentials=ga_credentials.AnonymousCredentials(), interceptor=None @@ -16131,18 +21256,18 @@ def test_update_reservation_rest_interceptors(null_interceptor): ) as req, mock.patch.object( path_template, "transcode" ) as transcode, mock.patch.object( - transports.ReservationServiceRestInterceptor, "post_update_reservation" + transports.ReservationServiceRestInterceptor, "post_update_capacity_commitment" ) as post, mock.patch.object( transports.ReservationServiceRestInterceptor, - "post_update_reservation_with_metadata", + "post_update_capacity_commitment_with_metadata", ) as post_with_metadata, mock.patch.object( - transports.ReservationServiceRestInterceptor, "pre_update_reservation" + transports.ReservationServiceRestInterceptor, "pre_update_capacity_commitment" ) as pre: pre.assert_not_called() post.assert_not_called() post_with_metadata.assert_not_called() - pb_message = gcbr_reservation.UpdateReservationRequest.pb( - gcbr_reservation.UpdateReservationRequest() + pb_message = reservation.UpdateCapacityCommitmentRequest.pb( + reservation.UpdateCapacityCommitmentRequest() ) transcode.return_value = { "method": "post", @@ -16154,21 +21279,21 @@ def test_update_reservation_rest_interceptors(null_interceptor): req.return_value = mock.Mock() req.return_value.status_code = 200 req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = gcbr_reservation.Reservation.to_json( - gcbr_reservation.Reservation() + return_value = reservation.CapacityCommitment.to_json( + reservation.CapacityCommitment() ) req.return_value.content = return_value - request = gcbr_reservation.UpdateReservationRequest() + request = reservation.UpdateCapacityCommitmentRequest() metadata = [ ("key", "val"), ("cephalopod", "squid"), ] pre.return_value = request, metadata - post.return_value = gcbr_reservation.Reservation() - post_with_metadata.return_value = gcbr_reservation.Reservation(), metadata + post.return_value = reservation.CapacityCommitment() + post_with_metadata.return_value = reservation.CapacityCommitment(), metadata - client.update_reservation( + client.update_capacity_commitment( request, metadata=[ ("key", "val"), @@ -16181,14 +21306,16 @@ def test_update_reservation_rest_interceptors(null_interceptor): post_with_metadata.assert_called_once() -def test_failover_reservation_rest_bad_request( - request_type=reservation.FailoverReservationRequest, +def test_split_capacity_commitment_rest_bad_request( + request_type=reservation.SplitCapacityCommitmentRequest, ): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding - request_init = {"name": "projects/sample1/locations/sample2/reservations/sample3"} + request_init = { + "name": "projects/sample1/locations/sample2/capacityCommitments/sample3" + } request = request_type(**request_init) # Mock the http request call within the method and fake a BadRequest error. @@ -16203,71 +21330,50 @@ def test_failover_reservation_rest_bad_request( response_value.request = mock.Mock() req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.failover_reservation(request) + client.split_capacity_commitment(request) @pytest.mark.parametrize( "request_type", [ - reservation.FailoverReservationRequest, + reservation.SplitCapacityCommitmentRequest, dict, ], ) -def test_failover_reservation_rest_call_success(request_type): +def test_split_capacity_commitment_rest_call_success(request_type): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding - request_init = {"name": "projects/sample1/locations/sample2/reservations/sample3"} + request_init = { + "name": "projects/sample1/locations/sample2/capacityCommitments/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 = reservation.Reservation( - name="name_value", - slot_capacity=1391, - ignore_idle_slots=True, - concurrency=1195, - multi_region_auxiliary=True, - edition=reservation.Edition.STANDARD, - primary_location="primary_location_value", - secondary_location="secondary_location_value", - original_primary_location="original_primary_location_value", - max_slots=986, - scaling_mode=reservation.Reservation.ScalingMode.AUTOSCALE_ONLY, - ) + return_value = reservation.SplitCapacityCommitmentResponse() # Wrap the value into a proper Response obj response_value = mock.Mock() response_value.status_code = 200 # Convert return value to protobuf type - return_value = reservation.Reservation.pb(return_value) + return_value = reservation.SplitCapacityCommitmentResponse.pb(return_value) json_return_value = json_format.MessageToJson(return_value) response_value.content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.failover_reservation(request) + response = client.split_capacity_commitment(request) # Establish that the response is the type that we expect. - assert isinstance(response, reservation.Reservation) - assert response.name == "name_value" - assert response.slot_capacity == 1391 - assert response.ignore_idle_slots is True - assert response.concurrency == 1195 - assert response.multi_region_auxiliary is True - assert response.edition == reservation.Edition.STANDARD - assert response.primary_location == "primary_location_value" - assert response.secondary_location == "secondary_location_value" - assert response.original_primary_location == "original_primary_location_value" - assert response.max_slots == 986 - assert response.scaling_mode == reservation.Reservation.ScalingMode.AUTOSCALE_ONLY + assert isinstance(response, reservation.SplitCapacityCommitmentResponse) @pytest.mark.parametrize("null_interceptor", [True, False]) -def test_failover_reservation_rest_interceptors(null_interceptor): +def test_split_capacity_commitment_rest_interceptors(null_interceptor): transport = transports.ReservationServiceRestTransport( credentials=ga_credentials.AnonymousCredentials(), interceptor=None @@ -16281,18 +21387,18 @@ def test_failover_reservation_rest_interceptors(null_interceptor): ) as req, mock.patch.object( path_template, "transcode" ) as transcode, mock.patch.object( - transports.ReservationServiceRestInterceptor, "post_failover_reservation" + transports.ReservationServiceRestInterceptor, "post_split_capacity_commitment" ) as post, mock.patch.object( transports.ReservationServiceRestInterceptor, - "post_failover_reservation_with_metadata", + "post_split_capacity_commitment_with_metadata", ) as post_with_metadata, mock.patch.object( - transports.ReservationServiceRestInterceptor, "pre_failover_reservation" + transports.ReservationServiceRestInterceptor, "pre_split_capacity_commitment" ) as pre: pre.assert_not_called() post.assert_not_called() post_with_metadata.assert_not_called() - pb_message = reservation.FailoverReservationRequest.pb( - reservation.FailoverReservationRequest() + pb_message = reservation.SplitCapacityCommitmentRequest.pb( + reservation.SplitCapacityCommitmentRequest() ) transcode.return_value = { "method": "post", @@ -16304,19 +21410,24 @@ def test_failover_reservation_rest_interceptors(null_interceptor): req.return_value = mock.Mock() req.return_value.status_code = 200 req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.Reservation.to_json(reservation.Reservation()) + return_value = reservation.SplitCapacityCommitmentResponse.to_json( + reservation.SplitCapacityCommitmentResponse() + ) req.return_value.content = return_value - request = reservation.FailoverReservationRequest() + request = reservation.SplitCapacityCommitmentRequest() metadata = [ ("key", "val"), ("cephalopod", "squid"), ] pre.return_value = request, metadata - post.return_value = reservation.Reservation() - post_with_metadata.return_value = reservation.Reservation(), metadata + post.return_value = reservation.SplitCapacityCommitmentResponse() + post_with_metadata.return_value = ( + reservation.SplitCapacityCommitmentResponse(), + metadata, + ) - client.failover_reservation( + client.split_capacity_commitment( request, metadata=[ ("key", "val"), @@ -16329,8 +21440,8 @@ def test_failover_reservation_rest_interceptors(null_interceptor): post_with_metadata.assert_called_once() -def test_create_capacity_commitment_rest_bad_request( - request_type=reservation.CreateCapacityCommitmentRequest, +def test_merge_capacity_commitments_rest_bad_request( + request_type=reservation.MergeCapacityCommitmentsRequest, ): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" @@ -16351,114 +21462,23 @@ def test_create_capacity_commitment_rest_bad_request( response_value.request = mock.Mock() req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.create_capacity_commitment(request) + client.merge_capacity_commitments(request) @pytest.mark.parametrize( "request_type", [ - reservation.CreateCapacityCommitmentRequest, + reservation.MergeCapacityCommitmentsRequest, dict, ], ) -def test_create_capacity_commitment_rest_call_success(request_type): +def test_merge_capacity_commitments_rest_call_success(request_type): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding request_init = {"parent": "projects/sample1/locations/sample2"} - request_init["capacity_commitment"] = { - "name": "name_value", - "slot_count": 1098, - "plan": 3, - "state": 1, - "commitment_start_time": {"seconds": 751, "nanos": 543}, - "commitment_end_time": {}, - "failure_status": { - "code": 411, - "message": "message_value", - "details": [ - { - "type_url": "type.googleapis.com/google.protobuf.Duration", - "value": b"\x08\x0c\x10\xdb\x07", - } - ], - }, - "renewal_plan": 3, - "multi_region_auxiliary": True, - "edition": 1, - "is_flat_rate": True, - } - # The version of a generated dependency at test runtime may differ from the version used during generation. - # Delete any fields which are not present in the current runtime dependency - # See https://github.com/googleapis/gapic-generator-python/issues/1748 - - # Determine if the message type is proto-plus or protobuf - test_field = reservation.CreateCapacityCommitmentRequest.meta.fields[ - "capacity_commitment" - ] - - def get_message_fields(field): - # Given a field which is a message (composite type), return a list with - # all the fields of the message. - # If the field is not a composite type, return an empty list. - message_fields = [] - - if hasattr(field, "message") and field.message: - is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") - - if is_field_type_proto_plus_type: - message_fields = field.message.meta.fields.values() - # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types - else: # pragma: NO COVER - message_fields = field.message.DESCRIPTOR.fields - return message_fields - - runtime_nested_fields = [ - (field.name, nested_field.name) - for field in get_message_fields(test_field) - for nested_field in get_message_fields(field) - ] - - subfields_not_in_runtime = [] - - # For each item in the sample request, create a list of sub fields which are not present at runtime - # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for field, value in request_init["capacity_commitment"].items(): # pragma: NO COVER - result = None - is_repeated = False - # For repeated fields - if isinstance(value, list) and len(value): - is_repeated = True - result = value[0] - # For fields where the type is another message - if isinstance(value, dict): - result = value - - if result and hasattr(result, "keys"): - for subfield in result.keys(): - if (field, subfield) not in runtime_nested_fields: - subfields_not_in_runtime.append( - { - "field": field, - "subfield": subfield, - "is_repeated": is_repeated, - } - ) - - # Remove fields from the sample request which are not present in the runtime version of the dependency - # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER - field = subfield_to_delete.get("field") - field_repeated = subfield_to_delete.get("is_repeated") - subfield = subfield_to_delete.get("subfield") - if subfield: - if field_repeated: - for i in range(0, len(request_init["capacity_commitment"][field])): - del request_init["capacity_commitment"][field][i][subfield] - else: - del request_init["capacity_commitment"][field][subfield] request = request_type(**request_init) # Mock the http request call within the method and fake a response. @@ -16485,7 +21505,7 @@ def get_message_fields(field): response_value.content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.create_capacity_commitment(request) + response = client.merge_capacity_commitments(request) # Establish that the response is the type that we expect. assert isinstance(response, reservation.CapacityCommitment) @@ -16500,7 +21520,7 @@ def get_message_fields(field): @pytest.mark.parametrize("null_interceptor", [True, False]) -def test_create_capacity_commitment_rest_interceptors(null_interceptor): +def test_merge_capacity_commitments_rest_interceptors(null_interceptor): transport = transports.ReservationServiceRestTransport( credentials=ga_credentials.AnonymousCredentials(), interceptor=None @@ -16514,18 +21534,18 @@ def test_create_capacity_commitment_rest_interceptors(null_interceptor): ) as req, mock.patch.object( path_template, "transcode" ) as transcode, mock.patch.object( - transports.ReservationServiceRestInterceptor, "post_create_capacity_commitment" + transports.ReservationServiceRestInterceptor, "post_merge_capacity_commitments" ) as post, mock.patch.object( transports.ReservationServiceRestInterceptor, - "post_create_capacity_commitment_with_metadata", + "post_merge_capacity_commitments_with_metadata", ) as post_with_metadata, mock.patch.object( - transports.ReservationServiceRestInterceptor, "pre_create_capacity_commitment" + transports.ReservationServiceRestInterceptor, "pre_merge_capacity_commitments" ) as pre: pre.assert_not_called() post.assert_not_called() post_with_metadata.assert_not_called() - pb_message = reservation.CreateCapacityCommitmentRequest.pb( - reservation.CreateCapacityCommitmentRequest() + pb_message = reservation.MergeCapacityCommitmentsRequest.pb( + reservation.MergeCapacityCommitmentsRequest() ) transcode.return_value = { "method": "post", @@ -16542,7 +21562,7 @@ def test_create_capacity_commitment_rest_interceptors(null_interceptor): ) req.return_value.content = return_value - request = reservation.CreateCapacityCommitmentRequest() + request = reservation.MergeCapacityCommitmentsRequest() metadata = [ ("key", "val"), ("cephalopod", "squid"), @@ -16551,7 +21571,7 @@ def test_create_capacity_commitment_rest_interceptors(null_interceptor): post.return_value = reservation.CapacityCommitment() post_with_metadata.return_value = reservation.CapacityCommitment(), metadata - client.create_capacity_commitment( + client.merge_capacity_commitments( request, metadata=[ ("key", "val"), @@ -16564,14 +21584,14 @@ def test_create_capacity_commitment_rest_interceptors(null_interceptor): post_with_metadata.assert_called_once() -def test_list_capacity_commitments_rest_bad_request( - request_type=reservation.ListCapacityCommitmentsRequest, +def test_create_assignment_rest_bad_request( + request_type=reservation.CreateAssignmentRequest, ): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding - request_init = {"parent": "projects/sample1/locations/sample2"} + request_init = {"parent": "projects/sample1/locations/sample2/reservations/sample3"} request = request_type(**request_init) # Mock the http request call within the method and fake a BadRequest error. @@ -16586,30 +21606,109 @@ def test_list_capacity_commitments_rest_bad_request( response_value.request = mock.Mock() req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.list_capacity_commitments(request) + client.create_assignment(request) @pytest.mark.parametrize( "request_type", [ - reservation.ListCapacityCommitmentsRequest, + reservation.CreateAssignmentRequest, dict, ], ) -def test_list_capacity_commitments_rest_call_success(request_type): +def test_create_assignment_rest_call_success(request_type): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding - request_init = {"parent": "projects/sample1/locations/sample2"} + request_init = {"parent": "projects/sample1/locations/sample2/reservations/sample3"} + request_init["assignment"] = { + "name": "name_value", + "assignee": "assignee_value", + "job_type": 1, + "state": 1, + "enable_gemini_in_bigquery": True, + "scheduling_policy": {"concurrency": 1195, "max_slots": 986}, + } + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = reservation.CreateAssignmentRequest.meta.fields["assignment"] + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["assignment"].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + { + "field": field, + "subfield": subfield, + "is_repeated": is_repeated, + } + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["assignment"][field])): + del request_init["assignment"][field][i][subfield] + else: + del request_init["assignment"][field][subfield] 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 = reservation.ListCapacityCommitmentsResponse( - next_page_token="next_page_token_value", + return_value = reservation.Assignment( + name="name_value", + assignee="assignee_value", + job_type=reservation.Assignment.JobType.PIPELINE, + state=reservation.Assignment.State.PENDING, + enable_gemini_in_bigquery=True, ) # Wrap the value into a proper Response obj @@ -16617,20 +21716,24 @@ def test_list_capacity_commitments_rest_call_success(request_type): response_value.status_code = 200 # Convert return value to protobuf type - return_value = reservation.ListCapacityCommitmentsResponse.pb(return_value) + return_value = reservation.Assignment.pb(return_value) json_return_value = json_format.MessageToJson(return_value) response_value.content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.list_capacity_commitments(request) + response = client.create_assignment(request) # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListCapacityCommitmentsPager) - assert response.next_page_token == "next_page_token_value" + assert isinstance(response, reservation.Assignment) + assert response.name == "name_value" + assert response.assignee == "assignee_value" + assert response.job_type == reservation.Assignment.JobType.PIPELINE + assert response.state == reservation.Assignment.State.PENDING + assert response.enable_gemini_in_bigquery is True @pytest.mark.parametrize("null_interceptor", [True, False]) -def test_list_capacity_commitments_rest_interceptors(null_interceptor): +def test_create_assignment_rest_interceptors(null_interceptor): transport = transports.ReservationServiceRestTransport( credentials=ga_credentials.AnonymousCredentials(), interceptor=None @@ -16644,18 +21747,18 @@ def test_list_capacity_commitments_rest_interceptors(null_interceptor): ) as req, mock.patch.object( path_template, "transcode" ) as transcode, mock.patch.object( - transports.ReservationServiceRestInterceptor, "post_list_capacity_commitments" + transports.ReservationServiceRestInterceptor, "post_create_assignment" ) as post, mock.patch.object( transports.ReservationServiceRestInterceptor, - "post_list_capacity_commitments_with_metadata", + "post_create_assignment_with_metadata", ) as post_with_metadata, mock.patch.object( - transports.ReservationServiceRestInterceptor, "pre_list_capacity_commitments" + transports.ReservationServiceRestInterceptor, "pre_create_assignment" ) as pre: pre.assert_not_called() post.assert_not_called() post_with_metadata.assert_not_called() - pb_message = reservation.ListCapacityCommitmentsRequest.pb( - reservation.ListCapacityCommitmentsRequest() + pb_message = reservation.CreateAssignmentRequest.pb( + reservation.CreateAssignmentRequest() ) transcode.return_value = { "method": "post", @@ -16667,24 +21770,19 @@ def test_list_capacity_commitments_rest_interceptors(null_interceptor): req.return_value = mock.Mock() req.return_value.status_code = 200 req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.ListCapacityCommitmentsResponse.to_json( - reservation.ListCapacityCommitmentsResponse() - ) + return_value = reservation.Assignment.to_json(reservation.Assignment()) req.return_value.content = return_value - request = reservation.ListCapacityCommitmentsRequest() + request = reservation.CreateAssignmentRequest() metadata = [ ("key", "val"), ("cephalopod", "squid"), ] pre.return_value = request, metadata - post.return_value = reservation.ListCapacityCommitmentsResponse() - post_with_metadata.return_value = ( - reservation.ListCapacityCommitmentsResponse(), - metadata, - ) + post.return_value = reservation.Assignment() + post_with_metadata.return_value = reservation.Assignment(), metadata - client.list_capacity_commitments( + client.create_assignment( request, metadata=[ ("key", "val"), @@ -16697,16 +21795,14 @@ def test_list_capacity_commitments_rest_interceptors(null_interceptor): post_with_metadata.assert_called_once() -def test_get_capacity_commitment_rest_bad_request( - request_type=reservation.GetCapacityCommitmentRequest, +def test_list_assignments_rest_bad_request( + request_type=reservation.ListAssignmentsRequest, ): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding - request_init = { - "name": "projects/sample1/locations/sample2/capacityCommitments/sample3" - } + request_init = {"parent": "projects/sample1/locations/sample2/reservations/sample3"} request = request_type(**request_init) # Mock the http request call within the method and fake a BadRequest error. @@ -16721,39 +21817,30 @@ def test_get_capacity_commitment_rest_bad_request( response_value.request = mock.Mock() req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.get_capacity_commitment(request) + client.list_assignments(request) @pytest.mark.parametrize( "request_type", [ - reservation.GetCapacityCommitmentRequest, + reservation.ListAssignmentsRequest, dict, ], ) -def test_get_capacity_commitment_rest_call_success(request_type): +def test_list_assignments_rest_call_success(request_type): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding - request_init = { - "name": "projects/sample1/locations/sample2/capacityCommitments/sample3" - } + request_init = {"parent": "projects/sample1/locations/sample2/reservations/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 = reservation.CapacityCommitment( - name="name_value", - slot_count=1098, - plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - state=reservation.CapacityCommitment.State.PENDING, - renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - multi_region_auxiliary=True, - edition=reservation.Edition.STANDARD, - is_flat_rate=True, + return_value = reservation.ListAssignmentsResponse( + next_page_token="next_page_token_value", ) # Wrap the value into a proper Response obj @@ -16761,27 +21848,20 @@ def test_get_capacity_commitment_rest_call_success(request_type): response_value.status_code = 200 # Convert return value to protobuf type - return_value = reservation.CapacityCommitment.pb(return_value) + return_value = reservation.ListAssignmentsResponse.pb(return_value) json_return_value = json_format.MessageToJson(return_value) response_value.content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.get_capacity_commitment(request) + response = client.list_assignments(request) # Establish that the response is the type that we expect. - assert isinstance(response, reservation.CapacityCommitment) - assert response.name == "name_value" - assert response.slot_count == 1098 - assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.state == reservation.CapacityCommitment.State.PENDING - assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.multi_region_auxiliary is True - assert response.edition == reservation.Edition.STANDARD - assert response.is_flat_rate is True + assert isinstance(response, pagers.ListAssignmentsPager) + assert response.next_page_token == "next_page_token_value" @pytest.mark.parametrize("null_interceptor", [True, False]) -def test_get_capacity_commitment_rest_interceptors(null_interceptor): +def test_list_assignments_rest_interceptors(null_interceptor): transport = transports.ReservationServiceRestTransport( credentials=ga_credentials.AnonymousCredentials(), interceptor=None @@ -16795,18 +21875,18 @@ def test_get_capacity_commitment_rest_interceptors(null_interceptor): ) as req, mock.patch.object( path_template, "transcode" ) as transcode, mock.patch.object( - transports.ReservationServiceRestInterceptor, "post_get_capacity_commitment" + transports.ReservationServiceRestInterceptor, "post_list_assignments" ) as post, mock.patch.object( transports.ReservationServiceRestInterceptor, - "post_get_capacity_commitment_with_metadata", + "post_list_assignments_with_metadata", ) as post_with_metadata, mock.patch.object( - transports.ReservationServiceRestInterceptor, "pre_get_capacity_commitment" + transports.ReservationServiceRestInterceptor, "pre_list_assignments" ) as pre: pre.assert_not_called() post.assert_not_called() post_with_metadata.assert_not_called() - pb_message = reservation.GetCapacityCommitmentRequest.pb( - reservation.GetCapacityCommitmentRequest() + pb_message = reservation.ListAssignmentsRequest.pb( + reservation.ListAssignmentsRequest() ) transcode.return_value = { "method": "post", @@ -16818,21 +21898,24 @@ def test_get_capacity_commitment_rest_interceptors(null_interceptor): req.return_value = mock.Mock() req.return_value.status_code = 200 req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.CapacityCommitment.to_json( - reservation.CapacityCommitment() + return_value = reservation.ListAssignmentsResponse.to_json( + reservation.ListAssignmentsResponse() ) req.return_value.content = return_value - request = reservation.GetCapacityCommitmentRequest() + request = reservation.ListAssignmentsRequest() metadata = [ ("key", "val"), ("cephalopod", "squid"), ] pre.return_value = request, metadata - post.return_value = reservation.CapacityCommitment() - post_with_metadata.return_value = reservation.CapacityCommitment(), metadata + post.return_value = reservation.ListAssignmentsResponse() + post_with_metadata.return_value = ( + reservation.ListAssignmentsResponse(), + metadata, + ) - client.get_capacity_commitment( + client.list_assignments( request, metadata=[ ("key", "val"), @@ -16845,15 +21928,15 @@ def test_get_capacity_commitment_rest_interceptors(null_interceptor): post_with_metadata.assert_called_once() -def test_delete_capacity_commitment_rest_bad_request( - request_type=reservation.DeleteCapacityCommitmentRequest, +def test_delete_assignment_rest_bad_request( + request_type=reservation.DeleteAssignmentRequest, ): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding request_init = { - "name": "projects/sample1/locations/sample2/capacityCommitments/sample3" + "name": "projects/sample1/locations/sample2/reservations/sample3/assignments/sample4" } request = request_type(**request_init) @@ -16869,24 +21952,24 @@ def test_delete_capacity_commitment_rest_bad_request( response_value.request = mock.Mock() req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.delete_capacity_commitment(request) + client.delete_assignment(request) @pytest.mark.parametrize( "request_type", [ - reservation.DeleteCapacityCommitmentRequest, + reservation.DeleteAssignmentRequest, dict, ], ) -def test_delete_capacity_commitment_rest_call_success(request_type): +def test_delete_assignment_rest_call_success(request_type): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding request_init = { - "name": "projects/sample1/locations/sample2/capacityCommitments/sample3" + "name": "projects/sample1/locations/sample2/reservations/sample3/assignments/sample4" } request = request_type(**request_init) @@ -16902,14 +21985,14 @@ def test_delete_capacity_commitment_rest_call_success(request_type): response_value.content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.delete_capacity_commitment(request) + response = client.delete_assignment(request) # Establish that the response is the type that we expect. assert response is None @pytest.mark.parametrize("null_interceptor", [True, False]) -def test_delete_capacity_commitment_rest_interceptors(null_interceptor): +def test_delete_assignment_rest_interceptors(null_interceptor): transport = transports.ReservationServiceRestTransport( credentials=ga_credentials.AnonymousCredentials(), interceptor=None @@ -16923,11 +22006,11 @@ def test_delete_capacity_commitment_rest_interceptors(null_interceptor): ) as req, mock.patch.object( path_template, "transcode" ) as transcode, mock.patch.object( - transports.ReservationServiceRestInterceptor, "pre_delete_capacity_commitment" + transports.ReservationServiceRestInterceptor, "pre_delete_assignment" ) as pre: pre.assert_not_called() - pb_message = reservation.DeleteCapacityCommitmentRequest.pb( - reservation.DeleteCapacityCommitmentRequest() + pb_message = reservation.DeleteAssignmentRequest.pb( + reservation.DeleteAssignmentRequest() ) transcode.return_value = { "method": "post", @@ -16940,14 +22023,14 @@ def test_delete_capacity_commitment_rest_interceptors(null_interceptor): req.return_value.status_code = 200 req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - request = reservation.DeleteCapacityCommitmentRequest() + request = reservation.DeleteAssignmentRequest() metadata = [ ("key", "val"), ("cephalopod", "squid"), ] pre.return_value = request, metadata - client.delete_capacity_commitment( + client.delete_assignment( request, metadata=[ ("key", "val"), @@ -16958,158 +22041,52 @@ def test_delete_capacity_commitment_rest_interceptors(null_interceptor): pre.assert_called_once() -def test_update_capacity_commitment_rest_bad_request( - request_type=reservation.UpdateCapacityCommitmentRequest, -): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), transport="rest" - ) - # send a request that will satisfy transcoding - request_init = { - "capacity_commitment": { - "name": "projects/sample1/locations/sample2/capacityCommitments/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 = mock.Mock() - json_return_value = "" - response_value.json = mock.Mock(return_value={}) - response_value.status_code = 400 - response_value.request = mock.Mock() - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.update_capacity_commitment(request) - - -@pytest.mark.parametrize( - "request_type", - [ - reservation.UpdateCapacityCommitmentRequest, - dict, - ], -) -def test_update_capacity_commitment_rest_call_success(request_type): - client = ReservationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), transport="rest" - ) - - # send a request that will satisfy transcoding - request_init = { - "capacity_commitment": { - "name": "projects/sample1/locations/sample2/capacityCommitments/sample3" - } - } - request_init["capacity_commitment"] = { - "name": "projects/sample1/locations/sample2/capacityCommitments/sample3", - "slot_count": 1098, - "plan": 3, - "state": 1, - "commitment_start_time": {"seconds": 751, "nanos": 543}, - "commitment_end_time": {}, - "failure_status": { - "code": 411, - "message": "message_value", - "details": [ - { - "type_url": "type.googleapis.com/google.protobuf.Duration", - "value": b"\x08\x0c\x10\xdb\x07", - } - ], - }, - "renewal_plan": 3, - "multi_region_auxiliary": True, - "edition": 1, - "is_flat_rate": True, - } - # The version of a generated dependency at test runtime may differ from the version used during generation. - # Delete any fields which are not present in the current runtime dependency - # See https://github.com/googleapis/gapic-generator-python/issues/1748 - - # Determine if the message type is proto-plus or protobuf - test_field = reservation.UpdateCapacityCommitmentRequest.meta.fields[ - "capacity_commitment" - ] - - def get_message_fields(field): - # Given a field which is a message (composite type), return a list with - # all the fields of the message. - # If the field is not a composite type, return an empty list. - message_fields = [] - - if hasattr(field, "message") and field.message: - is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") - - if is_field_type_proto_plus_type: - message_fields = field.message.meta.fields.values() - # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types - else: # pragma: NO COVER - message_fields = field.message.DESCRIPTOR.fields - return message_fields - - runtime_nested_fields = [ - (field.name, nested_field.name) - for field in get_message_fields(test_field) - for nested_field in get_message_fields(field) - ] +def test_search_assignments_rest_bad_request( + request_type=reservation.SearchAssignmentsRequest, +): + client = ReservationServiceClient( + 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) - subfields_not_in_runtime = [] + # 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 = mock.Mock() + json_return_value = "" + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.search_assignments(request) - # For each item in the sample request, create a list of sub fields which are not present at runtime - # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for field, value in request_init["capacity_commitment"].items(): # pragma: NO COVER - result = None - is_repeated = False - # For repeated fields - if isinstance(value, list) and len(value): - is_repeated = True - result = value[0] - # For fields where the type is another message - if isinstance(value, dict): - result = value - if result and hasattr(result, "keys"): - for subfield in result.keys(): - if (field, subfield) not in runtime_nested_fields: - subfields_not_in_runtime.append( - { - "field": field, - "subfield": subfield, - "is_repeated": is_repeated, - } - ) +@pytest.mark.parametrize( + "request_type", + [ + reservation.SearchAssignmentsRequest, + dict, + ], +) +def test_search_assignments_rest_call_success(request_type): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) - # Remove fields from the sample request which are not present in the runtime version of the dependency - # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER - field = subfield_to_delete.get("field") - field_repeated = subfield_to_delete.get("is_repeated") - subfield = subfield_to_delete.get("subfield") - if subfield: - if field_repeated: - for i in range(0, len(request_init["capacity_commitment"][field])): - del request_init["capacity_commitment"][field][i][subfield] - else: - del request_init["capacity_commitment"][field][subfield] + # 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 = reservation.CapacityCommitment( - name="name_value", - slot_count=1098, - plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - state=reservation.CapacityCommitment.State.PENDING, - renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - multi_region_auxiliary=True, - edition=reservation.Edition.STANDARD, - is_flat_rate=True, + return_value = reservation.SearchAssignmentsResponse( + next_page_token="next_page_token_value", ) # Wrap the value into a proper Response obj @@ -17117,27 +22094,20 @@ def get_message_fields(field): response_value.status_code = 200 # Convert return value to protobuf type - return_value = reservation.CapacityCommitment.pb(return_value) + return_value = reservation.SearchAssignmentsResponse.pb(return_value) json_return_value = json_format.MessageToJson(return_value) response_value.content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.update_capacity_commitment(request) + response = client.search_assignments(request) # Establish that the response is the type that we expect. - assert isinstance(response, reservation.CapacityCommitment) - assert response.name == "name_value" - assert response.slot_count == 1098 - assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.state == reservation.CapacityCommitment.State.PENDING - assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.multi_region_auxiliary is True - assert response.edition == reservation.Edition.STANDARD - assert response.is_flat_rate is True + assert isinstance(response, pagers.SearchAssignmentsPager) + assert response.next_page_token == "next_page_token_value" @pytest.mark.parametrize("null_interceptor", [True, False]) -def test_update_capacity_commitment_rest_interceptors(null_interceptor): +def test_search_assignments_rest_interceptors(null_interceptor): transport = transports.ReservationServiceRestTransport( credentials=ga_credentials.AnonymousCredentials(), interceptor=None @@ -17151,18 +22121,18 @@ def test_update_capacity_commitment_rest_interceptors(null_interceptor): ) as req, mock.patch.object( path_template, "transcode" ) as transcode, mock.patch.object( - transports.ReservationServiceRestInterceptor, "post_update_capacity_commitment" + transports.ReservationServiceRestInterceptor, "post_search_assignments" ) as post, mock.patch.object( transports.ReservationServiceRestInterceptor, - "post_update_capacity_commitment_with_metadata", + "post_search_assignments_with_metadata", ) as post_with_metadata, mock.patch.object( - transports.ReservationServiceRestInterceptor, "pre_update_capacity_commitment" + transports.ReservationServiceRestInterceptor, "pre_search_assignments" ) as pre: pre.assert_not_called() post.assert_not_called() post_with_metadata.assert_not_called() - pb_message = reservation.UpdateCapacityCommitmentRequest.pb( - reservation.UpdateCapacityCommitmentRequest() + pb_message = reservation.SearchAssignmentsRequest.pb( + reservation.SearchAssignmentsRequest() ) transcode.return_value = { "method": "post", @@ -17174,21 +22144,24 @@ def test_update_capacity_commitment_rest_interceptors(null_interceptor): req.return_value = mock.Mock() req.return_value.status_code = 200 req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.CapacityCommitment.to_json( - reservation.CapacityCommitment() + return_value = reservation.SearchAssignmentsResponse.to_json( + reservation.SearchAssignmentsResponse() ) req.return_value.content = return_value - request = reservation.UpdateCapacityCommitmentRequest() + request = reservation.SearchAssignmentsRequest() metadata = [ ("key", "val"), ("cephalopod", "squid"), ] pre.return_value = request, metadata - post.return_value = reservation.CapacityCommitment() - post_with_metadata.return_value = reservation.CapacityCommitment(), metadata + post.return_value = reservation.SearchAssignmentsResponse() + post_with_metadata.return_value = ( + reservation.SearchAssignmentsResponse(), + metadata, + ) - client.update_capacity_commitment( + client.search_assignments( request, metadata=[ ("key", "val"), @@ -17201,16 +22174,14 @@ def test_update_capacity_commitment_rest_interceptors(null_interceptor): post_with_metadata.assert_called_once() -def test_split_capacity_commitment_rest_bad_request( - request_type=reservation.SplitCapacityCommitmentRequest, +def test_search_all_assignments_rest_bad_request( + request_type=reservation.SearchAllAssignmentsRequest, ): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding - request_init = { - "name": "projects/sample1/locations/sample2/capacityCommitments/sample3" - } + 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. @@ -17225,50 +22196,51 @@ def test_split_capacity_commitment_rest_bad_request( response_value.request = mock.Mock() req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.split_capacity_commitment(request) + client.search_all_assignments(request) @pytest.mark.parametrize( "request_type", [ - reservation.SplitCapacityCommitmentRequest, + reservation.SearchAllAssignmentsRequest, dict, ], ) -def test_split_capacity_commitment_rest_call_success(request_type): +def test_search_all_assignments_rest_call_success(request_type): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding - request_init = { - "name": "projects/sample1/locations/sample2/capacityCommitments/sample3" - } + 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 = reservation.SplitCapacityCommitmentResponse() + return_value = reservation.SearchAllAssignmentsResponse( + next_page_token="next_page_token_value", + ) # Wrap the value into a proper Response obj response_value = mock.Mock() response_value.status_code = 200 # Convert return value to protobuf type - return_value = reservation.SplitCapacityCommitmentResponse.pb(return_value) + return_value = reservation.SearchAllAssignmentsResponse.pb(return_value) json_return_value = json_format.MessageToJson(return_value) response_value.content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.split_capacity_commitment(request) + response = client.search_all_assignments(request) # Establish that the response is the type that we expect. - assert isinstance(response, reservation.SplitCapacityCommitmentResponse) + assert isinstance(response, pagers.SearchAllAssignmentsPager) + assert response.next_page_token == "next_page_token_value" @pytest.mark.parametrize("null_interceptor", [True, False]) -def test_split_capacity_commitment_rest_interceptors(null_interceptor): +def test_search_all_assignments_rest_interceptors(null_interceptor): transport = transports.ReservationServiceRestTransport( credentials=ga_credentials.AnonymousCredentials(), interceptor=None @@ -17282,18 +22254,18 @@ def test_split_capacity_commitment_rest_interceptors(null_interceptor): ) as req, mock.patch.object( path_template, "transcode" ) as transcode, mock.patch.object( - transports.ReservationServiceRestInterceptor, "post_split_capacity_commitment" + transports.ReservationServiceRestInterceptor, "post_search_all_assignments" ) as post, mock.patch.object( transports.ReservationServiceRestInterceptor, - "post_split_capacity_commitment_with_metadata", + "post_search_all_assignments_with_metadata", ) as post_with_metadata, mock.patch.object( - transports.ReservationServiceRestInterceptor, "pre_split_capacity_commitment" + transports.ReservationServiceRestInterceptor, "pre_search_all_assignments" ) as pre: pre.assert_not_called() post.assert_not_called() post_with_metadata.assert_not_called() - pb_message = reservation.SplitCapacityCommitmentRequest.pb( - reservation.SplitCapacityCommitmentRequest() + pb_message = reservation.SearchAllAssignmentsRequest.pb( + reservation.SearchAllAssignmentsRequest() ) transcode.return_value = { "method": "post", @@ -17305,24 +22277,24 @@ def test_split_capacity_commitment_rest_interceptors(null_interceptor): req.return_value = mock.Mock() req.return_value.status_code = 200 req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.SplitCapacityCommitmentResponse.to_json( - reservation.SplitCapacityCommitmentResponse() + return_value = reservation.SearchAllAssignmentsResponse.to_json( + reservation.SearchAllAssignmentsResponse() ) req.return_value.content = return_value - request = reservation.SplitCapacityCommitmentRequest() + request = reservation.SearchAllAssignmentsRequest() metadata = [ ("key", "val"), ("cephalopod", "squid"), ] pre.return_value = request, metadata - post.return_value = reservation.SplitCapacityCommitmentResponse() + post.return_value = reservation.SearchAllAssignmentsResponse() post_with_metadata.return_value = ( - reservation.SplitCapacityCommitmentResponse(), + reservation.SearchAllAssignmentsResponse(), metadata, ) - client.split_capacity_commitment( + client.search_all_assignments( request, metadata=[ ("key", "val"), @@ -17335,14 +22307,16 @@ def test_split_capacity_commitment_rest_interceptors(null_interceptor): post_with_metadata.assert_called_once() -def test_merge_capacity_commitments_rest_bad_request( - request_type=reservation.MergeCapacityCommitmentsRequest, +def test_move_assignment_rest_bad_request( + request_type=reservation.MoveAssignmentRequest, ): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding - request_init = {"parent": "projects/sample1/locations/sample2"} + request_init = { + "name": "projects/sample1/locations/sample2/reservations/sample3/assignments/sample4" + } request = request_type(**request_init) # Mock the http request call within the method and fake a BadRequest error. @@ -17357,37 +22331,36 @@ def test_merge_capacity_commitments_rest_bad_request( response_value.request = mock.Mock() req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.merge_capacity_commitments(request) + client.move_assignment(request) @pytest.mark.parametrize( "request_type", [ - reservation.MergeCapacityCommitmentsRequest, + reservation.MoveAssignmentRequest, dict, ], ) -def test_merge_capacity_commitments_rest_call_success(request_type): +def test_move_assignment_rest_call_success(request_type): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding - request_init = {"parent": "projects/sample1/locations/sample2"} + request_init = { + "name": "projects/sample1/locations/sample2/reservations/sample3/assignments/sample4" + } 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 = reservation.CapacityCommitment( + return_value = reservation.Assignment( name="name_value", - slot_count=1098, - plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - state=reservation.CapacityCommitment.State.PENDING, - renewal_plan=reservation.CapacityCommitment.CommitmentPlan.FLEX, - multi_region_auxiliary=True, - edition=reservation.Edition.STANDARD, - is_flat_rate=True, + assignee="assignee_value", + job_type=reservation.Assignment.JobType.PIPELINE, + state=reservation.Assignment.State.PENDING, + enable_gemini_in_bigquery=True, ) # Wrap the value into a proper Response obj @@ -17395,27 +22368,24 @@ def test_merge_capacity_commitments_rest_call_success(request_type): response_value.status_code = 200 # Convert return value to protobuf type - return_value = reservation.CapacityCommitment.pb(return_value) + return_value = reservation.Assignment.pb(return_value) json_return_value = json_format.MessageToJson(return_value) response_value.content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.merge_capacity_commitments(request) + response = client.move_assignment(request) # Establish that the response is the type that we expect. - assert isinstance(response, reservation.CapacityCommitment) + assert isinstance(response, reservation.Assignment) assert response.name == "name_value" - assert response.slot_count == 1098 - assert response.plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.state == reservation.CapacityCommitment.State.PENDING - assert response.renewal_plan == reservation.CapacityCommitment.CommitmentPlan.FLEX - assert response.multi_region_auxiliary is True - assert response.edition == reservation.Edition.STANDARD - assert response.is_flat_rate is True + assert response.assignee == "assignee_value" + assert response.job_type == reservation.Assignment.JobType.PIPELINE + assert response.state == reservation.Assignment.State.PENDING + assert response.enable_gemini_in_bigquery is True @pytest.mark.parametrize("null_interceptor", [True, False]) -def test_merge_capacity_commitments_rest_interceptors(null_interceptor): +def test_move_assignment_rest_interceptors(null_interceptor): transport = transports.ReservationServiceRestTransport( credentials=ga_credentials.AnonymousCredentials(), interceptor=None @@ -17429,18 +22399,18 @@ def test_merge_capacity_commitments_rest_interceptors(null_interceptor): ) as req, mock.patch.object( path_template, "transcode" ) as transcode, mock.patch.object( - transports.ReservationServiceRestInterceptor, "post_merge_capacity_commitments" + transports.ReservationServiceRestInterceptor, "post_move_assignment" ) as post, mock.patch.object( transports.ReservationServiceRestInterceptor, - "post_merge_capacity_commitments_with_metadata", + "post_move_assignment_with_metadata", ) as post_with_metadata, mock.patch.object( - transports.ReservationServiceRestInterceptor, "pre_merge_capacity_commitments" + transports.ReservationServiceRestInterceptor, "pre_move_assignment" ) as pre: pre.assert_not_called() post.assert_not_called() post_with_metadata.assert_not_called() - pb_message = reservation.MergeCapacityCommitmentsRequest.pb( - reservation.MergeCapacityCommitmentsRequest() + pb_message = reservation.MoveAssignmentRequest.pb( + reservation.MoveAssignmentRequest() ) transcode.return_value = { "method": "post", @@ -17452,21 +22422,19 @@ def test_merge_capacity_commitments_rest_interceptors(null_interceptor): req.return_value = mock.Mock() req.return_value.status_code = 200 req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.CapacityCommitment.to_json( - reservation.CapacityCommitment() - ) + return_value = reservation.Assignment.to_json(reservation.Assignment()) req.return_value.content = return_value - request = reservation.MergeCapacityCommitmentsRequest() + request = reservation.MoveAssignmentRequest() metadata = [ ("key", "val"), ("cephalopod", "squid"), ] pre.return_value = request, metadata - post.return_value = reservation.CapacityCommitment() - post_with_metadata.return_value = reservation.CapacityCommitment(), metadata + post.return_value = reservation.Assignment() + post_with_metadata.return_value = reservation.Assignment(), metadata - client.merge_capacity_commitments( + client.move_assignment( request, metadata=[ ("key", "val"), @@ -17479,14 +22447,18 @@ def test_merge_capacity_commitments_rest_interceptors(null_interceptor): post_with_metadata.assert_called_once() -def test_create_assignment_rest_bad_request( - request_type=reservation.CreateAssignmentRequest, +def test_update_assignment_rest_bad_request( + request_type=reservation.UpdateAssignmentRequest, ): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding - request_init = {"parent": "projects/sample1/locations/sample2/reservations/sample3"} + request_init = { + "assignment": { + "name": "projects/sample1/locations/sample2/reservations/sample3/assignments/sample4" + } + } request = request_type(**request_init) # Mock the http request call within the method and fake a BadRequest error. @@ -17501,36 +22473,41 @@ def test_create_assignment_rest_bad_request( response_value.request = mock.Mock() req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.create_assignment(request) + client.update_assignment(request) @pytest.mark.parametrize( "request_type", [ - reservation.CreateAssignmentRequest, + reservation.UpdateAssignmentRequest, dict, ], ) -def test_create_assignment_rest_call_success(request_type): +def test_update_assignment_rest_call_success(request_type): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding - request_init = {"parent": "projects/sample1/locations/sample2/reservations/sample3"} + request_init = { + "assignment": { + "name": "projects/sample1/locations/sample2/reservations/sample3/assignments/sample4" + } + } request_init["assignment"] = { - "name": "name_value", + "name": "projects/sample1/locations/sample2/reservations/sample3/assignments/sample4", "assignee": "assignee_value", "job_type": 1, "state": 1, "enable_gemini_in_bigquery": True, + "scheduling_policy": {"concurrency": 1195, "max_slots": 986}, } # The version of a generated dependency at test runtime may differ from the version used during generation. # Delete any fields which are not present in the current runtime dependency # See https://github.com/googleapis/gapic-generator-python/issues/1748 # Determine if the message type is proto-plus or protobuf - test_field = reservation.CreateAssignmentRequest.meta.fields["assignment"] + test_field = reservation.UpdateAssignmentRequest.meta.fields["assignment"] def get_message_fields(field): # Given a field which is a message (composite type), return a list with @@ -17615,7 +22592,7 @@ def get_message_fields(field): response_value.content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.create_assignment(request) + response = client.update_assignment(request) # Establish that the response is the type that we expect. assert isinstance(response, reservation.Assignment) @@ -17627,7 +22604,7 @@ def get_message_fields(field): @pytest.mark.parametrize("null_interceptor", [True, False]) -def test_create_assignment_rest_interceptors(null_interceptor): +def test_update_assignment_rest_interceptors(null_interceptor): transport = transports.ReservationServiceRestTransport( credentials=ga_credentials.AnonymousCredentials(), interceptor=None @@ -17641,18 +22618,18 @@ def test_create_assignment_rest_interceptors(null_interceptor): ) as req, mock.patch.object( path_template, "transcode" ) as transcode, mock.patch.object( - transports.ReservationServiceRestInterceptor, "post_create_assignment" + transports.ReservationServiceRestInterceptor, "post_update_assignment" ) as post, mock.patch.object( transports.ReservationServiceRestInterceptor, - "post_create_assignment_with_metadata", + "post_update_assignment_with_metadata", ) as post_with_metadata, mock.patch.object( - transports.ReservationServiceRestInterceptor, "pre_create_assignment" + transports.ReservationServiceRestInterceptor, "pre_update_assignment" ) as pre: pre.assert_not_called() post.assert_not_called() post_with_metadata.assert_not_called() - pb_message = reservation.CreateAssignmentRequest.pb( - reservation.CreateAssignmentRequest() + pb_message = reservation.UpdateAssignmentRequest.pb( + reservation.UpdateAssignmentRequest() ) transcode.return_value = { "method": "post", @@ -17667,7 +22644,7 @@ def test_create_assignment_rest_interceptors(null_interceptor): return_value = reservation.Assignment.to_json(reservation.Assignment()) req.return_value.content = return_value - request = reservation.CreateAssignmentRequest() + request = reservation.UpdateAssignmentRequest() metadata = [ ("key", "val"), ("cephalopod", "squid"), @@ -17676,7 +22653,7 @@ def test_create_assignment_rest_interceptors(null_interceptor): post.return_value = reservation.Assignment() post_with_metadata.return_value = reservation.Assignment(), metadata - client.create_assignment( + client.update_assignment( request, metadata=[ ("key", "val"), @@ -17689,14 +22666,14 @@ def test_create_assignment_rest_interceptors(null_interceptor): post_with_metadata.assert_called_once() -def test_list_assignments_rest_bad_request( - request_type=reservation.ListAssignmentsRequest, +def test_get_bi_reservation_rest_bad_request( + request_type=reservation.GetBiReservationRequest, ): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding - request_init = {"parent": "projects/sample1/locations/sample2/reservations/sample3"} + request_init = {"name": "projects/sample1/locations/sample2/biReservation"} request = request_type(**request_init) # Mock the http request call within the method and fake a BadRequest error. @@ -17711,30 +22688,31 @@ def test_list_assignments_rest_bad_request( response_value.request = mock.Mock() req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.list_assignments(request) + client.get_bi_reservation(request) @pytest.mark.parametrize( "request_type", [ - reservation.ListAssignmentsRequest, + reservation.GetBiReservationRequest, dict, ], ) -def test_list_assignments_rest_call_success(request_type): +def test_get_bi_reservation_rest_call_success(request_type): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding - request_init = {"parent": "projects/sample1/locations/sample2/reservations/sample3"} + request_init = {"name": "projects/sample1/locations/sample2/biReservation"} 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 = reservation.ListAssignmentsResponse( - next_page_token="next_page_token_value", + return_value = reservation.BiReservation( + name="name_value", + size=443, ) # Wrap the value into a proper Response obj @@ -17742,20 +22720,21 @@ def test_list_assignments_rest_call_success(request_type): response_value.status_code = 200 # Convert return value to protobuf type - return_value = reservation.ListAssignmentsResponse.pb(return_value) + return_value = reservation.BiReservation.pb(return_value) json_return_value = json_format.MessageToJson(return_value) response_value.content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.list_assignments(request) + response = client.get_bi_reservation(request) # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListAssignmentsPager) - assert response.next_page_token == "next_page_token_value" + assert isinstance(response, reservation.BiReservation) + assert response.name == "name_value" + assert response.size == 443 @pytest.mark.parametrize("null_interceptor", [True, False]) -def test_list_assignments_rest_interceptors(null_interceptor): +def test_get_bi_reservation_rest_interceptors(null_interceptor): transport = transports.ReservationServiceRestTransport( credentials=ga_credentials.AnonymousCredentials(), interceptor=None @@ -17769,18 +22748,18 @@ def test_list_assignments_rest_interceptors(null_interceptor): ) as req, mock.patch.object( path_template, "transcode" ) as transcode, mock.patch.object( - transports.ReservationServiceRestInterceptor, "post_list_assignments" + transports.ReservationServiceRestInterceptor, "post_get_bi_reservation" ) as post, mock.patch.object( transports.ReservationServiceRestInterceptor, - "post_list_assignments_with_metadata", + "post_get_bi_reservation_with_metadata", ) as post_with_metadata, mock.patch.object( - transports.ReservationServiceRestInterceptor, "pre_list_assignments" + transports.ReservationServiceRestInterceptor, "pre_get_bi_reservation" ) as pre: pre.assert_not_called() post.assert_not_called() post_with_metadata.assert_not_called() - pb_message = reservation.ListAssignmentsRequest.pb( - reservation.ListAssignmentsRequest() + pb_message = reservation.GetBiReservationRequest.pb( + reservation.GetBiReservationRequest() ) transcode.return_value = { "method": "post", @@ -17792,24 +22771,19 @@ def test_list_assignments_rest_interceptors(null_interceptor): req.return_value = mock.Mock() req.return_value.status_code = 200 req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.ListAssignmentsResponse.to_json( - reservation.ListAssignmentsResponse() - ) + return_value = reservation.BiReservation.to_json(reservation.BiReservation()) req.return_value.content = return_value - request = reservation.ListAssignmentsRequest() + request = reservation.GetBiReservationRequest() metadata = [ ("key", "val"), ("cephalopod", "squid"), ] pre.return_value = request, metadata - post.return_value = reservation.ListAssignmentsResponse() - post_with_metadata.return_value = ( - reservation.ListAssignmentsResponse(), - metadata, - ) + post.return_value = reservation.BiReservation() + post_with_metadata.return_value = reservation.BiReservation(), metadata - client.list_assignments( + client.get_bi_reservation( request, metadata=[ ("key", "val"), @@ -17822,15 +22796,15 @@ def test_list_assignments_rest_interceptors(null_interceptor): post_with_metadata.assert_called_once() -def test_delete_assignment_rest_bad_request( - request_type=reservation.DeleteAssignmentRequest, +def test_update_bi_reservation_rest_bad_request( + request_type=reservation.UpdateBiReservationRequest, ): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding request_init = { - "name": "projects/sample1/locations/sample2/reservations/sample3/assignments/sample4" + "bi_reservation": {"name": "projects/sample1/locations/sample2/biReservation"} } request = request_type(**request_init) @@ -17846,47 +22820,134 @@ def test_delete_assignment_rest_bad_request( response_value.request = mock.Mock() req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.delete_assignment(request) + client.update_bi_reservation(request) @pytest.mark.parametrize( "request_type", [ - reservation.DeleteAssignmentRequest, + reservation.UpdateBiReservationRequest, dict, ], ) -def test_delete_assignment_rest_call_success(request_type): +def test_update_bi_reservation_rest_call_success(request_type): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding request_init = { - "name": "projects/sample1/locations/sample2/reservations/sample3/assignments/sample4" + "bi_reservation": {"name": "projects/sample1/locations/sample2/biReservation"} + } + request_init["bi_reservation"] = { + "name": "projects/sample1/locations/sample2/biReservation", + "update_time": {"seconds": 751, "nanos": 543}, + "size": 443, + "preferred_tables": [ + { + "project_id": "project_id_value", + "dataset_id": "dataset_id_value", + "table_id": "table_id_value", + } + ], } + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = reservation.UpdateBiReservationRequest.meta.fields["bi_reservation"] + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["bi_reservation"].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + { + "field": field, + "subfield": subfield, + "is_repeated": is_repeated, + } + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["bi_reservation"][field])): + del request_init["bi_reservation"][field][i][subfield] + else: + del request_init["bi_reservation"][field][subfield] 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 + return_value = reservation.BiReservation( + name="name_value", + size=443, + ) # Wrap the value into a proper Response obj response_value = mock.Mock() response_value.status_code = 200 - json_return_value = "" + + # Convert return value to protobuf type + return_value = reservation.BiReservation.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) response_value.content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.delete_assignment(request) + response = client.update_bi_reservation(request) # Establish that the response is the type that we expect. - assert response is None + assert isinstance(response, reservation.BiReservation) + assert response.name == "name_value" + assert response.size == 443 @pytest.mark.parametrize("null_interceptor", [True, False]) -def test_delete_assignment_rest_interceptors(null_interceptor): +def test_update_bi_reservation_rest_interceptors(null_interceptor): transport = transports.ReservationServiceRestTransport( credentials=ga_credentials.AnonymousCredentials(), interceptor=None @@ -17900,11 +22961,18 @@ def test_delete_assignment_rest_interceptors(null_interceptor): ) as req, mock.patch.object( path_template, "transcode" ) as transcode, mock.patch.object( - transports.ReservationServiceRestInterceptor, "pre_delete_assignment" + transports.ReservationServiceRestInterceptor, "post_update_bi_reservation" + ) as post, mock.patch.object( + transports.ReservationServiceRestInterceptor, + "post_update_bi_reservation_with_metadata", + ) as post_with_metadata, mock.patch.object( + transports.ReservationServiceRestInterceptor, "pre_update_bi_reservation" ) as pre: pre.assert_not_called() - pb_message = reservation.DeleteAssignmentRequest.pb( - reservation.DeleteAssignmentRequest() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = reservation.UpdateBiReservationRequest.pb( + reservation.UpdateBiReservationRequest() ) transcode.return_value = { "method": "post", @@ -17916,15 +22984,19 @@ def test_delete_assignment_rest_interceptors(null_interceptor): req.return_value = mock.Mock() req.return_value.status_code = 200 req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = reservation.BiReservation.to_json(reservation.BiReservation()) + req.return_value.content = return_value - request = reservation.DeleteAssignmentRequest() + request = reservation.UpdateBiReservationRequest() metadata = [ ("key", "val"), ("cephalopod", "squid"), ] pre.return_value = request, metadata + post.return_value = reservation.BiReservation() + post_with_metadata.return_value = reservation.BiReservation(), metadata - client.delete_assignment( + client.update_bi_reservation( request, metadata=[ ("key", "val"), @@ -17933,16 +23005,20 @@ def test_delete_assignment_rest_interceptors(null_interceptor): ) pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() -def test_search_assignments_rest_bad_request( - request_type=reservation.SearchAssignmentsRequest, +def test_get_iam_policy_rest_bad_request( + request_type=iam_policy_pb2.GetIamPolicyRequest, ): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding - request_init = {"parent": "projects/sample1/locations/sample2"} + request_init = { + "resource": "projects/sample1/locations/sample2/reservations/sample3" + } request = request_type(**request_init) # Mock the http request call within the method and fake a BadRequest error. @@ -17957,51 +23033,52 @@ def test_search_assignments_rest_bad_request( response_value.request = mock.Mock() req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.search_assignments(request) + client.get_iam_policy(request) @pytest.mark.parametrize( "request_type", [ - reservation.SearchAssignmentsRequest, + iam_policy_pb2.GetIamPolicyRequest, dict, ], ) -def test_search_assignments_rest_call_success(request_type): +def test_get_iam_policy_rest_call_success(request_type): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding - request_init = {"parent": "projects/sample1/locations/sample2"} + request_init = { + "resource": "projects/sample1/locations/sample2/reservations/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 = reservation.SearchAssignmentsResponse( - next_page_token="next_page_token_value", + return_value = policy_pb2.Policy( + version=774, + etag=b"etag_blob", ) # Wrap the value into a proper Response obj response_value = mock.Mock() response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = reservation.SearchAssignmentsResponse.pb(return_value) json_return_value = json_format.MessageToJson(return_value) response_value.content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.search_assignments(request) + response = client.get_iam_policy(request) # Establish that the response is the type that we expect. - assert isinstance(response, pagers.SearchAssignmentsPager) - assert response.next_page_token == "next_page_token_value" + assert isinstance(response, policy_pb2.Policy) + assert response.version == 774 + assert response.etag == b"etag_blob" @pytest.mark.parametrize("null_interceptor", [True, False]) -def test_search_assignments_rest_interceptors(null_interceptor): +def test_get_iam_policy_rest_interceptors(null_interceptor): transport = transports.ReservationServiceRestTransport( credentials=ga_credentials.AnonymousCredentials(), interceptor=None @@ -18015,19 +23092,17 @@ def test_search_assignments_rest_interceptors(null_interceptor): ) as req, mock.patch.object( path_template, "transcode" ) as transcode, mock.patch.object( - transports.ReservationServiceRestInterceptor, "post_search_assignments" + transports.ReservationServiceRestInterceptor, "post_get_iam_policy" ) as post, mock.patch.object( transports.ReservationServiceRestInterceptor, - "post_search_assignments_with_metadata", + "post_get_iam_policy_with_metadata", ) as post_with_metadata, mock.patch.object( - transports.ReservationServiceRestInterceptor, "pre_search_assignments" + transports.ReservationServiceRestInterceptor, "pre_get_iam_policy" ) as pre: pre.assert_not_called() post.assert_not_called() post_with_metadata.assert_not_called() - pb_message = reservation.SearchAssignmentsRequest.pb( - reservation.SearchAssignmentsRequest() - ) + pb_message = iam_policy_pb2.GetIamPolicyRequest() transcode.return_value = { "method": "post", "uri": "my_uri", @@ -18036,26 +23111,21 @@ def test_search_assignments_rest_interceptors(null_interceptor): } req.return_value = mock.Mock() - req.return_value.status_code = 200 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.SearchAssignmentsResponse.to_json( - reservation.SearchAssignmentsResponse() - ) + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = json_format.MessageToJson(policy_pb2.Policy()) req.return_value.content = return_value - request = reservation.SearchAssignmentsRequest() + request = iam_policy_pb2.GetIamPolicyRequest() metadata = [ ("key", "val"), ("cephalopod", "squid"), ] pre.return_value = request, metadata - post.return_value = reservation.SearchAssignmentsResponse() - post_with_metadata.return_value = ( - reservation.SearchAssignmentsResponse(), - metadata, - ) + post.return_value = policy_pb2.Policy() + post_with_metadata.return_value = policy_pb2.Policy(), metadata - client.search_assignments( + client.get_iam_policy( request, metadata=[ ("key", "val"), @@ -18068,14 +23138,16 @@ def test_search_assignments_rest_interceptors(null_interceptor): post_with_metadata.assert_called_once() -def test_search_all_assignments_rest_bad_request( - request_type=reservation.SearchAllAssignmentsRequest, +def test_set_iam_policy_rest_bad_request( + request_type=iam_policy_pb2.SetIamPolicyRequest, ): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding - request_init = {"parent": "projects/sample1/locations/sample2"} + request_init = { + "resource": "projects/sample1/locations/sample2/reservations/sample3" + } request = request_type(**request_init) # Mock the http request call within the method and fake a BadRequest error. @@ -18090,51 +23162,52 @@ def test_search_all_assignments_rest_bad_request( response_value.request = mock.Mock() req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.search_all_assignments(request) + client.set_iam_policy(request) @pytest.mark.parametrize( "request_type", [ - reservation.SearchAllAssignmentsRequest, + iam_policy_pb2.SetIamPolicyRequest, dict, ], ) -def test_search_all_assignments_rest_call_success(request_type): +def test_set_iam_policy_rest_call_success(request_type): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding - request_init = {"parent": "projects/sample1/locations/sample2"} + request_init = { + "resource": "projects/sample1/locations/sample2/reservations/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 = reservation.SearchAllAssignmentsResponse( - next_page_token="next_page_token_value", + return_value = policy_pb2.Policy( + version=774, + etag=b"etag_blob", ) # Wrap the value into a proper Response obj response_value = mock.Mock() response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = reservation.SearchAllAssignmentsResponse.pb(return_value) json_return_value = json_format.MessageToJson(return_value) response_value.content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.search_all_assignments(request) + response = client.set_iam_policy(request) # Establish that the response is the type that we expect. - assert isinstance(response, pagers.SearchAllAssignmentsPager) - assert response.next_page_token == "next_page_token_value" + assert isinstance(response, policy_pb2.Policy) + assert response.version == 774 + assert response.etag == b"etag_blob" @pytest.mark.parametrize("null_interceptor", [True, False]) -def test_search_all_assignments_rest_interceptors(null_interceptor): +def test_set_iam_policy_rest_interceptors(null_interceptor): transport = transports.ReservationServiceRestTransport( credentials=ga_credentials.AnonymousCredentials(), interceptor=None @@ -18148,19 +23221,17 @@ def test_search_all_assignments_rest_interceptors(null_interceptor): ) as req, mock.patch.object( path_template, "transcode" ) as transcode, mock.patch.object( - transports.ReservationServiceRestInterceptor, "post_search_all_assignments" + transports.ReservationServiceRestInterceptor, "post_set_iam_policy" ) as post, mock.patch.object( transports.ReservationServiceRestInterceptor, - "post_search_all_assignments_with_metadata", + "post_set_iam_policy_with_metadata", ) as post_with_metadata, mock.patch.object( - transports.ReservationServiceRestInterceptor, "pre_search_all_assignments" + transports.ReservationServiceRestInterceptor, "pre_set_iam_policy" ) as pre: pre.assert_not_called() post.assert_not_called() post_with_metadata.assert_not_called() - pb_message = reservation.SearchAllAssignmentsRequest.pb( - reservation.SearchAllAssignmentsRequest() - ) + pb_message = iam_policy_pb2.SetIamPolicyRequest() transcode.return_value = { "method": "post", "uri": "my_uri", @@ -18171,24 +23242,19 @@ def test_search_all_assignments_rest_interceptors(null_interceptor): req.return_value = mock.Mock() req.return_value.status_code = 200 req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.SearchAllAssignmentsResponse.to_json( - reservation.SearchAllAssignmentsResponse() - ) + return_value = json_format.MessageToJson(policy_pb2.Policy()) req.return_value.content = return_value - request = reservation.SearchAllAssignmentsRequest() + request = iam_policy_pb2.SetIamPolicyRequest() metadata = [ ("key", "val"), ("cephalopod", "squid"), ] pre.return_value = request, metadata - post.return_value = reservation.SearchAllAssignmentsResponse() - post_with_metadata.return_value = ( - reservation.SearchAllAssignmentsResponse(), - metadata, - ) + post.return_value = policy_pb2.Policy() + post_with_metadata.return_value = policy_pb2.Policy(), metadata - client.search_all_assignments( + client.set_iam_policy( request, metadata=[ ("key", "val"), @@ -18201,15 +23267,15 @@ def test_search_all_assignments_rest_interceptors(null_interceptor): post_with_metadata.assert_called_once() -def test_move_assignment_rest_bad_request( - request_type=reservation.MoveAssignmentRequest, +def test_test_iam_permissions_rest_bad_request( + request_type=iam_policy_pb2.TestIamPermissionsRequest, ): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding request_init = { - "name": "projects/sample1/locations/sample2/reservations/sample3/assignments/sample4" + "resource": "projects/sample1/locations/sample2/reservations/sample3" } request = request_type(**request_init) @@ -18225,61 +23291,50 @@ def test_move_assignment_rest_bad_request( response_value.request = mock.Mock() req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.move_assignment(request) + client.test_iam_permissions(request) @pytest.mark.parametrize( "request_type", [ - reservation.MoveAssignmentRequest, + iam_policy_pb2.TestIamPermissionsRequest, dict, ], ) -def test_move_assignment_rest_call_success(request_type): +def test_test_iam_permissions_rest_call_success(request_type): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding request_init = { - "name": "projects/sample1/locations/sample2/reservations/sample3/assignments/sample4" + "resource": "projects/sample1/locations/sample2/reservations/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 = reservation.Assignment( - name="name_value", - assignee="assignee_value", - job_type=reservation.Assignment.JobType.PIPELINE, - state=reservation.Assignment.State.PENDING, - enable_gemini_in_bigquery=True, + return_value = iam_policy_pb2.TestIamPermissionsResponse( + permissions=["permissions_value"], ) # Wrap the value into a proper Response obj response_value = mock.Mock() response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = reservation.Assignment.pb(return_value) json_return_value = json_format.MessageToJson(return_value) response_value.content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.move_assignment(request) + response = client.test_iam_permissions(request) # Establish that the response is the type that we expect. - assert isinstance(response, reservation.Assignment) - assert response.name == "name_value" - assert response.assignee == "assignee_value" - assert response.job_type == reservation.Assignment.JobType.PIPELINE - assert response.state == reservation.Assignment.State.PENDING - assert response.enable_gemini_in_bigquery is True + assert isinstance(response, iam_policy_pb2.TestIamPermissionsResponse) + assert response.permissions == ["permissions_value"] @pytest.mark.parametrize("null_interceptor", [True, False]) -def test_move_assignment_rest_interceptors(null_interceptor): +def test_test_iam_permissions_rest_interceptors(null_interceptor): transport = transports.ReservationServiceRestTransport( credentials=ga_credentials.AnonymousCredentials(), interceptor=None @@ -18293,19 +23348,17 @@ def test_move_assignment_rest_interceptors(null_interceptor): ) as req, mock.patch.object( path_template, "transcode" ) as transcode, mock.patch.object( - transports.ReservationServiceRestInterceptor, "post_move_assignment" + transports.ReservationServiceRestInterceptor, "post_test_iam_permissions" ) as post, mock.patch.object( transports.ReservationServiceRestInterceptor, - "post_move_assignment_with_metadata", + "post_test_iam_permissions_with_metadata", ) as post_with_metadata, mock.patch.object( - transports.ReservationServiceRestInterceptor, "pre_move_assignment" + transports.ReservationServiceRestInterceptor, "pre_test_iam_permissions" ) as pre: pre.assert_not_called() post.assert_not_called() post_with_metadata.assert_not_called() - pb_message = reservation.MoveAssignmentRequest.pb( - reservation.MoveAssignmentRequest() - ) + pb_message = iam_policy_pb2.TestIamPermissionsRequest() transcode.return_value = { "method": "post", "uri": "my_uri", @@ -18316,19 +23369,24 @@ def test_move_assignment_rest_interceptors(null_interceptor): req.return_value = mock.Mock() req.return_value.status_code = 200 req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.Assignment.to_json(reservation.Assignment()) + return_value = json_format.MessageToJson( + iam_policy_pb2.TestIamPermissionsResponse() + ) req.return_value.content = return_value - request = reservation.MoveAssignmentRequest() + request = iam_policy_pb2.TestIamPermissionsRequest() metadata = [ ("key", "val"), ("cephalopod", "squid"), ] pre.return_value = request, metadata - post.return_value = reservation.Assignment() - post_with_metadata.return_value = reservation.Assignment(), metadata + post.return_value = iam_policy_pb2.TestIamPermissionsResponse() + post_with_metadata.return_value = ( + iam_policy_pb2.TestIamPermissionsResponse(), + metadata, + ) - client.move_assignment( + client.test_iam_permissions( request, metadata=[ ("key", "val"), @@ -18341,18 +23399,14 @@ def test_move_assignment_rest_interceptors(null_interceptor): post_with_metadata.assert_called_once() -def test_update_assignment_rest_bad_request( - request_type=reservation.UpdateAssignmentRequest, +def test_create_reservation_group_rest_bad_request( + request_type=reservation.CreateReservationGroupRequest, ): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding - request_init = { - "assignment": { - "name": "projects/sample1/locations/sample2/reservations/sample3/assignments/sample4" - } - } + 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. @@ -18367,40 +23421,32 @@ def test_update_assignment_rest_bad_request( response_value.request = mock.Mock() req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.update_assignment(request) + client.create_reservation_group(request) @pytest.mark.parametrize( "request_type", [ - reservation.UpdateAssignmentRequest, + reservation.CreateReservationGroupRequest, dict, ], ) -def test_update_assignment_rest_call_success(request_type): +def test_create_reservation_group_rest_call_success(request_type): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding - request_init = { - "assignment": { - "name": "projects/sample1/locations/sample2/reservations/sample3/assignments/sample4" - } - } - request_init["assignment"] = { - "name": "projects/sample1/locations/sample2/reservations/sample3/assignments/sample4", - "assignee": "assignee_value", - "job_type": 1, - "state": 1, - "enable_gemini_in_bigquery": True, - } + request_init = {"parent": "projects/sample1/locations/sample2"} + request_init["reservation_group"] = {"name": "name_value"} # The version of a generated dependency at test runtime may differ from the version used during generation. # Delete any fields which are not present in the current runtime dependency # See https://github.com/googleapis/gapic-generator-python/issues/1748 # Determine if the message type is proto-plus or protobuf - test_field = reservation.UpdateAssignmentRequest.meta.fields["assignment"] + test_field = reservation.CreateReservationGroupRequest.meta.fields[ + "reservation_group" + ] def get_message_fields(field): # Given a field which is a message (composite type), return a list with @@ -18428,7 +23474,7 @@ def get_message_fields(field): # For each item in the sample request, create a list of sub fields which are not present at runtime # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for field, value in request_init["assignment"].items(): # pragma: NO COVER + for field, value in request_init["reservation_group"].items(): # pragma: NO COVER result = None is_repeated = False # For repeated fields @@ -18458,21 +23504,17 @@ def get_message_fields(field): subfield = subfield_to_delete.get("subfield") if subfield: if field_repeated: - for i in range(0, len(request_init["assignment"][field])): - del request_init["assignment"][field][i][subfield] + for i in range(0, len(request_init["reservation_group"][field])): + del request_init["reservation_group"][field][i][subfield] else: - del request_init["assignment"][field][subfield] + del request_init["reservation_group"][field][subfield] 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 = reservation.Assignment( + return_value = reservation.ReservationGroup( name="name_value", - assignee="assignee_value", - job_type=reservation.Assignment.JobType.PIPELINE, - state=reservation.Assignment.State.PENDING, - enable_gemini_in_bigquery=True, ) # Wrap the value into a proper Response obj @@ -18480,24 +23522,20 @@ def get_message_fields(field): response_value.status_code = 200 # Convert return value to protobuf type - return_value = reservation.Assignment.pb(return_value) + return_value = reservation.ReservationGroup.pb(return_value) json_return_value = json_format.MessageToJson(return_value) response_value.content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.update_assignment(request) + response = client.create_reservation_group(request) # Establish that the response is the type that we expect. - assert isinstance(response, reservation.Assignment) + assert isinstance(response, reservation.ReservationGroup) assert response.name == "name_value" - assert response.assignee == "assignee_value" - assert response.job_type == reservation.Assignment.JobType.PIPELINE - assert response.state == reservation.Assignment.State.PENDING - assert response.enable_gemini_in_bigquery is True @pytest.mark.parametrize("null_interceptor", [True, False]) -def test_update_assignment_rest_interceptors(null_interceptor): +def test_create_reservation_group_rest_interceptors(null_interceptor): transport = transports.ReservationServiceRestTransport( credentials=ga_credentials.AnonymousCredentials(), interceptor=None @@ -18511,18 +23549,18 @@ def test_update_assignment_rest_interceptors(null_interceptor): ) as req, mock.patch.object( path_template, "transcode" ) as transcode, mock.patch.object( - transports.ReservationServiceRestInterceptor, "post_update_assignment" + transports.ReservationServiceRestInterceptor, "post_create_reservation_group" ) as post, mock.patch.object( transports.ReservationServiceRestInterceptor, - "post_update_assignment_with_metadata", + "post_create_reservation_group_with_metadata", ) as post_with_metadata, mock.patch.object( - transports.ReservationServiceRestInterceptor, "pre_update_assignment" + transports.ReservationServiceRestInterceptor, "pre_create_reservation_group" ) as pre: pre.assert_not_called() post.assert_not_called() post_with_metadata.assert_not_called() - pb_message = reservation.UpdateAssignmentRequest.pb( - reservation.UpdateAssignmentRequest() + pb_message = reservation.CreateReservationGroupRequest.pb( + reservation.CreateReservationGroupRequest() ) transcode.return_value = { "method": "post", @@ -18534,19 +23572,21 @@ def test_update_assignment_rest_interceptors(null_interceptor): req.return_value = mock.Mock() req.return_value.status_code = 200 req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.Assignment.to_json(reservation.Assignment()) + return_value = reservation.ReservationGroup.to_json( + reservation.ReservationGroup() + ) req.return_value.content = return_value - request = reservation.UpdateAssignmentRequest() + request = reservation.CreateReservationGroupRequest() metadata = [ ("key", "val"), ("cephalopod", "squid"), ] pre.return_value = request, metadata - post.return_value = reservation.Assignment() - post_with_metadata.return_value = reservation.Assignment(), metadata + post.return_value = reservation.ReservationGroup() + post_with_metadata.return_value = reservation.ReservationGroup(), metadata - client.update_assignment( + client.create_reservation_group( request, metadata=[ ("key", "val"), @@ -18559,14 +23599,16 @@ def test_update_assignment_rest_interceptors(null_interceptor): post_with_metadata.assert_called_once() -def test_get_bi_reservation_rest_bad_request( - request_type=reservation.GetBiReservationRequest, +def test_get_reservation_group_rest_bad_request( + request_type=reservation.GetReservationGroupRequest, ): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding - request_init = {"name": "projects/sample1/locations/sample2/biReservation"} + request_init = { + "name": "projects/sample1/locations/sample2/reservationGroups/sample3" + } request = request_type(**request_init) # Mock the http request call within the method and fake a BadRequest error. @@ -18581,31 +23623,32 @@ def test_get_bi_reservation_rest_bad_request( response_value.request = mock.Mock() req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.get_bi_reservation(request) + client.get_reservation_group(request) @pytest.mark.parametrize( "request_type", [ - reservation.GetBiReservationRequest, + reservation.GetReservationGroupRequest, dict, ], ) -def test_get_bi_reservation_rest_call_success(request_type): +def test_get_reservation_group_rest_call_success(request_type): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding - request_init = {"name": "projects/sample1/locations/sample2/biReservation"} + request_init = { + "name": "projects/sample1/locations/sample2/reservationGroups/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 = reservation.BiReservation( + return_value = reservation.ReservationGroup( name="name_value", - size=443, ) # Wrap the value into a proper Response obj @@ -18613,21 +23656,20 @@ def test_get_bi_reservation_rest_call_success(request_type): response_value.status_code = 200 # Convert return value to protobuf type - return_value = reservation.BiReservation.pb(return_value) + return_value = reservation.ReservationGroup.pb(return_value) json_return_value = json_format.MessageToJson(return_value) response_value.content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.get_bi_reservation(request) + response = client.get_reservation_group(request) # Establish that the response is the type that we expect. - assert isinstance(response, reservation.BiReservation) + assert isinstance(response, reservation.ReservationGroup) assert response.name == "name_value" - assert response.size == 443 @pytest.mark.parametrize("null_interceptor", [True, False]) -def test_get_bi_reservation_rest_interceptors(null_interceptor): +def test_get_reservation_group_rest_interceptors(null_interceptor): transport = transports.ReservationServiceRestTransport( credentials=ga_credentials.AnonymousCredentials(), interceptor=None @@ -18641,18 +23683,18 @@ def test_get_bi_reservation_rest_interceptors(null_interceptor): ) as req, mock.patch.object( path_template, "transcode" ) as transcode, mock.patch.object( - transports.ReservationServiceRestInterceptor, "post_get_bi_reservation" + transports.ReservationServiceRestInterceptor, "post_get_reservation_group" ) as post, mock.patch.object( transports.ReservationServiceRestInterceptor, - "post_get_bi_reservation_with_metadata", + "post_get_reservation_group_with_metadata", ) as post_with_metadata, mock.patch.object( - transports.ReservationServiceRestInterceptor, "pre_get_bi_reservation" + transports.ReservationServiceRestInterceptor, "pre_get_reservation_group" ) as pre: pre.assert_not_called() post.assert_not_called() post_with_metadata.assert_not_called() - pb_message = reservation.GetBiReservationRequest.pb( - reservation.GetBiReservationRequest() + pb_message = reservation.GetReservationGroupRequest.pb( + reservation.GetReservationGroupRequest() ) transcode.return_value = { "method": "post", @@ -18664,19 +23706,21 @@ def test_get_bi_reservation_rest_interceptors(null_interceptor): req.return_value = mock.Mock() req.return_value.status_code = 200 req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.BiReservation.to_json(reservation.BiReservation()) + return_value = reservation.ReservationGroup.to_json( + reservation.ReservationGroup() + ) req.return_value.content = return_value - request = reservation.GetBiReservationRequest() + request = reservation.GetReservationGroupRequest() metadata = [ ("key", "val"), ("cephalopod", "squid"), ] pre.return_value = request, metadata - post.return_value = reservation.BiReservation() - post_with_metadata.return_value = reservation.BiReservation(), metadata + post.return_value = reservation.ReservationGroup() + post_with_metadata.return_value = reservation.ReservationGroup(), metadata - client.get_bi_reservation( + client.get_reservation_group( request, metadata=[ ("key", "val"), @@ -18689,15 +23733,15 @@ def test_get_bi_reservation_rest_interceptors(null_interceptor): post_with_metadata.assert_called_once() -def test_update_bi_reservation_rest_bad_request( - request_type=reservation.UpdateBiReservationRequest, +def test_delete_reservation_group_rest_bad_request( + request_type=reservation.DeleteReservationGroupRequest, ): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding request_init = { - "bi_reservation": {"name": "projects/sample1/locations/sample2/biReservation"} + "name": "projects/sample1/locations/sample2/reservationGroups/sample3" } request = request_type(**request_init) @@ -18713,112 +23757,141 @@ def test_update_bi_reservation_rest_bad_request( response_value.request = mock.Mock() req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.update_bi_reservation(request) + client.delete_reservation_group(request) @pytest.mark.parametrize( "request_type", [ - reservation.UpdateBiReservationRequest, + reservation.DeleteReservationGroupRequest, dict, ], ) -def test_update_bi_reservation_rest_call_success(request_type): +def test_delete_reservation_group_rest_call_success(request_type): client = ReservationServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding request_init = { - "bi_reservation": {"name": "projects/sample1/locations/sample2/biReservation"} - } - request_init["bi_reservation"] = { - "name": "projects/sample1/locations/sample2/biReservation", - "update_time": {"seconds": 751, "nanos": 543}, - "size": 443, - "preferred_tables": [ - { - "project_id": "project_id_value", - "dataset_id": "dataset_id_value", - "table_id": "table_id_value", - } - ], + "name": "projects/sample1/locations/sample2/reservationGroups/sample3" } - # The version of a generated dependency at test runtime may differ from the version used during generation. - # Delete any fields which are not present in the current runtime dependency - # See https://github.com/googleapis/gapic-generator-python/issues/1748 + request = request_type(**request_init) - # Determine if the message type is proto-plus or protobuf - test_field = reservation.UpdateBiReservationRequest.meta.fields["bi_reservation"] + # 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 - def get_message_fields(field): - # Given a field which is a message (composite type), return a list with - # all the fields of the message. - # If the field is not a composite type, return an empty list. - message_fields = [] + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + json_return_value = "" + response_value.content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.delete_reservation_group(request) - if hasattr(field, "message") and field.message: - is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + # Establish that the response is the type that we expect. + assert response is None + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_reservation_group_rest_interceptors(null_interceptor): + transport = transports.ReservationServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.ReservationServiceRestInterceptor(), + ) + client = ReservationServiceClient(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.ReservationServiceRestInterceptor, "pre_delete_reservation_group" + ) as pre: + pre.assert_not_called() + pb_message = reservation.DeleteReservationGroupRequest.pb( + reservation.DeleteReservationGroupRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + request = reservation.DeleteReservationGroupRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_reservation_group( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() - if is_field_type_proto_plus_type: - message_fields = field.message.meta.fields.values() - # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types - else: # pragma: NO COVER - message_fields = field.message.DESCRIPTOR.fields - return message_fields - runtime_nested_fields = [ - (field.name, nested_field.name) - for field in get_message_fields(test_field) - for nested_field in get_message_fields(field) - ] +def test_list_reservation_groups_rest_bad_request( + request_type=reservation.ListReservationGroupsRequest, +): + client = ReservationServiceClient( + 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) - subfields_not_in_runtime = [] + # 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 = mock.Mock() + json_return_value = "" + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.list_reservation_groups(request) - # For each item in the sample request, create a list of sub fields which are not present at runtime - # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for field, value in request_init["bi_reservation"].items(): # pragma: NO COVER - result = None - is_repeated = False - # For repeated fields - if isinstance(value, list) and len(value): - is_repeated = True - result = value[0] - # For fields where the type is another message - if isinstance(value, dict): - result = value - if result and hasattr(result, "keys"): - for subfield in result.keys(): - if (field, subfield) not in runtime_nested_fields: - subfields_not_in_runtime.append( - { - "field": field, - "subfield": subfield, - "is_repeated": is_repeated, - } - ) +@pytest.mark.parametrize( + "request_type", + [ + reservation.ListReservationGroupsRequest, + dict, + ], +) +def test_list_reservation_groups_rest_call_success(request_type): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) - # Remove fields from the sample request which are not present in the runtime version of the dependency - # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER - field = subfield_to_delete.get("field") - field_repeated = subfield_to_delete.get("is_repeated") - subfield = subfield_to_delete.get("subfield") - if subfield: - if field_repeated: - for i in range(0, len(request_init["bi_reservation"][field])): - del request_init["bi_reservation"][field][i][subfield] - else: - del request_init["bi_reservation"][field][subfield] + # 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 = reservation.BiReservation( - name="name_value", - size=443, + return_value = reservation.ListReservationGroupsResponse( + next_page_token="next_page_token_value", ) # Wrap the value into a proper Response obj @@ -18826,21 +23899,20 @@ def get_message_fields(field): response_value.status_code = 200 # Convert return value to protobuf type - return_value = reservation.BiReservation.pb(return_value) + return_value = reservation.ListReservationGroupsResponse.pb(return_value) json_return_value = json_format.MessageToJson(return_value) response_value.content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.update_bi_reservation(request) + response = client.list_reservation_groups(request) # Establish that the response is the type that we expect. - assert isinstance(response, reservation.BiReservation) - assert response.name == "name_value" - assert response.size == 443 + assert isinstance(response, pagers.ListReservationGroupsPager) + assert response.next_page_token == "next_page_token_value" @pytest.mark.parametrize("null_interceptor", [True, False]) -def test_update_bi_reservation_rest_interceptors(null_interceptor): +def test_list_reservation_groups_rest_interceptors(null_interceptor): transport = transports.ReservationServiceRestTransport( credentials=ga_credentials.AnonymousCredentials(), interceptor=None @@ -18854,18 +23926,18 @@ def test_update_bi_reservation_rest_interceptors(null_interceptor): ) as req, mock.patch.object( path_template, "transcode" ) as transcode, mock.patch.object( - transports.ReservationServiceRestInterceptor, "post_update_bi_reservation" + transports.ReservationServiceRestInterceptor, "post_list_reservation_groups" ) as post, mock.patch.object( transports.ReservationServiceRestInterceptor, - "post_update_bi_reservation_with_metadata", + "post_list_reservation_groups_with_metadata", ) as post_with_metadata, mock.patch.object( - transports.ReservationServiceRestInterceptor, "pre_update_bi_reservation" + transports.ReservationServiceRestInterceptor, "pre_list_reservation_groups" ) as pre: pre.assert_not_called() post.assert_not_called() post_with_metadata.assert_not_called() - pb_message = reservation.UpdateBiReservationRequest.pb( - reservation.UpdateBiReservationRequest() + pb_message = reservation.ListReservationGroupsRequest.pb( + reservation.ListReservationGroupsRequest() ) transcode.return_value = { "method": "post", @@ -18877,19 +23949,24 @@ def test_update_bi_reservation_rest_interceptors(null_interceptor): req.return_value = mock.Mock() req.return_value.status_code = 200 req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = reservation.BiReservation.to_json(reservation.BiReservation()) + return_value = reservation.ListReservationGroupsResponse.to_json( + reservation.ListReservationGroupsResponse() + ) req.return_value.content = return_value - request = reservation.UpdateBiReservationRequest() + request = reservation.ListReservationGroupsRequest() metadata = [ ("key", "val"), ("cephalopod", "squid"), ] pre.return_value = request, metadata - post.return_value = reservation.BiReservation() - post_with_metadata.return_value = reservation.BiReservation(), metadata + post.return_value = reservation.ListReservationGroupsResponse() + post_with_metadata.return_value = ( + reservation.ListReservationGroupsResponse(), + metadata, + ) - client.update_bi_reservation( + client.list_reservation_groups( request, metadata=[ ("key", "val"), @@ -19387,6 +24464,156 @@ def test_update_bi_reservation_empty_call_rest(): assert args[0] == request_msg +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_get_iam_policy_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object(type(client.transport.get_iam_policy), "__call__") as call: + client.get_iam_policy(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = iam_policy_pb2.GetIamPolicyRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_set_iam_policy_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object(type(client.transport.set_iam_policy), "__call__") as call: + client.set_iam_policy(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = iam_policy_pb2.SetIamPolicyRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_test_iam_permissions_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.test_iam_permissions), "__call__" + ) as call: + client.test_iam_permissions(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = iam_policy_pb2.TestIamPermissionsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_create_reservation_group_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.create_reservation_group), "__call__" + ) as call: + client.create_reservation_group(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.CreateReservationGroupRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_get_reservation_group_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_reservation_group), "__call__" + ) as call: + client.get_reservation_group(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.GetReservationGroupRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_delete_reservation_group_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.delete_reservation_group), "__call__" + ) as call: + client.delete_reservation_group(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.DeleteReservationGroupRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_list_reservation_groups_empty_call_rest(): + client = ReservationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_reservation_groups), "__call__" + ) as call: + client.list_reservation_groups(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = reservation.ListReservationGroupsRequest() + + assert args[0] == request_msg + + def test_transport_grpc_default(): # A client should use the gRPC transport by default. client = ReservationServiceClient( @@ -19442,6 +24669,13 @@ def test_reservation_service_base_transport(): "update_assignment", "get_bi_reservation", "update_bi_reservation", + "get_iam_policy", + "set_iam_policy", + "test_iam_permissions", + "create_reservation_group", + "get_reservation_group", + "delete_reservation_group", + "list_reservation_groups", ) for method in methods: with pytest.raises(NotImplementedError): @@ -19780,6 +25014,27 @@ def test_reservation_service_client_transport_session_collision(transport_name): session1 = client1.transport.update_bi_reservation._session session2 = client2.transport.update_bi_reservation._session assert session1 != session2 + session1 = client1.transport.get_iam_policy._session + session2 = client2.transport.get_iam_policy._session + assert session1 != session2 + session1 = client1.transport.set_iam_policy._session + session2 = client2.transport.set_iam_policy._session + assert session1 != session2 + session1 = client1.transport.test_iam_permissions._session + session2 = client2.transport.test_iam_permissions._session + assert session1 != session2 + session1 = client1.transport.create_reservation_group._session + session2 = client2.transport.create_reservation_group._session + assert session1 != session2 + session1 = client1.transport.get_reservation_group._session + session2 = client2.transport.get_reservation_group._session + assert session1 != session2 + session1 = client1.transport.delete_reservation_group._session + session2 = client2.transport.delete_reservation_group._session + assert session1 != session2 + session1 = client1.transport.list_reservation_groups._session + session2 = client2.transport.list_reservation_groups._session + assert session1 != session2 def test_reservation_service_grpc_transport_channel(): @@ -20018,8 +25273,36 @@ def test_parse_reservation_path(): assert expected == actual +def test_reservation_group_path(): + project = "squid" + location = "clam" + reservation_group = "whelk" + expected = "projects/{project}/locations/{location}/reservationGroups/{reservation_group}".format( + project=project, + location=location, + reservation_group=reservation_group, + ) + actual = ReservationServiceClient.reservation_group_path( + project, location, reservation_group + ) + assert expected == actual + + +def test_parse_reservation_group_path(): + expected = { + "project": "octopus", + "location": "oyster", + "reservation_group": "nudibranch", + } + path = ReservationServiceClient.reservation_group_path(**expected) + + # Check that the path construction is reversible. + actual = ReservationServiceClient.parse_reservation_group_path(path) + assert expected == actual + + def test_common_billing_account_path(): - billing_account = "squid" + billing_account = "cuttlefish" expected = "billingAccounts/{billing_account}".format( billing_account=billing_account, ) @@ -20029,7 +25312,7 @@ def test_common_billing_account_path(): def test_parse_common_billing_account_path(): expected = { - "billing_account": "clam", + "billing_account": "mussel", } path = ReservationServiceClient.common_billing_account_path(**expected) @@ -20039,7 +25322,7 @@ def test_parse_common_billing_account_path(): def test_common_folder_path(): - folder = "whelk" + folder = "winkle" expected = "folders/{folder}".format( folder=folder, ) @@ -20049,7 +25332,7 @@ def test_common_folder_path(): def test_parse_common_folder_path(): expected = { - "folder": "octopus", + "folder": "nautilus", } path = ReservationServiceClient.common_folder_path(**expected) @@ -20059,7 +25342,7 @@ def test_parse_common_folder_path(): def test_common_organization_path(): - organization = "oyster" + organization = "scallop" expected = "organizations/{organization}".format( organization=organization, ) @@ -20069,7 +25352,7 @@ def test_common_organization_path(): def test_parse_common_organization_path(): expected = { - "organization": "nudibranch", + "organization": "abalone", } path = ReservationServiceClient.common_organization_path(**expected) @@ -20079,7 +25362,7 @@ def test_parse_common_organization_path(): def test_common_project_path(): - project = "cuttlefish" + project = "squid" expected = "projects/{project}".format( project=project, ) @@ -20089,7 +25372,7 @@ def test_common_project_path(): def test_parse_common_project_path(): expected = { - "project": "mussel", + "project": "clam", } path = ReservationServiceClient.common_project_path(**expected) @@ -20099,8 +25382,8 @@ def test_parse_common_project_path(): def test_common_location_path(): - project = "winkle" - location = "nautilus" + project = "whelk" + location = "octopus" expected = "projects/{project}/locations/{location}".format( project=project, location=location, @@ -20111,8 +25394,8 @@ def test_common_location_path(): def test_parse_common_location_path(): expected = { - "project": "scallop", - "location": "abalone", + "project": "oyster", + "location": "nudibranch", } path = ReservationServiceClient.common_location_path(**expected)